Skip to content

Commit 4f88783

Browse files
committed
Updating guidance and providing more information on two levels of subdirectories
1 parent e3b3ab1 commit 4f88783

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,9 @@ If you create a directory with a multiple-word name, separate each word with an
187187
Do not italicize user-replaced values. This guideline is an exception to the link:https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values[Red Hat supplementary style guide].
188188
====
189189

190-
Do not create or rename a top-level directory in the repository and topic map without checking with the docs program manager first. In the main OpenShift docs, you can create one level of subdirectories. In the docs for features that are designed to be used with OpenShift, such as Service Mesh and OpenShift Virtualization, you can create two levels of subdirectories.
190+
Do not create or rename a top-level directory in the repository and topic map without checking with the docs program manager first.
191+
192+
Avoid creating two levels of subdirectories because the link:https://github.com/openshift/openshift-docs/issues/52149[breadcrumb bar on docs.openshift.com breaks]. If you have a valid use case for two levels of subdirectories, talk with your DPM/CS (and, for aligned teams, the OpenShift DPM) for approval before creating it.
191193

192194
When creating a new directory or subdirectory, you must create four symbolic links in it:
193195

0 commit comments

Comments
 (0)