GitHub repository: https://github.com/JCSDA-internal/jedi-docs and https://github.com/JCSDA/jedi-docs
Dashboard: https://readthedocs.com/dashboard/
Read the Docs Documentation: https://docs.readthedocs.io/en/stable/
JEDI Documentation: https://jointcenterforsatellitedataassimilation-jedi-docs.readthedocs-hosted.com/en/latest/
Table of Contents |
---|
Read the Docs is used to generated our main JEDI documentation. Our public repository mirrors the JCSDA-Internal repository. This page will be updated with the Infrastructure's teams procedures and maintenance. We use readthedoc.com and not .org, .org is the public version. Read the Docs has webhooks set up via GitHub that will trigger a doc build when merging a PR or with a commit. You can see the Read the Docs line in the jedi-docs PR with an updated rendering reflecting the changes in the PR. An example rendering from a PR is #741. There area a couple of necessary files for Read the Docs inside our jedi-docs repository. docs/requirements.txt is needed to render the documentation and docs/conf.py is the main configuration file used when building. Read the Docs will email the Owner (currently Steve H.) if Read the Docs is updated and changes are needed to required files.
Updating the credit card
Occasionally our JCSDA administrator might need to update the card that pays for Read the Docs. In the past an Owner will give them access to their account in order the change the credit card information. Typically this is done with a UCAR P-card. To manage the subscription and update the credit card, navigate to https://readthedocs.com/organizations/jointcenterforsatellitedataassimilation/subscription/.
With each Skylab release, a new tag is issued for our JEDI Documentation hosted on Read the Docs. The following steps are taken to set up a new release tag. You should already have a release tag created in GitHub before following these steps.
When a PR is submitted or updated in the jedi-docs repo, ReadTheDocs will render the documentation and a link to that rendering is provided in the PR check on GitHub.
Clicking on the "Details" button in the checks list takes the user to the newly rendered documentation. This is a great feature for the submitter and reviewers of the PR. However, to configure this with a private repo (i.e., our JCSDA-internal/jedi-docs repo) requires a workaround to help mitigate security risks.
Here are instructions on how to configure this capability.