Update Docs guidelines #9
Conversation
|
|
||
| Our documentation is built and hosted by `Read the Docs`_ and is available at | ||
| https://docs.securedrop.org. We use a `webhook`_ to rebuild the documentation | ||
| automatically when commits get pushed to the branch. |
There was a problem hiding this comment.
Moving the paragraph that starts with "Our documentation .." makes it obvious how duplicative it is -- compare it with the first paragraph in this chapter:
SecureDrop’s documentation is written in ReStructuredText (ReST), and is built by and hosted on Read the Docs (RTD). The documentation files are stored in the primary SecureDrop git repository under the docs/ directory.
I would suggest consolidating these two paragraphs in the introductory paragraph. The use of a webhook is a technical detail that I would be happy to remove.
|
Heads up, rebase required to resolve conflicts introduced from merge of #8 |
|
(Joan is working on cleanly rebasing this PR and making some final tweaks.) |
|
@eloquence Pointed out that the CI was stuck in "waiting" state on this PR. The problem was that CircleCI did not have the "build from forked PRs" option enabled, as we have in the "securedrop" repo for example. I've enabled it now. It'll take another force-push to kick CI again, at which point it should run to completion! |
|
LGTM, thanks much for preparing @joaedwar! |
Updates docs guidelines to reflect using new dedicated docs repo.
Refers to Issue#4