You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+37-6Lines changed: 37 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,7 @@ In the Atom editor, you can use `Ctrl`+`J` to undo hard wrapping on a paragraph.
21
21
====
22
22
23
23
== 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:
27
25
28
26
----
29
27
[id="<unique-heading-for-assembly>"] <1>
@@ -903,9 +901,7 @@ Now using project "my-project" on server "https://openshift.example.com:6443".
903
901
----
904
902
....
905
903
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:
909
905
+
910
906
....
911
907
To view a list of objects for the specified object type, enter the following command:
@@ -928,6 +924,33 @@ This renders as:
928
924
+
929
925
NOTE: Avoid using full command syntax inline with sentences.
930
926
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:
0 commit comments