Guide: using private submodules in rtd.com #6527
Conversation
There was a problem hiding this comment.
I think this is pretty clear and all the steps make sense 💯 . It's good to have this finally documented!
I did some suggestions about style and consistency among the whole guide. I don't think we need to give too much details about what we do and why to the reader, they just need to know what are the 1, 2, 3 steps they need to follow to accomplish their goal.
I suggested to split the content into 2 steps (Copy the key, Add the key) and make each step a section.
| GitHub | ||
| ------ | ||
|
|
||
| For GitHub, Read the Docs uses `deploy keys with read only access <https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys>`__. |
docs/guides/private-submodules.rst
Outdated
| In order to give Read the Docs access to clone your submodules you'll need to add the public SSH key to each repository of your submodules. | ||
|
|
||
| .. note:: | ||
|
|
||
| You can manage which submodules Read the Docs should clone using a configuration file. | ||
| See :ref:`config-file/v2:submodules`. | ||
|
|
||
| Project's SSH Key |
There was a problem hiding this comment.
You can add like a small table of contents before this title so when reading the first section you will immediately realize that there are just 2 steps, but the second depends on your VCS provider --without reading the whole doc, and you can jump to the section easily.
Similar to what we are doing at: https://docs.readthedocs.io/en/latest/api/v3.html
There was a problem hiding this comment.
I just added the TOC, looks like this is already shown in the sidebar
- Use numbered items - Add TOC
Wasn't sure where to put this guide, since it only applies to rtd.com. I created a new section, but not sure if that's ok