Skip to content

Commit 7ed00cb

Browse files
jordanpadamsclaude
andauthored
Improve registry documentation for new users (#392, #391, #393, #394) (#502)
This commit addresses multiple documentation issues to better support new PDS users: **Issue #391 - Add links to component documentation:** - Added link to registry-client external docs from Registry Client section - Added links from Registry Manager to update_status, delete_data, and create_reg pages - Added link from Harvest section to load1.html user guide **Issue #393 - Improve documentation consistency and ordering:** - Reordered components: Harvest → Registry Manager → Registry Client → OpenSearch → Registry API - Made Authentication/Authorization a subsection of OpenSearch - Renamed "API" to "Registry API (PDS Search API)" for clarity and consistency - Added note about archive status affecting API visibility - Clarified archive status values with descriptions: * archived - publicly visible * certified - publicly visible * restricted - not publicly visible * staged - default, not publicly available - Fixed inconsistent terminology: changed "uploaded" to "loaded" in load1.rst **Issue #394 - Update registry-manager documentation:** - Updated parameter documentation to reflect current CLI (2 required, 2 optional) - Replaced deprecated -es with -registry parameter - Updated examples to use new parameter names - Fixed "registered" to "certified" in Registry API section These changes improve discoverability and clarity for users new to the PDS Registry system. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4eab014 commit 7ed00cb

3 files changed

Lines changed: 48 additions & 43 deletions

File tree

docs/source/about.rst

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,6 @@ The PDS Registry Application
2323
The core functionality for the PDS Registry Application is satisfied by `OpenSearch <https://opensearch.org/>`_.
2424

2525

26-
API
27-
----
28-
29-
Provides read-only REST APIs to search and access PDS data. You can call REST APIs directly or
30-
use Python or Java clients.
31-
32-
The most popular client library is `peppi <https://nasa-pds.github.io/peppi>`_.
33-
34-
For direct access, the API is documented `here <https://nasa-pds.github.io/pds-api/guides/search.html>`_.
35-
36-
37-
38-
39-
OpenSearch
40-
-----------
41-
42-
`OpenSearch <https://opensearch.org/>`_ is a NoSQL database based on Apache Lucene project,
43-
optimized for text search. All metadata extracted from PDS4 labels is stored in the OpenSearch database provided by AWS as `OpenSearch Serverless Managed Service <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless.html>`_.
44-
45-
46-
Authentication/Authorization
47-
-----------------------------
48-
49-
The access to the OpenSearch service is restricted using Cognito username and passwords provided by Engineering Node to the other PDS nodes.
50-
Using their login, discipline node can write in their own OpenSearch indexes and read from all the other indexes.
51-
52-
5326
Harvest
5427
--------
5528

@@ -58,15 +31,17 @@ extracted information into OpenSearch.
5831

5932
This command-line tool doesn't require complex installation and configuration.
6033

34+
For more information, see `Loading Data into Registry <./user/load1.html>`_.
35+
6136

6237
Registry Manager
6338
-----------------
6439

6540
A command-line tool to perform admin tasks on a Registry, such as:
6641

67-
* Update product archive status.
68-
* Delete products.
69-
* Create or delete registry indices in OpenSearch (by Engineering Node administrators).
42+
* `Update product archive status <./user/update_status.html>`_.
43+
* `Delete products <./user/delete_data.html>`_.
44+
* `Create or delete registry indices in OpenSearch <./admin/create_reg.html>`_ (by Engineering Node administrators).
7045
* Manage registry data dictionary (by Engineering Node administrators).
7146

7247

@@ -76,3 +51,30 @@ Registry Client
7651

7752
A command-line tool which provides full access to the OpenSearch API to handle operations not supported by the previous tools.
7853
The application takes care of the authentication of the user and signs the queries as required by the AWS OpenSearch Serverless Managed Service.
54+
55+
For more information, see the `Registry Client documentation <https://nasa-pds.github.io/registry-client/>`_.
56+
57+
58+
OpenSearch
59+
-----------
60+
61+
`OpenSearch <https://opensearch.org/>`_ is a NoSQL database based on Apache Lucene project,
62+
optimized for text search. All metadata extracted from PDS4 labels is stored in the OpenSearch database provided by AWS as `OpenSearch Serverless Managed Service <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless.html>`_.
63+
64+
65+
Authentication/Authorization
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
The access to the OpenSearch service is restricted using Cognito username and passwords provided by Engineering Node to the other PDS nodes.
69+
Using their login, discipline node can write in their own OpenSearch indexes and read from all the other indexes.
70+
71+
72+
Registry API (PDS Search API)
73+
------------------------------
74+
75+
Provides read-only REST APIs to search and access PDS data. You can call REST APIs directly or
76+
use Python or Java clients. The archive status of the data affects its visibility to the Registry API; see `Update Archive Status <./user/update_status.html>`_ for more information.
77+
78+
The most popular client library is `peppi <https://nasa-pds.github.io/peppi>`_.
79+
80+
For direct access, the API is documented `here <https://nasa-pds.github.io/pds-api/guides/search.html>`_.

docs/source/user/load1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ You can see additional harvest options by running:
107107
108108
The harvest job configuration file provides also additional options described in :doc:`/user/harvest_job_configuration`.
109109

110-
You can validate the products uploaded in the registry using `registry-client <https://nasa-pds.github.io/registry-client/>`_.
110+
You can validate the products loaded in the registry using `registry-client <https://nasa-pds.github.io/registry-client/>`_.
111111

112112
.. warning::
113113
Due to refresh rates and indexation delays, it may take up to a few hours before the data becomes visible.

docs/source/user/update_status.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ When a product is ingested into PDS Registry, its archive status is set to *"sta
1010
1111
You can change that value to any of the following:
1212

13-
* archived
14-
* certified
15-
* restricted
16-
* staged
13+
* **archived** - Product has been archived and is publicly visible through the Registry API (PDS Search API).
14+
* **certified** - Product has been certified and is publicly visible through the Registry API (PDS Search API).
15+
* **restricted** - Product has restricted access and is not publicly visible.
16+
* **staged** - Product is ingested but not yet publicly available (default status when ingested).
1717

18-
Status *"archived"* and *"certified"* make the products visible to the public, currently through the PDS Web API.
18+
Status *"archived"* and *"certified"* make the products visible to the public through the Registry API (PDS Search API).
1919

2020
You can use either Registry Manager or Harvest Client (Scalable Harvest deployments only) for this task.
2121

@@ -34,13 +34,16 @@ Set status
3434

3535
To set product archive status, execute Registry Manager's "set-archive-status" command.
3636

37-
The following parameters are required:
37+
The following parameters are **required**:
3838

3939
* **-status <status>** - New status. Pass one of the following values: "archived", "certified", "restricted", "staged".
4040
* **-lidvid <id>** - LIDVID of a product to update. If the product is a collection product,
4141
all primary references from the collection inventory will be also updated.
4242
If the product is a bundle product, all bundle's collections will be also updated.
43-
* **-es <url>** - link to the connection configuration file described in :doc:`/connection-setup`
43+
44+
The following parameters are **optional**:
45+
46+
* **-registry <url>** - URL to the OpenSearch registry endpoint (replaces deprecated -es option). See :doc:`/connection-setup`.
4447
* **-auth <file>** - OpenSearch authentication configuration file. See :doc:`/connection-setup`.
4548

4649
**Examples:**
@@ -50,7 +53,7 @@ On **MacOS/Linux**:
5053
.. code-block:: bash
5154
5255
registry-manager set-archive-status \
53-
-es file://path/to/registry_connection.xml \
56+
-registry https://your-opensearch-endpoint.example.com \
5457
-auth /my/path/auth.cfg \
5558
-status archived \
5659
-lidvid "urn:nasa:pds:kaguya_grs_spectra:document::1.0"
@@ -62,18 +65,18 @@ On **Windows**:
6265
6366
.\registry-manager.bat set-archive-status
6467
-auth 'C:\Users\loubrieu\Documents\es-auth.txt'
65-
-es 'file:///C:\Users\loubrieu\Documents\mcp_dev.xml'
68+
-registry 'https://your-opensearch-endpoint.example.com'
6669
-lidvid 'urn:nasa:pds:insight_rad:data_derived::7.0'
6770
-status archived
6871
6972
7073
7174
The connection and auth files are described in :doc:`/connection-setup`
7275

73-
Registry API
74-
************
76+
Registry API (PDS Search API)
77+
******************************
7578

76-
Once data has been ingested and archive status is set to `archived` or `registered`, it is accessible using the Registry
79+
Once data has been ingested and archive status is set to ``archived`` or ``certified``, it is accessible using the Registry
7780
API which is `documented here <https://nasa-pds.github.io/pds-api/guides/search.html>`_.
7881

7982
The base URL of the API https://pds.nasa.gov/api/search/1 also provides an online documentation.

0 commit comments

Comments
 (0)