Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "command block" example #90757

Open
apinnick opened this issue Mar 20, 2025 · 0 comments
Open

Update "command block" example #90757

apinnick opened this issue Mar 20, 2025 · 0 comments

Comments

@apinnick
Copy link
Contributor

Single command in code block

A writer used this example to justify documenting 5 commands in a single step. I don't think that was how this example was intended.

For example, the following must be split up into three separate code blocks:

To create templates you can modify, run the following commands:

[source,terminal]
----
$ oc adm create-login-template > login.html
----

[source,terminal]
----
$ oc adm create-provider-selection-template > providers.html
----

[source,terminal]
----
$ oc adm create-error-template > errors.html
----

Resources:

  • RHSSG: "Use a single command per code block for each procedure step."
  • Modular docs reference guide: "The procedure consists of one or more steps required to complete the procedure. Each step describes one action written in the imperative form, for example, 'Do this action'. "
  • ISG: "Write one step for each significant user action, but avoid being too granular. "
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant