Skip to content

Commit 5f8a43b

Browse files
committed
RHDEVDOCS-3332 Add "Adding a subsection on making open source more inclusive" to the documentation guidelines
1 parent c20d087 commit 5f8a43b

File tree

6 files changed

+16
-8
lines changed

6 files changed

+16
-8
lines changed

cicd/gitops/gitops-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ toc::[]
1717
1818
For an overview of {gitops-title}, see xref:../../cicd/gitops/understanding-openshift-gitops.adoc#understanding-openshift-gitops[Understanding OpenShift GitOps].
1919

20-
include::modules/con_making-open-source-more-inclusive.adoc[leveloffset=+1]
20+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
2121

2222
// Modules included, most to least recent
2323
include::modules/gitops-release-notes-1-2-1.adoc[leveloffset=+1]

cicd/pipelines/op-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toc::[]
1818
1919
For an overview of {pipelines-title}, see xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding OpenShift Pipelines].
2020

21-
include::modules/con_making-open-source-more-inclusive.adoc[leveloffset=+1]
21+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
2222

2323
// Modules included, most to least recent
2424
include::modules/op-release-notes-1-5.adoc[leveloffset=+1]

contributing_to_docs/doc_guidelines.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,16 @@ You can replace "node" in the preceding examples with "machine", "host", or anot
286286
If you are cherry picking from `main` to `enterprise-4.8` or earlier, you must manually cherry pick to include the “(also known as master)” phrasing. This is required only if the phrase “control plane” is introduced for the first time in an assembly or module.
287287
====
288288

289+
[id="adding-a-subsection-on-making-open-source-more-inclusive"]
290+
=== Adding a subsection on making open source more inclusive
291+
292+
If you create a release notes assembly for a sub-product within the `openshift/openshift-docs` repo, you might include a "Making open source more inclusive" statement. Instead of pasting the statement from the OpenShift Release Notes, use the following module, which is available in the `enterprise-4.8` branch and later:
293+
294+
[source,text]
295+
----
296+
\include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
297+
----
298+
289299
[id="product-name-and-version"]
290300
== Product name and version
291301

@@ -588,9 +598,7 @@ To indicate that a feature is in Technology Preview, include the
588598
`modules/technology-preview.adoc` file in the feature's assembly to keep the
589599
supportability wording consistent across Technology Preview features and provide a value for the :FeatureName: variable before you include this module.
590600

591-
See
592-
link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an
593-
example] of how this is applied.
601+
See link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an example] of how this is applied.
594602

595603
== Indicating deprecated features
596604

jaeger/rhbjaeger-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99

1010
include::modules/jaeger-product-overview.adoc[leveloffset=+1]
1111

12-
include::modules/con_making-open-source-more-inclusive.adoc[leveloffset=+1]
12+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
1313

1414
include::modules/support.adoc[leveloffset=+1]
1515

logging/cluster-logging-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ toc::[]
1717
|RHOL 5.2|X |X |X
1818
|====
1919

20-
include::modules/con_making-open-source-more-inclusive.adoc[leveloffset=+1]
20+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
2121

2222
// Release Notes by version
2323

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_module-type: CONCEPT
22

3-
[id="con_making-open-source-more-inclusive_{context}"]
3+
[id="making-open-source-more-inclusive_{context}"]
44
= Making open source more inclusive
55

66
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message].

0 commit comments

Comments
 (0)