Enable readthedocs support #1037
Conversation
Signed-off-by: michael <michael.boyd@sovrin.org>
Signed-off-by: michael <michael.boyd@sovrin.org>
Signed-off-by: michael <michael.boyd@sovrin.org>
Signed-off-by: michael <michael.boyd@sovrin.org>
…tory, added readme Signed-off-by: michael <michael.boyd@sovrin.org>
Signed-off-by: michael <michael.boyd@sovrin.org>
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
|
Could one of the committers please verify this patch? |
|
Can one of the admins verify this patch? |
| @@ -19,9 +19,9 @@ system, whereas Fabric is general purpose. | |||
|
|
|||
| ## Technical Overview of Indy Plenum | |||
|
|
|||
There was a problem hiding this comment.
I think it makes sense to put a reference to http://hyperledger-indy.readthedocs.io/projects/plenum here.
There was a problem hiding this comment.
I've put a link to https://indy.readthedocs.io/projects/plenum/en/latest/index.html that takes people to my current forks for now. Once everything is merged in and we have the real site up, I'll add the right url that is built off of the hyperledger repos.
|
|
||
| Contributors should write an addition to a current file or add a new file to the docs/source/ folder that explains what their feature is and how it works. If needed, they may also add a link to more technical README's located nearer to the code. | ||
|
|
||
| Whenever additions are made to the docs, make sure to update the `index.rst` in whichever folder the file has been added, and build the docs locally to confirm they work (TODO: add the `sphinx-build` command to our CI/CD flow). |
There was a problem hiding this comment.
Do I understand correctly that for now updating the docs on readthedocs is a manual process, and we expect it to be part of CI/CD soon? Who is responsible for updating the readthedocs while it's not automated?
There was a problem hiding this comment.
readthedocs website has a webhook integration feature. The docs will automatically be rebuilt whenever a PR is merged into the repository.
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
There was a problem hiding this comment.
I think the following order would be more convenient:
main.md
glossary.md
diagrams/index.rst
request_handling.md
storage.md
catchup.md
message_requests.md
plugins.md
start_nodes.md
recorder.md
misc/zeromq_features.md
|
(ci) test this please |
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
michaeldboyd
force-pushed
the
docs-feature
branch
from
2deb1d1
to
6533852
Compare
|
@michaeldboyd Can you please resolve the conflict with |
Signed-off-by: Michael Boyd <michaeldavisboyd@gmail.com>
|
All comments have been attended to |
|
(ci) test this please |
1 similar comment
|
(ci) test this please |
First, I recognize that this looks like a large PR, but the changes I've made were pretty simple.
As discussed in the HIPE 0025-indy-docs-framework we would like to have a centralized site for our documentation. The changes I have made are outlined in that HIPE.
Here, you will see a couple of things:
docs/directory, I've added asource/directory for our documentation that should be hosted online, for users and contributors. With this way, thedocs/directory can also be used for other documents that may not need to be on our user-facing documentation site. Perhaps for more technical docs meant only for maintainers. I've added the new documentation to it as well.docs/directory within the READMEssourcedirectory addition.The significant files added are
docs/source/conf.py- provides configuration details for sphinx and readthedocsdocs/README.md- describes how to contribute to the documentationdocs/source/index.rst- used to define the documentation structure online.Thanks for taking the time to review!