Skip to content

Commit d3bffc2

Browse files
TopJohnlehors
authored andcommitted
[FAB-14594] fix the docs/README.md
Fix [FAB-14594], update the method to setup own staging repo and docs. Patch-set #2: Addressed Joe's comments. Change-Id: Ica22ee74d4f3f89aa6c435ab57fbb9494ddc271c Signed-off-by: TopJohn <[email protected]> Signed-off-by: Arnaud J Le Hors <[email protected]>
1 parent 244e2a2 commit d3bffc2

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,19 @@ the docs on your machine. The following sections cover both options:
4444

4545
You can easily build your own staging repo following these steps:
4646

47-
1. Fork [fabric on github](https://github.com/hyperledger/fabric)
48-
1. From your fork, go to `settings` in the upper right portion of the screen,
49-
1. click `Integration & services`,
50-
1. click `Add service` dropdown,
51-
1. and scroll down to ReadTheDocs.
52-
1. Next, go to http://readthedocs.org and sign up for an account. One of the first prompts will offer to link to github. Elect this then,
53-
1. click import a project,
54-
1. navigate through the options to your fork (e.g. yourgithubid/fabric),
55-
1. it will ask for a name for this project. Choose something
56-
intuitive. Your name will preface the URL and you may want to append `-fabric` to ensure that you can distinguish between this and other docs that you need to create for other projects. So for example:
57-
`yourgithubid-fabric.readthedocs.io/en/latest`
47+
1. Go to http://readthedocs.org and sign up for an account.
48+
2. Create a project.
49+
Your username will preface the URL and you may want to append `-fabric` to ensure that you can distinguish between this and other docs that you need to create for other projects. So for example:
50+
`yourgithubid-fabric.readthedocs.io/en/latest`.
51+
3. Click `Admin`, click `Integrations`, click `Add integration`, choose `GitHub incoming webhook`,
52+
then click `Add integration`.
53+
4. Fork [Fabric on GitHub](https://github.com/hyperledger/fabric).
54+
5. From your fork, go to `Settings` in the upper right portion of the screen.
55+
6. Click `Webhooks`.
56+
7. Click `Add webhook`.
57+
8. Add the ReadTheDocs's URL into `Payload URL`.
58+
9. Choose `Let me select individual events`:`Pushes``Branch or tag creation``Branch or tag deletion`.
59+
10. Click `Add webhook`.
5860

5961
Now anytime you modify or add documentation content to your fork, this
6062
URL will automatically get updated with your changes!

0 commit comments

Comments
 (0)