jherrman/supplementary-style-guide

This project maintains the Red Hat supplementary style guide for product documentation that supplements the IBM Style guide

Red Hat supplementary style guide for product documentation

About

The purpose of this project is to create an official Red Hat supplementary style guide for product documentation, supplementing the IBM Style guide, in direct support of cross-product solution documentation issues. The intended users are product documentation teams at Red Hat and upstream project contributors.

View the latest version of the guide: Red Hat supplementary style guide for product documentation

Suggestions or questions?

If you have a suggestion or question, open an issue in this project.

Contributing

See the Contributing guide for information about how to contribute an update.

What's new

See the history of significant updates to the Red Hat supplementary style guide for product documentation.

Administrator responsibilities

See the list of administrator responsibilities for more information on what to do in your role as the administrator of this repository.

Building the guide locally

You can build the guide locally using Asciidoctor.

$ cd supplementary_style_guide
$ asciidoctor main.adoc

Open the generated main.html file in a browser to view the built guide.

License

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.