Page History

...

Here are instructions on how to configure this capability.

• readthedocs.com uses git@github.com/path/to/repo for private repositories, and a deploy key in the repo that is the public SSH key exported by readthedocs.com
• git-lfs "doesn't do" authentication via ssh, only https so they way to configure this is - to avoid any security risks:

1. 1. Create a new Github user jedi-docs-reader
   2. Create a Github token for the reader
   3. Give this user read-only access to jcsda-internal/jedi-docs only - NOTHING else
   4. Reconfigure the readthedocs build project to use https://jedi-docs-reader:XXXXXX@github.com/JCSDA-internal/jedi-docs.git
      1. Replace the "XXXXXX" in the URL above with the GitHub token that was generated in step "b" above.

• The github token of this jedi-docs-reader will be in the build logs, therefore the need for a separate user with minimal permissions.