diff --git a/docs/source/about.rst b/docs/source/about.rst index 86b58dc..116e26a 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -29,9 +29,9 @@ API Provides read-only REST APIs to search and access PDS data. You can call REST APIs directly or use Python or Java clients. -The most popular client library is `peppi `_ +The most popular client library is `peppi `_. -For direct access, the API is documented `here `_ +For direct access, the API is documented `here `_. diff --git a/docs/source/connection-setup.rst b/docs/source/connection-setup.rst index c00eb5a..05048da 100644 --- a/docs/source/connection-setup.rst +++ b/docs/source/connection-setup.rst @@ -12,7 +12,7 @@ Node (DN). Initial Set-up ************** -To get things going, you should have provided the EN contact with the following: +To get things going, you should have provided the Engineering Node contact with the following: * A list of user email addresses which will be authorized to perform data ingestion. * A list of IP addresses or blocks of addresses from which data ingestion will occur. @@ -24,6 +24,8 @@ password will be sent to them. Along with your Opensearch user credentials you will receive configuration inputs for your tools to connect to the registry services. +The following sections provide the steps to follow to have your connection set up. + Changing Your Opensearch Password ********************************* @@ -97,9 +99,7 @@ Create OpenSearch connection configuration file, e.g. sbn_mcp_prod.xml or sbn_m Run Registry Tools on AWS ~~~~~~~~~~~~~~~~~~~~~~~~~ -You can run harvest on AWS. - -You can run it on ECS or EC2 directly. +You can run harvest on AWS, on ECS or EC2 directly. Run Harvest On EC2 ------------------- @@ -112,7 +112,7 @@ See the AWS console screenshot, you should have **No** instead of **Yes** here: .. image:: _static/images/aws_console_vpc.png -If you need to change that in your AWS account, double check that all your applications still work. +If you need to change that in your AWS account, double check that all your other applications still work. @@ -121,7 +121,7 @@ Run Harest On ECS You can run harvest on ECS, as on EC2 using the Cognito authentication. -But if you run harvest, on ECS, on the same AWS account as the Registry service, you can also configure the connexion to the Registry without Cognito authentication, as follows: +Alternatively if you run harvest, on ECS, on the same AWS account as the Registry service, you can also configure the connexion to the Registry without Cognito authentication, as follows: .. code:: xml @@ -144,13 +144,3 @@ metadata into the Registry. Details on how to install and run these tools are fo -Registry API -************ - -Once data has been ingested using the Registry Tools, queries can be submitted using the Registry -API which is `documented here `_. - -The base URL of the API `https://pds.nasa.gov/api/search/1 _` also provides an online documentation. - - - diff --git a/docs/source/install/install.rst b/docs/source/install/install.rst index 17c36b1..b155cec 100644 --- a/docs/source/install/install.rst +++ b/docs/source/install/install.rst @@ -108,7 +108,7 @@ Test by running:: Registry Client ~~~~~~~~~~~~~~~~ -See `documentation `_. +To install Registry Client see `documentation `_. Supplementer @@ -117,7 +117,7 @@ Supplementer .. note:: Only install this if you plan to load supplemental metadata. -..warning:: +.. warning:: Not tested with latest Registry service. Download latest stable release (tar or zip) from https://github.com/NASA-PDS/supplementer/releases/latest. diff --git a/docs/source/user/update_status.rst b/docs/source/user/update_status.rst index 44044c5..6a98c59 100644 --- a/docs/source/user/update_status.rst +++ b/docs/source/user/update_status.rst @@ -69,3 +69,13 @@ On **Windows**: The connection and auth files are described in :doc:`/connection-setup` + +Registry API +************ + +Once data has been ingested and archive status is set to `archived` or `registered`, it is accessible using the Registry +API which is `documented here `_. + +The base URL of the API https://pds.nasa.gov/api/search/1 also provides an online documentation. + +