Skip to content

Commit 4d9afc8

Browse files
committed
System or software variable to be replaced by the user: added examples showing mutliple words and a file path
1 parent 67cf1bd commit 4d9afc8

File tree

1 file changed

+37
-6
lines changed

1 file changed

+37
-6
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,7 @@ In the Atom editor, you can use `Ctrl`+`J` to undo hard wrapping on a paragraph.
2121
====
2222

2323
== Assembly file metadata
24-
25-
Every assembly file should contain the following metadata at the top, with no line
26-
spacing in between, except where noted:
24+
Every assembly file should contain the following metadata at the top, with no line spacing in between, except where noted:
2725

2826
----
2927
[id="<unique-heading-for-assembly>"] <1>
@@ -903,9 +901,7 @@ Now using project "my-project" on server "https://openshift.example.com:6443".
903901
----
904902
....
905903

906-
* To mark up command syntax, use the code block and wrap any replaceable values in
907-
angle brackets (`<>`) with the required command parameter, using underscores
908-
(`_`) between words as necessary for legibility. For example:
904+
* To mark up command syntax, use the code block and wrap any replaceable values in angle brackets (`<>`) with the required command parameter, using underscores (`_`) between words as necessary for legibility. For example:
909905
+
910906
....
911907
To view a list of objects for the specified object type, enter the following command:
@@ -928,6 +924,33 @@ This renders as:
928924
+
929925
NOTE: Avoid using full command syntax inline with sentences.
930926

927+
* When referring to a path to a location that the user has selected or created, treat the part of the path that the user chose as a replaceable value. For example:
928+
+
929+
....
930+
Create a secret that contains the certificate and key in the `openshift-config` namespace:
931+
932+
[source,terminal]
933+
----
934+
$ oc create secret tls <certificate> --cert=<path_to_certificate>/cert.crt --key=<path_to_key>/cert.key -n openshift-config
935+
----
936+
....
937+
+
938+
This renders as:
939+
+
940+
--
941+
> Create a secret that contains the certificate and key in the `openshift-config` namespace:
942+
>
943+
> ----
944+
> $ oc create secret tls <certificate> --cert=<path_to_certificate>/cert.crt --key=<path_to_key>/cert.key -n openshift-config
945+
> ----
946+
--
947+
+
948+
The following example shows a more complex use of user-chosen elements and prescriptive placement:
949+
+
950+
....
951+
<resource_group_name>/providers/Microsoft.Compute/diskEncryptionSets/<disk_encryption_set_name>
952+
....
953+
931954
* If you must provide additional information on what a line of a code block
932955
represents, use callouts (`<1>`, `<2>`, etc.) to provide that information.
933956
+
@@ -1661,12 +1684,20 @@ a|
16611684
`<project>`
16621685
16631686
`<deployment>`
1687+
1688+
`<install_mode_value>`
16641689
....
16651690

16661691
a|
16671692
> Use the following command to roll back a Deployment, specifying the Deployment name:
16681693
>
16691694
> `oc rollback <deployment>`
1695+
>
1696+
> &nbsp;
1697+
>
1698+
> Apply the new configuration file:
1699+
>
1700+
> `oc apply -f <path_to_configuration_file>/<filename>.yaml`
16701701

16711702
|Use single asterisks for web console / GUI items (menus, buttons, page titles, etc.).
16721703
Use two characters to form the arrow in a series of menu items (`$$->$$`).

0 commit comments

Comments
 (0)