diff --git a/.github/ISSUE_TEMPLATE/content_issue.md b/.github/ISSUE_TEMPLATE/content_issue.md index 5d49419c..3a48c60b 100644 --- a/.github/ISSUE_TEMPLATE/content_issue.md +++ b/.github/ISSUE_TEMPLATE/content_issue.md @@ -2,24 +2,20 @@ name: Doc content issue report about: Create a report to help us improve our content. title: '' - --- - ## Describe the bug - + - [ ] Missing content - [ ] Outdated content @@ -27,19 +23,10 @@ Check the issue type in the following list (insert X instead of space between [ - [ ] Confusing or misleading content - [ ] Other -## The broken page - -[Paste the doc site page link here.] - ## Change suggestion - - -## Screenshots - - + ## More context - + diff --git a/.github/ISSUE_TEMPLATE/tool_issue.md b/.github/ISSUE_TEMPLATE/tool_issue.md index a70840d0..11a24521 100644 --- a/.github/ISSUE_TEMPLATE/tool_issue.md +++ b/.github/ISSUE_TEMPLATE/tool_issue.md @@ -7,45 +7,27 @@ assignees: 'NicolasMassart' --- - ## Describe the bug - + -## The broken page +## System settings -[Paste the doc site page link here.] + -## System (please complete the following information) - - - OS: [Windows, macOS, Linux] and its version. - - Browser: [Chrome, Firefox, Safari,…] and its version. - - Plugins: list plugins activated in your Browser. - -## To Reproduce - -Steps to reproduce the behavior: -1. Go to page '…' -2. Click on '…' -3. Scroll down to '…' -4. See error - -## Expected behavior - - - -## Screenshots - - +- OS and version: +- Browser and version: +- Plugins activated in your browser: ## More context - + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d1354b84..08c078ee 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,66 +1,60 @@ ## Pull request checklist -Use the following list to make sure your PR fits the Besu doc quality standard. +Use the following list to make sure your PR fits the Besu documentation quality standard. ### Before creating the pull request Make sure that: -- [ ] [all commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO). -- [ ] you read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation). -- [ ] 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. - -### After creating your pull request and tests finished - -Make sure that: - -- [ ] you fixed all the issues raised by the tests, if any. -- [ ] you verified the rendering of your changes on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs) - and updated the testing link (see [Testing](#testing)). +- [ ] [All commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO). +- [ ] You've read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Documentation). +- [ ] You've [previewed your changes locally](https://wiki.hyperledger.org/display/BESU/Preview+the+documentation). ## Describe the change - + ## Issue fixed - -If you don't want to close the issue, use: -see #{your issue number} --> +## Impacted parts -## Impacted parts + -### For content changes +For content changes: -- [ ] Doc content -- [ ] Doc pages organisation +- [ ] Documentation content +- [ ] Documentation page organization -### For tools changes +For tool changes: - [ ] CircleCI workflow -- [ ] Build and QA tools (lint, vale,…) +- [ ] Build and QA tools (for example, lint or vale) - [ ] MkDocs templates - [ ] MkDocs configuration - [ ] Python dependencies - [ ] Node dependencies and JavaScript -- [ ] ReadTheDocs configuration +- [ ] Read the Docs configuration - [ ] GitHub integration -## Testing +## After creating your PR and tests have finished - +Make sure that: + +- [ ] You've fixed any issues raised by the tests. +- [ ] You've [previewed your changes on Read the Docs](https://wiki.hyperledger.org/display/BESU/Preview+the+documentation) + and added a [preview link](#preview). -## Screenshots / recording +## Preview - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 028b495c..d40de082 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,32 +1,4 @@ -# Contributing to the Hyperledger Besu documentation +# Contribute to the Hyperledger Besu documentation -## Thanks for taking the time to contribute - -Welcome to the **Hyperledger Besu documentation** repository! The following are links to a set of -guidelines (not rules) for contributing to this repository. Use your best judgement, and feel free -to propose changes to this document in a pull request. - -* [Hyperledger Besu documentation](http://besu.hyperledger.org/) -* [Hyperledger Besu community](https://discord.gg/hyperledger) -* [Hyperledger Besu Wiki](https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu) - -### Useful docs contributing links - -* [I just have a quick question] -* [How to contribute](https://wiki.hyperledger.org/display/BESU/How+to+Contribute) -* [Reporting bugs in the documentation] -* [Submitting a documentation enhancement suggestion] -* [Documentation style guide] -* [Security](SECURITY.md) - -### Other important information - -* [Besu roadmap](https://wiki.hyperledger.org/display/BESU/Roadmap) -* [Code of Conduct](https://wiki.hyperledger.org/display/BESU/Code+of+Conduct) -* [Governance](https://wiki.hyperledger.org/display/BESU/Governance) - - -[I just have a quick question]: https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question -[Reporting bugs in the documentation]: https://wiki.hyperledger.org/display/BESU/Reporting+Bugs+in+the+Documentation -[Submitting a documentation enhancement suggestion]: https://wiki.hyperledger.org/display/BESU/Suggesting+Documentation+Enhancements -[Documentation style guide]: https://wiki.hyperledger.org/display/BESU/Besu+Documentation+Style+Guide +See the [documentation section in the Hyperledger Besu wiki](https://wiki.hyperledger.org/display/BESU/Documentation) +for guidelines on how to contribute to the documentation.