redhat-documentation / asciidoc-markup-conventions

How to use AsciiDoc mark-up to properly style elements in Red Hat documentation
https://access.redhat.com/documentation/
17 stars 16 forks source link

Update the 'System or software variable to be replaced by the user' example ad markup used #36

Closed yetanothertw closed 2 years ago

yetanothertw commented 3 years ago

According to the RH Supplementary Style Guide (https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values) this example should be updated to reflect the following guidelines.

Ensure that user-replaced values have the following characteristics:

Example AsciiDoc: User-replaced value in a paragraph Create an Ansible inventory file that is named /_<path>_/inventory/hosts.

Suggested change from: Use the following command to roll back a deployment, specifying the deployment name: oc rollback _deployment_. to: Use the following command to roll back a deployment, specifying the deployment name: oc rollback _<deployment>_. alternative suggestion: To roll back a deployment, specify the deployment name: oc rollback _<deployment>_.

bergerhoffer commented 3 years ago

Submitted PR #40 to update example to match the supplementary style guide guidance.