Skip to content

Commit 027364d

Browse files
authored
Merge pull request #32094 from ousleyp/understanding-is-confusing
Updating example so that it does not use "Understanding..."
2 parents 45a9acb + fdf2673 commit 027364d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ All titles and section headings must have an anchor ID. The anchor ID must be si
133133
The following is an example anchor ID in an assembly file:
134134

135135
----
136-
[id="understanding-the-monitoring-stack"]
137-
= Understanding the monitoring stack
136+
[id="configuring-alert-notifications"]
137+
= Configuring alert notifications
138138
----
139139

140140
[NOTE]
@@ -149,8 +149,8 @@ You must add the `{context}` variable to the end of anchor IDs in module files.
149149
The following is an example of an anchor ID in a module file:
150150

151151
----
152-
[id="default-monitoring-components_{context}"]
153-
= Default monitoring components
152+
[id="sending-notifications-to-external-systems_{context}"]
153+
= Sending notifications to external systems
154154
----
155155

156156
[NOTE]
@@ -167,26 +167,26 @@ Use unique IDs for "Prerequisites", "Additional resources", and "Next steps" tit
167167
The `prerequisites_`, `additional-resources_`, and `next-steps_` prefixes must end with an underscore (`_`) when declared in an anchor ID in an assembly.
168168
====
169169

170-
The following examples include IDs that are unique to the "Understanding the monitoring stack" assembly.
170+
The following examples include IDs that are unique to the "Configuring alert notifications" assembly:
171171

172172
*Example unique ID for a "Prerequisites" title*
173173

174174
----
175-
[id="prerequisites_understanding-the-monitoring-stack"]
175+
[id="prerequisites_configuring-alert-notifications"]
176176
== Prerequisites
177177
----
178178

179179
*Example unique ID for an "Additional resources" title*
180180

181181
----
182-
[id="additional-resources_understanding-the-monitoring-stack"]
182+
[id="additional-resources_configuring-alert-notifications"]
183183
== Additional resources
184184
----
185185

186186
*Example unique ID for a "Next steps" title*
187187

188188
----
189-
[id="next-steps_understanding-the-monitoring-stack"]
189+
[id="next-steps_configuring-alert-notifications"]
190190
== Next steps
191191
----
192192

0 commit comments

Comments
 (0)