Skip to content

Commit e3c1c94

Browse files
authored
Merge pull request #36384 from bergerhoffer/contrib-updates
Clarifying topic map is only for assemblies
2 parents 3b9530b + 9f529c7 commit e3c1c94

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

contributing_to_docs/contributing.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ are:
9393
* _openshift-webscale_
9494

9595
These attributes can be used by themselves or in conjunction to conditionalize
96-
text within a topic document.
96+
text within an assembly or module.
9797

9898
Here is an example of this concept in use:
9999

@@ -156,17 +156,22 @@ branch against enterprise-3.11 to submit your changes.
156156
====
157157

158158
== Adding files to the collection
159-
After you create files, you must add them to the `_topic_map.yml` so
159+
After you create assembly files, you must add them to the `_topic_map.yml` so
160160
that the build system can render them. The documentation build system reads
161161
the `_distro_map.yml` from the main branch to determine
162162
which branches to build and then the `_topic_map.yml` file
163163
for each of the branches
164164
to construct the content from the source files and publish to the relevant
165165
product site at https://docs.openshift.com. The build system _only_ reads this
166-
file to determine which topic files to include. Therefore, all new topics that
166+
file to determine which topic files to include. Therefore, all new assemblies that
167167
are created must be included in the `_topic_map.yml` file in
168168
order to be processed by the build system.
169169

170+
[NOTE]
171+
====
172+
Module files are included in the appropriate assembly files. Modules are not added directly to the `_topic_map.yml` file.
173+
====
174+
170175
=== Topic map file format
171176
The `_topic_map.yml` file uses the following format:
172177

@@ -202,11 +207,11 @@ topic or topic group will appear in all product documentation versions.
202207
_openshift-origin,openshift-enterprise,openshift-online,openshift-dedicated,openshift-aro,openshift-webscale_.
203208
* The *all* value overrides other values, so _openshift-online,all_ is processed
204209
as *all*.
205-
<5> Topic name.
206-
<6> Topic file under the topic group dir without `.adoc`.
210+
<5> Assembly name.
211+
<6> Assembly file under the topic group dir without `.adoc`.
207212
<7> This topic is actually a subtopic group. Instead of a `File` path it has a
208213
`Dir` path and `Topics`, just like a top-level topic group.
209-
<8> Topics belonging to a subtopic group are listed just like regular topics
214+
<8> Assemblies belonging to a subtopic group are listed just like regular assemblies
210215
with a `Name` and `File`.
211216

212217
== Next steps

0 commit comments

Comments
 (0)