Skip to content

Commit

Permalink
[FAB-14594] fix the docs/README.md
Browse files Browse the repository at this point in the history
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 <xzj19922010@gmail.com>
Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
  • Loading branch information
TopJohn authored and lehors committed Mar 27, 2019
1 parent 244e2a2 commit d3bffc2
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/README.md
Expand Up @@ -44,17 +44,19 @@ the docs on your machine. The following sections cover both options:

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

1. Fork [fabric on github](https://github.com/hyperledger/fabric)
1. From your fork, go to `settings` in the upper right portion of the screen,
1. click `Integration & services`,
1. click `Add service` dropdown,
1. and scroll down to ReadTheDocs.
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,
1. click import a project,
1. navigate through the options to your fork (e.g. yourgithubid/fabric),
1. it will ask for a name for this project. Choose something
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:
`yourgithubid-fabric.readthedocs.io/en/latest`
1. Go to http://readthedocs.org and sign up for an account.
2. Create a project.
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:
`yourgithubid-fabric.readthedocs.io/en/latest`.
3. Click `Admin`, click `Integrations`, click `Add integration`, choose `GitHub incoming webhook`,
then click `Add integration`.
4. Fork [Fabric on GitHub](https://github.com/hyperledger/fabric).
5. From your fork, go to `Settings` in the upper right portion of the screen.
6. Click `Webhooks`.
7. Click `Add webhook`.
8. Add the ReadTheDocs's URL into `Payload URL`.
9. Choose `Let me select individual events`:`Pushes``Branch or tag creation``Branch or tag deletion`.
10. Click `Add webhook`.

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

0 comments on commit d3bffc2

Please sign in to comment.