An open API service indexing awesome lists of open source software.

https://github.com/redhat-documentation/peer-review

Guidelines for peer reviewing
https://github.com/redhat-documentation/peer-review

Last synced: 4 months ago
JSON representation

Guidelines for peer reviewing

Awesome Lists containing this project

README

          

# Red Hat peer review guide for technical documentation

This guide documents best practices for peer reviewing Red Hat technical documentation. The guide also discusses tools to use when reviewing documentation, so that writers and reviewers can choose a method that best fits their workflow. We have also included a checklist for reviewers to use as a quick reference.

View the guide here: https://redhat-documentation.github.io/peer-review/

This guide is sourced internally by Red Hat Customer Content Services (CCS) in GitLab and a public version of the guide is synced to GitHub.

## Requesting an update to the guide

Do not submit PRs directly to this repository. All updates to the guide are made in GitLab. After an update is made in the GitLab repository, it is synced to the GitHub repository.

To request an update to the guide, open an [issue](https://github.com/redhat-documentation/peer-review/issues) or contact one of the following project members:

* [Andrea Hoffer](https://github.com/bergerhoffer/)
* [Irina Gallagher](https://github.com/igallagh-redhat)

## License

This work is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).