Skip to content

Commit 28424a8

Browse files
authored
Merge pull request #47346 from kalexand-rh/anchor_example
clarifying the context variable in module headings
2 parents 2404187 + 759abf7 commit 28424a8

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -277,19 +277,26 @@ Do not include line spaces between the anchor ID and the section title.
277277

278278
=== Anchoring in module files
279279

280-
You must add the `{context}` variable to the end of anchor IDs in module files. When called, the `{context}` variable is resolved into the value declared in the `:context:` attribute in the corresponding assembly file. This enables cross-referencing to module IDs in context to a specific assembly and is useful when a module is included in multiple assemblies.
280+
You must add the `{context}` variable to the end of each anchor ID in module files. When called, the `{context}` variable is resolved into the value declared in the `:context:` attribute in the corresponding assembly file. This enables cross-referencing to module IDs in context to a specific assembly and is useful when a module is included in multiple assemblies.
281281

282-
The following is an example of an anchor ID in a module file:
282+
[NOTE]
283+
====
284+
The `{context}` variable must be preceded by an underscore (`_`) when declared in an anchor ID.
285+
====
286+
287+
The following is an example of an anchor ID for a module file title:
283288

284289
----
285290
[id="sending-notifications-to-external-systems_{context}"]
286291
= Sending notifications to external systems
287292
----
288293

289-
[NOTE]
290-
====
291-
The `{context}` variable must be preceded by an underscore (`_`) when declared in an anchor ID.
292-
====
294+
The following is an example of an anchor ID for a second level (`==`) heading:
295+
296+
----
297+
[id="deployment-scaling-benefits_{context}"]
298+
== Deployment and scaling benefits
299+
----
293300

294301
=== Anchoring "Prerequisites", "Additional resources", and "Next steps" titles in assemblies
295302

0 commit comments

Comments
 (0)