Skip to content

Asciidoc example for definition lists/command blocks #571

@apinnick

Description

@apinnick

Severity

Minor (nice to have)

Priority

P3 (lowest)

Relevant page(s)

https://redhat-documentation.github.io/supplementary-style-guide/#explain-commands-variables-in-code-blocks

Describe the proposed change

Add Asciidoc example:

where:
+
<my_product_database_certificates_secrets>:: Specifies the name of the certificate secret.
<ca_certificate_key>:: Specifies the CA certificate key.

Why is this change needed?

It might be helpful to include an Asciidoc example because some writers are unfamiliar with the term "definition list".

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions