add RTD preview step in PR template (#507)

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
pull/512/head
Nicolas MASSART 4 years ago committed by GitHub
parent 24269b4020
commit 57f498d294
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 15
      .github/pull_request_template.md
  2. 3
      CI/linkchecker/link_check_conf.json
  3. 2
      package.json

@ -1,8 +1,9 @@
**Before pushing any commit in your pull request, make sure that you:**
**Before pushing any commit in your pull request, make sure that:**
- [ ] read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation).
- [ ] [signed all commits of for the DCO](https://wiki.hyperledger.org/display/BESU/DCO).
- [ ] have [tested your changes locally](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewTheDocumentation) before submitting them to the community for review. -->
- [ ] you read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation).
- [ ] [all commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO).
- [ ] you have [tested your changes locally](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewTheDocumentation) before submitting them to the community for review.
- [ ] you verified the rendering on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs) (see [Testing](#testing))
## Describe the change
@ -40,7 +41,11 @@ see #{your issue number} -->
## Testing
<!-- Steps to follow to review and test your changes. -->
<!-- Steps to follow to review and test your changes.
Add links to preview the pages changes here.
Link format is https://hyperledger-besu--{your PR number}.org.readthedocs.build/en/{your PR number}/
Where {your PR number} must be replaced by the number of this PR, for instance 123
-->
## Screenshots / recording

@ -20,6 +20,9 @@
},
{
"pattern": "/postman/.+.json"
},
{
"pattern": "https://remix.ethereum.org/"
}
]
}

@ -7,7 +7,7 @@
"doc": "docs"
},
"scripts": {
"test:links:check": "find . -name \\*.md ! -path \"./node_modules/*\" -exec ./node_modules/markdown-link-check/markdown-link-check -q -c CI/linkchecker/link_check_conf.json {} \\; 2>&1 | tee linkchecker.out",
"test:links:check": "find . -name \\*.md ! -path \"./node_modules/*\" -exec ./node_modules/markdown-link-check/markdown-link-check -v -c CI/linkchecker/link_check_conf.json {} \\; 2>&1 | tee linkchecker.out",
"test:links:display": "cat linkchecker.out",
"test:links:verify": "! grep -n '[✖]\\|ERROR' ./linkchecker.out",
"test:links": "npm run test:links:check && npm run test:links:display && npm run test:links:verify",

Loading…
Cancel
Save