Skip to content

Commit 8f12fac

Browse files
committed
Minor clarifications to the Mod docs conventions and whitespace clarifications
1 parent 9aeab98 commit 8f12fac

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ toc::[] <6>
3535

3636
After the heading block and a single whitespace line, you can include any content for the topic.
3737

38+
[NOTE]
39+
====
40+
Please set your editor to strip trailing whitespace.
41+
====
42+
3843
[NOTE]
3944
====
4045
The topic title, which is the first line of the document, is the only level 1 ( = ) title. Section headers within the topic must be level 2 ( == ) or lower.

contributing_to_docs/tools_and_setup.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ of the box, but if you are on Windows you can use http://cygwin.com/[Cygwin])
6969
* http://www.git-scm.com/[Git]
7070
* A web browser (Firefox, Chrome, or Safari) with the
7171
http://livereload.com/[LiveReload] extension installed
72+
* An editor that can strip trailing whitespace.
7273

7374
=== Install the required software dependencies on a Linux system
7475
The following instructions describe how to install all the required tools to do

modules/mod-docs-ocp-conventions.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,11 @@ of the openshift-docs repository. These modules must follow the file naming
8888
conventions specified in the
8989
link:https://redhat-documentation.github.io/modular-docs/[modular docs guidelines].
9090

91-
* All assemblies must go in the the relevant guide/book (MORE TO COME ON THIS).
91+
* All assemblies must go in the the relevant guide/book. If you can't find a relevant
92+
guide/book, please reach out to a member of the OpenShift CCS team. So guides/books contain assemblies, which
93+
contain modules.
94+
95+
* modules and images folders are symlinked to the top level folder from each book/guide folder.
9296

9397
* In your assemblies, when you are linking to the content in other books, you must
9498
use the relative path starting like so:

0 commit comments

Comments
 (0)