@@ -51,11 +51,10 @@ use the full name on first use and short name after, for example:
51
51
- Grafana Beyla (full), Beyla (short)
52
52
53
53
Refer to the "OpenTelemetry Collector" as "Collector" after the first use.
54
- Still use "OpenTelemetry Collector" when refering to a distribution,
54
+ Still use "OpenTelemetry Collector" when referring to a distribution,
55
55
and for headings and links.
56
56
57
57
Always use the full name for "Grafana Cloud".
58
- Always capitalize and use the full name for Application Observability.
59
58
60
59
Never use abbreviations for product names unless specifically asked to,
61
60
for example:
@@ -84,13 +83,12 @@ Focus on Grafana and not the partner product, for example:
84
83
- For an integration with Azure don't document Azure set up
85
84
- For a migration from DataDog don't document DataDog set up or usage
86
85
87
- ## frontmatter
86
+ ## Front matter
88
87
89
88
Never remove front matter content at the start of the file.
90
- This includes all content from the start of the file,
91
- inbetween a pair of tripple dashes (---).
89
+ This includes all content from the start of the file that's between a pair of triple dashes (` --- ` ).
92
90
93
- Never removed YAML front matter meta data unless specifically asked to.
91
+ Never removed YAML front matter metadata unless specifically asked to.
94
92
95
93
For example, never remove or delete this or other front matter:
96
94
@@ -104,19 +102,19 @@ cascade:
104
102
105
103
# OpenTelemetry
106
104
107
- Markdown content...
105
+ <MARKDOWN CONTENT>
108
106
```
109
107
110
108
Only edit front matter copy if specifically asked to.
111
109
When performing a copy edit task,
112
110
ask the user if they'd like you to also edit the front matter copy.
113
- Still never remove front matter meta data properpties .
111
+ Still never remove front matter metadata fields .
114
112
115
113
## Structure
116
114
117
115
Structure articles into sections with headings.
118
116
119
- The frontmatter YAML ` title ` and the content h1 (#) heading should be the same.
117
+ The front matter YAML ` title ` and the content h1 (#) heading should be the same.
120
118
Never remove the content h1 heading, this redundancy is required.
121
119
122
120
Always include copy after a heading, for example:
@@ -143,11 +141,9 @@ Add a blank line after headings, for example:
143
141
Copy after the heading and a blank line.
144
142
```
145
143
146
- The immediate copy after a heading should introduce and overview what is
147
- covered in the section.
144
+ The immediate copy after a heading should introduce and overview what's covered in the section.
148
145
149
- Start articles with an introduction that covers the goal of the article,
150
- example goals:
146
+ Start articles with an introduction that covers the goal of the article, example goals:
151
147
152
148
- Learn concepts
153
149
- Set up or install something
@@ -163,12 +159,12 @@ Follow the goal with a list of prerequisites, for example:
163
159
``` markdown
164
160
Before you begin ensure you have the following:
165
161
166
- - <Prerequisite 1>
167
- - <Prerequisite 2>
162
+ - <PREREQUISITE 1>
163
+ - <PREREQUISITE 2>
168
164
- ...
169
165
```
170
166
171
- Suggest and link to next steps and related resources at the end of the article,
167
+ If asked to do so, suggest and link to next steps and related resources at the end of the article,
172
168
for example:
173
169
174
170
- Learn more about A, B, C
@@ -177,9 +173,9 @@ for example:
177
173
- Use X to achieve Z
178
174
- Project homepage or documentation
179
175
- Project repository (for example, GitHub, GitLab)
180
- - Project package (for example, pip or npm )
176
+ - Project package (for example, pip or NPM )
181
177
182
- You don't need to use the "Refer to... " syntax for next steps,
178
+ You don't need to use the "Refer to" syntax for next steps,
183
179
use the list time text for the link text.
184
180
185
181
## Style
@@ -199,7 +195,7 @@ Always use contractions over multiple words, for example:
199
195
- use "isn't" and not "is not"
200
196
- use "that's" and not "that is"
201
197
- use "you're" and not "you are"
202
- - use "Don 't" and not "do not"
198
+ - use "don 't" and not "do not"
203
199
204
200
Don't use filler words or phrases, for example:
205
201
@@ -210,8 +206,7 @@ Don't use filler words or phrases, for example:
210
206
- "keep in mind"
211
207
212
208
In most cases, use verbs and nouns without adverbs or adjectives.
213
- You may use minimal adverbs and adjectives,
214
- when introucing or overviewing a Grafana Labs product.
209
+ You may use minimal adverbs and adjectives when introducing a Grafana Labs product.
215
210
216
211
Don't use figures of speech.
217
212
@@ -223,7 +218,7 @@ Never use cultural references or charged language.
223
218
224
219
Write in present simple tense.
225
220
226
- Avoid present continous tense.
221
+ Avoid present continuous tense.
227
222
228
223
Only write in future tense to show future actions.
229
224
@@ -239,7 +234,7 @@ Address users as "you".
239
234
240
235
Don't use first person perspective.
241
236
242
- ## Wordlist
237
+ ## Word list
243
238
244
239
Use allowlist/blocklist instead of whitelist/blacklist.
245
240
@@ -291,7 +286,7 @@ Avoid using words created for UI features when possible, for example
291
286
292
287
Write complete sentences for lists, for example:
293
288
294
- - Works with all languages and frameworks (correct)
289
+ - Works with all languages and frameworks. (correct)
295
290
- all languages and frameworks (wrong)
296
291
297
292
Always use dashes for unordered lists, for example
@@ -310,10 +305,10 @@ Never use asterisks for unordered lists, for example:
310
305
* List item 3 (wrong)
311
306
```
312
307
313
- Never use full stops at the end of unordered list items, for example:
308
+ Use full stops at the end of list items if the item is a full sentence, otherwise, omit it.
314
309
315
310
``` markdown
316
- - Works with all languages and frameworks (correct)
311
+ - Works with all languages and frameworks. (correct)
317
312
- Works with all languages and frameworks (wrong)
318
313
```
319
314
@@ -341,15 +336,6 @@ Always start the next list item immediately on the next line, for example:
341
336
- List item 3
342
337
```
343
338
344
- Never use new lines between list items, for example:
345
-
346
- ``` markdown
347
- - List item 1
348
-
349
- - List item 2 (wrong)
350
-
351
- - List item 3 (wrong)
352
- ```
353
339
354
340
If a list starts with a keyword, bold the keyword and follow with a colon,
355
341
for example:
@@ -373,10 +359,10 @@ For example:
373
359
374
360
## Code
375
361
376
- Use single code backticks for:
362
+ Use single code backticks \` for:
377
363
378
364
- user input
379
- - placeholders in markdown , for example _ ` <PLACEHOLDER_NAME> ` _
365
+ - placeholders in Markdown , for example _ ` <PLACEHOLDER_NAME> ` _
380
366
- files and directories, for example ` /opt/file.md `
381
367
- source code keywords and identifiers,
382
368
for example variables, function and class names
@@ -410,7 +396,7 @@ OTEL_EXPORTER_OTLP_ENDPOINT=<OTLP_ENDPOINT>
410
396
The placeholder includes the name and the less than and greater than symbols,
411
397
for example < PLACEHOLDER_NAME> .
412
398
413
- If the placeholder is markdown emphasize it with underscores,
399
+ If the placeholder is Markdown emphasize it with underscores,
414
400
for example _` <PLACEHOLDER_NAME>` _.
415
401
416
402
In code blocks use the placeholder without additional backticks or emphasis,
@@ -479,7 +465,7 @@ kubectl get pods --namespace default
479
465
` ` `
480
466
` ` ` `
481
467
482
- The output will resemble the following:
468
+ The output resembles the following:
483
469
484
470
` ` ` text
485
471
NAME READY STATUS RESTARTS AGE
@@ -503,7 +489,7 @@ Use the following values for option:
503
489
504
490
- YAML/JSON, code, or parameter field if one exists for that configuration
505
491
- Environment variable field if one exists for that configuration
506
- - If there is a YAML and Environment variable option separate them with ` < br > `
492
+ - Use semantic HTML inside table cells for multiple paragraphs or list items.
507
493
508
494
Use a short sentence for the summary.
509
495
After the summary sentence and in the same cell,
@@ -524,7 +510,7 @@ An example configuration table:
524
510
| `logging.level`<br>`LOG_LEVEL` | Sets the logging verbosity. Refer to [logging level](#logging-level) for details. | No | String | `debug`, `info`, `warn`, `error` | `info` |
525
511
```
526
512
527
- In some ocassions you can drop the Values column, for example,
513
+ In some occasions you can drop the Values column, for example,
528
514
when all the configuration have a Boolean type (yes/no) or (1/0).
529
515
530
516
After the table, for each configuration, add a sub-section.
@@ -615,9 +601,6 @@ Use admonitions sparingly.
615
601
Only include exceptional information in admonitions,
616
602
this means you will use it more often for warnings than notes and cautions.
617
603
618
- When an admonition is used, place it after any initial written information to
619
- the user. Do not place admonitions right at the end of sections where they might be missed.
620
-
621
604
Never delete Hugo shortcodes unless specifically asked to,
622
605
for example don' t delete shortcodes:
623
606
0 commit comments