Skip to content

Latest commit

 

History

History
52 lines (25 loc) · 3.21 KB

README.md

File metadata and controls

52 lines (25 loc) · 3.21 KB
Raw

🪐 NASA PDS Registry repository

DOI 🤪 Unstable integration & delivery 😌 Stable integration & delivery

This repository is an umbrella for the PDS registry application. The application is composed of multiple sub-components, each of them managed in their own repository and integrated here:

  • registry-loader: tools to load PDD4 producs to the registry
  • opensearch: the famoua data store and search engine which performaces we praise.s
  • registry-sweepers: suite of script consolidating the PDS4 product descriptions in OpenSearch.
  • registry-api: the PDS Search API service.
  • registry-ref-data: some reference datsets that we use for our application integration tests.

Users and administrator should use the documentation published on http://nasa-pds.github.io/registry

This repository specifically contains these PDS registry application resources:

  • the source for the user/administrator documentation, see docs folder
  • docker compose script to start/test the full application with its required components, see https://github.com/NASA-PDS/registry/blob/main/docker/README.md for details. This also includes integration tests (in docker/postman). The integration test datasets are maintained in NASA-PDS/registry-ref-data repository.

Code of Conduct

All users and developers of the NASA-PDS software are expected to abide by our Code of Conduct. Please read this to ensure you understand the expectations of our community.

Development

To develop this project, use your favorite text editor, or an integrated development environment with Python support, such as PyCharm.

Contributing

For information on how to contribute to NASA-PDS codebases please take a look at our Contributing guidelines.

Documentation

The project uses Sphinx to build its documentation. PDS' documentation template is already configured as part of the default build. You can build your projects docs with:

cd docs
make html

The generated documnentation can be found in directory docs/build/html

CI/CD

The template repository comes with our two "standard" CI/CD workflows, stable-cicd and unstable-cicd. The unstable build runs on any push to main (± ignoring changes to specific files) and the stable build runs on push of a release branch of the form release/<release version>. Both of these make use of our GitHub actions build step, Roundup. The unstable-cicd will generate (and constantly update) a SNAPSHOT release. If you haven't done a formal software release you will end up with a v0.0.0-SNAPSHOT release (see NASA-PDS/roundup-action#56 for specifics).