The Glossary of Terms and Conventions for Product Documentation contains the set of technical language conventions used by all documentation teams at Red Hat that will improve the consistency of language across Red Hat documentation.
You can view the latest build of the guide here:
https://redhat-documentation.github.io/glossary-of-terms-and-conventions-for-product-documentation/
The purpose of the Documentation Conventions project is to define and apply a set of technical language conventions used by all documentation teams at Red Hat that will improve the consistency of language across Red Hat documentation. The Glossary of Terms and Convention for Product Documentation contains general and product-specific terms. Please help us expand the glossary if you notice any terms that are missing.
The project aims to create a central document that outlines conventions for technical terminology and Red Hat product-specific naming that will be used by all of the CCS documentation teams. It also aims to establish a long-term process for maintaining and developing the document.
Please submit an issue to this project.
## Contributing
We welcome contributions from everyone who feels they have something of value that all of the community can benefit from. Follow these instructions to start contributing: [CONTRIBUTING](CONTRIBUTING.md).
## License
This work is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
## Building the Books Locally
When you make changes to these books, it is a good practice to do a local test build to verify the book builds successfully and renders as you expect before you submit the merge request back to upstream master.
### Configuring the Build Environment
You can build the book locally using [AsciiDoctor](http://asciidoctor.org/docs/#get-started-with-asciidoctor).
### Building the Glossary of Terms and Conventions for Product Documentation
To build and view the document locally, run:
$ asciidoctor glossary-of-terms-and-conventions-for-product-documentation/master.adoc $ glossary-of-terms-and-conventions-for-product-documentation/master.html