-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Open
Labels
lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Description
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. "
Metadata
Metadata
Assignees
Labels
lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.Denotes an issue or PR that has aged beyond stale and will be auto-closed.