Skip to content

Commit b8f5d4e

Browse files
committed
Remove indentation
1 parent a5c9e98 commit b8f5d4e

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

contribute-docs/style-guide/grammar-spelling.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Use gender-neutral pronouns as appropriate. Avoid using *he*, *him*, *his*, *she
5353
Avoid temporal words like *currently*, *now*, or *will* and conditional words like *should* or *could*. Write in the present tense to describe the state of the product as it is now. You may need to use the past tense occasionally, but try to change it to the present tense to see if that's a better fit.
5454

5555
:::{dropdown} Example
56-
**Don't**: If you didn't select all the required permissions, an error message will appear.
56+
**Don't**: If you didn't select all the required permissions, an error message will appear.
5757

58-
✔️ **Do**: If you don't select all the required permissions, an error message appears.
58+
✔️ **Do**: If you don't select all the required permissions, an error message appears.
5959
:::
6060

6161
## Contraction do's and dont's
@@ -65,9 +65,9 @@ Use contractions: they're (an acceptable contraction, by the way) conversational
6565
Don't use Elastic references as a contraction to replace *Elastic is*.
6666

6767
:::{dropdown} Example
68-
**Don't**: Elastic's excited to release this new feature.
68+
**Don't**: Elastic's excited to release this new feature.
6969

70-
✔️ **Do**: Elastic's new feature helps you find information fast.
70+
✔️ **Do**: Elastic's new feature helps you find information fast.
7171
:::
7272

7373
Avoid ambiguous or awkward contractions, such as *there'd*, *it'll*, and *they'd*.
@@ -91,9 +91,9 @@ Secure your cluster
9191
Avoid gerunds in prepositional phrases—this will make your instructions easier to understand. Also avoid gerunds in instructional/procedural sentences or headings.
9292

9393
:::{dropdown} Example
94-
**Don't**: Refer to instructions on configuring the Elastic Agent.
95-
96-
✔️ **Do**: Refer to instructions on how to configure the Elastic Agent.
94+
**Don't**: Refer to instructions on configuring the Elastic Agent.
95+
96+
✔️ **Do**: Refer to instructions on how to configure the Elastic Agent.
9797
:::
9898

9999
## Punctuation
@@ -152,25 +152,25 @@ Use commas:
152152
* When an independent clause and a dependent clause are separated by a coordinating conjunction (*and*, *but*, *or*, *nor*, *fo*r, *so*, or *yet*).
153153

154154
:::{dropdown} Examples
155-
**Don't**: The rule runs every 5 minutes, but analyzes the documents added to indices during the last 6 minutes.
155+
**Don't**: The rule runs every 5 minutes, but analyzes the documents added to indices during the last 6 minutes.
156156

157-
✔️ **Do**: The rule runs every 5 minutes but analyzes the documents added to indices during the last 6 minutes.
157+
✔️ **Do**: The rule runs every 5 minutes but analyzes the documents added to indices during the last 6 minutes.
158158

159-
❌ **Don't**: A custom query rule searches the defined indices, and creates an alert when a document matches the rule's KQL query.
159+
**Don't**: A custom query rule searches the defined indices, and creates an alert when a document matches the rule's KQL query.
160160

161-
✔️ **Do**: A custom query rule searches the defined indices and creates an alert when a document matches the rule's KQL query.
161+
✔️ **Do**: A custom query rule searches the defined indices and creates an alert when a document matches the rule's KQL query.
162162
:::
163163

164164
* To set off defining relative clauses.
165165

166166
:::{dropdown} Examples
167-
**Don't**: You must use a data view, whose index pattern matches `servers-europe-*`.
167+
**Don't**: You must use a data view, whose index pattern matches `servers-europe-*`.
168168

169-
✔️ **Do**: You must use a data view whose index pattern matches `servers-europe-*`.
169+
✔️ **Do**: You must use a data view whose index pattern matches `servers-europe-*`.
170170

171-
❌ **Don't**: To roll back, you must have a backup snapshot, that includes the `kibana` feature state.
171+
**Don't**: To roll back, you must have a backup snapshot, that includes the `kibana` feature state.
172172

173-
✔️ **Do**: To roll back, you must have a backup snapshot that includes the `kibana` feature state.
173+
✔️ **Do**: To roll back, you must have a backup snapshot that includes the `kibana` feature state.
174174
:::
175175

176176
### Dashes and hyphens
@@ -218,25 +218,25 @@ Use a hyphen:
218218
* For predicate adjectives (compound modifiers that come after the word they modify).
219219

220220
:::{dropdown} Examples
221-
**Don't**: Ensure your environment is up-to-date.
221+
**Don't**: Ensure your environment is up-to-date.
222222

223-
✔️ **Do**: Ensure your environment is up to date.
223+
✔️ **Do**: Ensure your environment is up to date.
224224

225-
❌ **Don't**: The values are user-defined.
225+
**Don't**: The values are user-defined.
226226

227-
✔️ **Do**: The values are user defined.
227+
✔️ **Do**: The values are user defined.
228228
:::
229229

230230
* For compounds with an adverb ending in `-ly`.
231231

232232
:::{dropdown} Examples
233-
**Don't**: Newly-installed Agent
233+
**Don't**: Newly-installed Agent
234234

235-
✔️ **Do**: Newly installed Agent
235+
✔️ **Do**: Newly installed Agent
236236

237-
❌ **Don't**: Publicly-exposed storage buckets
237+
**Don't**: Publicly-exposed storage buckets
238238

239-
✔️ **Do**: Publicly exposed storage buckets
239+
✔️ **Do**: Publicly exposed storage buckets
240240
:::
241241

242242
#### En dashes
@@ -262,8 +262,8 @@ Use an en dash:
262262
Use em dashes to indicate a break in the flow of a sentence. Don't add spaces around an em dash.
263263

264264
:::{dropdown} Examples
265-
* Consider adding exceptions—preferably with a combination of user agent and IP address conditions.
266-
* Filter out endpoint events that you don't want to store—for example, high-volume events.
265+
* Consider adding exceptions—preferably with a combination of user agent and IP address conditions.
266+
* Filter out endpoint events that you don't want to store—for example, high-volume events.
267267
:::
268268

269269
### Parentheses
@@ -273,8 +273,8 @@ Before using parentheses, consider if you can replace them with dashes, semicolo
273273
Use parentheses for abbreviations and acronyms after spelling them out.
274274

275275
:::{dropdown} Examples
276-
* Monitor the security posture of your cloud assets using the Cloud Security Posture Management (CSPM) feature.
277-
* Expand a risk level group (for example, **High**) or an asset criticality group (for example, **high_impact**).
276+
* Monitor the security posture of your cloud assets using the Cloud Security Posture Management (CSPM) feature.
277+
* Expand a risk level group (for example, **High**) or an asset criticality group (for example, **high_impact**).
278278
:::
279279

280280
### Semicolons
@@ -284,8 +284,8 @@ In general, try to simplify complex sentences to avoid using semicolons.
284284
Where necessary, use a semicolon to join two closely related independent clauses where a period or a comma is not as effective.
285285

286286
:::{dropdown} Examples
287-
* The endpoint is idempotent; therefore, it can safely be used to poll a given migration and, upon completion, finalize it.
288-
* Multiple consecutive dashes in the value must be escaped; single dashes do not need to be escaped.
287+
* The endpoint is idempotent; therefore, it can safely be used to poll a given migration and, upon completion, finalize it.
288+
* Multiple consecutive dashes in the value must be escaped; single dashes do not need to be escaped.
289289
:::
290290

291291
## Spelling
@@ -360,17 +360,17 @@ Follow the standard capitalization rules for American English. In general, use s
360360
❌ Don't capitalize the spelled-out form of an acronym unless it's a proper noun or is conventionally capitalized.
361361

362362
:::{dropdown} Examples
363-
**Don't**: This tab shows anomalies discovered by Machine Learning (ML) jobs.
363+
**Don't**: This tab shows anomalies discovered by Machine Learning (ML) jobs.
364364

365-
✔️ **Do**: This tab shows anomalies discovered by machine learning (ML) jobs.
365+
✔️ **Do**: This tab shows anomalies discovered by machine learning (ML) jobs.
366366
:::
367367

368368
❌ Don't capitalize API names.
369369

370370
:::{dropdown} Examples
371-
**Don't**: The Bulk API makes it possible to perform many index/delete operations in a single API call.
371+
**Don't**: The Bulk API makes it possible to perform many index/delete operations in a single API call.
372372

373-
✔️ **Do**: The bulk API makes it possible to perform many index/delete operations in a single API call.
373+
✔️ **Do**: The bulk API makes it possible to perform many index/delete operations in a single API call.
374374
:::
375375

376376
## Abbreviations and acronyms
@@ -382,21 +382,21 @@ In general, spell out abbreviations when a term is unlikely to be familiar to th
382382
Avoid using an abbreviation for the first time in a title or heading, unless you need to match the UI, for example. If the first use of the abbreviation is in a title or heading, introduce the abbreviation (in parentheses, following the spelled-out term) in the following body text.
383383

384384
:::{dropdown} Examples
385-
**Don't**: ECS field reference
385+
**Don't**: ECS field reference
386386

387-
✔️ **Do**: Elastic Common Schema field reference
387+
✔️ **Do**: Elastic Common Schema field reference
388388

389-
✔️ **Do**: Create an ES|QL rule (OK to use abbreviation since this is how the rule type appears in the UI)
389+
✔️ **Do**: Create an ES|QL rule (OK to use abbreviation since this is how the rule type appears in the UI)
390390
:::
391391

392392
### Capitalization of abbreviations
393393

394394
Capitalize the spelled-out version of the abbreviation only if it's a proper noun or is conventionally capitalized. That is, don't capitalize it only because the abbreviation includes capital letters.
395395

396396
:::{dropdown} Examples
397-
**Don't**: This setting determines whether Cross-Cluster Search (CCS) privilege warnings are displayed.
397+
**Don't**: This setting determines whether Cross-Cluster Search (CCS) privilege warnings are displayed.
398398

399-
✔️ **Do**: This setting determines whether cross-cluster search (CCS) privilege warnings are displayed.
399+
✔️ **Do**: This setting determines whether cross-cluster search (CCS) privilege warnings are displayed.
400400
:::
401401

402402
### Making abbreviations plural
@@ -406,29 +406,29 @@ When making them plural, treat abbreviations as regular words. Do not use an apo
406406
If the abbreviation ends in `-s`, `-sh`, `-ch`, or `-x`, then add `-es`.
407407

408408
:::{dropdown} Examples
409-
**Don't**: API's, SDK's, OS'es
409+
**Don't**: API's, SDK's, OS'es
410410

411-
✔️ **Do**: APIs, SDKs, OSes
411+
✔️ **Do**: APIs, SDKs, OSes
412412
:::
413413

414414
### Using the right article
415415

416416
The article (*a* or *an*) you use in front of an abbreviation depends on how the abbreviation is pronounced, not how it's spelled.
417417

418418
:::{dropdown} Examples
419-
**Don't**: a HTML file, a SQL database
419+
**Don't**: a HTML file, a SQL database
420420

421-
✔️ **Do**: an HTML file, an SQL database
421+
✔️ **Do**: an HTML file, an SQL database
422422
:::
423423

424424
### Latin abbreviations
425425

426426
Avoid Latin abbreviations for common English phrases, unless space is limited.
427427

428428
:::{dropdown} Examples
429-
**Don't**: e.g.
430-
431-
✔️ **Do**: for example
429+
**Don't**: e.g.
430+
431+
✔️ **Do**: for example
432432
:::
433433

434434
## Glossary

0 commit comments

Comments
 (0)