Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide: using private submodules in rtd.com #6527

Merged
merged 7 commits into from Feb 20, 2020

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Jan 15, 2020

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

docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
@stsewd stsewd requested a review from Jan 15, 2020
docs/guides/index.rst Show resolved Hide resolved
Copy link
Member

@humitos humitos left a 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.

docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
@stsewd stsewd requested review from humitos and Feb 18, 2020
Copy link
Member

@humitos humitos left a comment

This is good to me. I made some extra suggestions.

GitHub
------

For GitHub, Read the Docs uses `deploy keys with read only access <https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys>`__.
Copy link
Member

@humitos humitos Feb 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stsewd ping

docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
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
Copy link
Member

@humitos humitos Feb 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

@stsewd stsewd Feb 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added the TOC, looks like this is already shown in the sidebar

docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
docs/guides/private-submodules.rst Outdated Show resolved Hide resolved
@stsewd stsewd merged commit 2e10054 into readthedocs:master Feb 20, 2020
2 checks passed
@stsewd stsewd deleted the guide-private-submodules branch Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants