Skip to content

Commit 83ba8b5

Browse files
authored
Make minor edits to syntax quick ref (#1043)
* a few more essential fixes * Update quick-ref.md * one more time * got that wrong
1 parent 92ffaaf commit 83ba8b5

File tree

1 file changed

+29
-60
lines changed

1 file changed

+29
-60
lines changed

Diff for: docs/syntax/quick-ref.md

+29-60
Original file line numberDiff line numberDiff line change
@@ -111,39 +111,9 @@ A default anchor is automatically created for each [heading](#headings), in the
111111

112112
## Applies to
113113

114-
Tags that identify technical contexts: the feature base (stack/serverless), deployments, and project types that a piece of content "applies to." Use `applies_to` tags to help users determine whether content is right for their deployments and configuration. For more guidance, see
115-
[](../versions/content-patterns.md) and the [full syntax guide](applies.md).
114+
Tags that identify technical contexts: the feature base (stack/serverless), deployments, and project types that a piece of content "applies to." Use `applies_to` tags to help users determine whether content is right for their deployments and configuration. These tags are a [version content pattern](../versions/content-patterns.md) in Elastic Docs v3.
116115

117-
:::{tip}
118-
The `applies_to` tags are scope signals for readers, not comprehensive metadata. If a page contains general information that applies to all contexts, it doesn't need tags.
119-
:::
120-
121-
### Page-level tag
122-
123-
:::{dropdown} Syntax
124-
125-
This example includes version and release phase facets, which aren't always needed.
126-
127-
```yaml
128-
---
129-
applies_to:
130-
stack: 9.0
131-
deployment:
132-
ece: preview
133-
eck: beta 9.0.1
134-
ess:
135-
self: 9.0
136-
serverless:
137-
elasticsearch:
138-
observability: deprecated
139-
security:
140-
product:
141-
---
142-
```
143-
:::
144-
145-
146-
### Section tag
116+
**Example: Section tag**
147117

148118
:::{dropdown} Syntax
149119
````markdown
@@ -161,23 +131,25 @@ stack:
161131
```
162132
:::
163133

164-
### Inline tag
134+
For full syntax and more examples, see [](applies.md).
165135

166-
For details on inline tags, see the [full syntax reference](applies.md).
136+
<!--
137+
:::{tip}
138+
The `applies_to` tags are scope signals for readers, not comprehensive metadata. If a page contains general information that applies to all contexts, it doesn't need tags.
139+
:::
140+
-->
141+
142+
% TODO restore details when guidance has settled
167143

168144
**DOs**<br>
169-
✅ Define a set of page-level `applies_to` tags in a front matter block<br>
170-
✅ Add `{applies_to}` after a heading to indicate that section's contexts<br>
171-
✅ Indicate versions (`major.minor` with an optional `[.patch]`) and release phases like `beta`
145+
✅ Define a set of [page-level tags](applies.md#page-annotations) in a front matter block<br>
146+
✅ Add section-level tags in an `{applies_to}` [directive](applies.md#sections) after a heading<br>
147+
✅ Indicate versions (`major.minor` with an optional `[.patch]`) and release phases like `beta`
172148

173149
**DON'Ts**<br>
174-
❌ Add `applies_to` tags to general, broadly applicable content<br>
175-
❌ Use `applies_to` tags as metadata or to represent "aboutness"<br>
176150
❌ Include `applies_to` tags in admonitions<br>
177-
❌ Use `Coming (x.x.x)` tags, except in special cases (don't pre-announce features)<br>
178-
179-
180-
[More details: Applies to →](applies.md)
151+
❌ Add `applies_to` tags to general, broadly applicable content<br>
152+
❌ Use `Coming (x.x.x)` tags, except in special cases (don't pre-announce features)
181153
<br>
182154
<br>
183155

@@ -227,7 +199,7 @@ To explicitly create a code callout, add a number marker in angle brackets (`<1>
227199

228200
:::{dropdown} Syntax
229201

230-
```markdown callouts=false
202+
````markdown callouts=false
231203
```json
232204
{
233205
"match": {
@@ -236,6 +208,7 @@ To explicitly create a code callout, add a number marker in angle brackets (`<1>
236208
}
237209
```
238210
1. Searches the `message` field for the phrase "search text"
211+
````
239212
:::
240213

241214
:::{dropdown} Output
@@ -255,31 +228,31 @@ Add comments with `//` or `#` to magically create callouts.
255228

256229
:::{dropdown} Syntax
257230
````markdown callouts=false
258-
```json
259-
{
260-
"match": {
261-
"message": "search text" // Searches the message field
262-
}
263-
}
264-
:::
265-
266-
:::{dropdown} Output
267-
```markdown
268231
```json
269232
{
270233
"match": {
271234
"message": "search text" // Searches the message field
272235
}
273236
}
274237
```
275-
```
238+
````
239+
:::
276240

241+
:::{dropdown} Output
242+
243+
```json
244+
{
245+
"match": {
246+
"message": "search text" // Searches the message field
247+
}
248+
}
249+
```
277250
:::
278251

279252
**DOs**<br>
280253
✅ Keep callout text short and specific<br>
281254
✅ Use only one type of callout per code block (don't mix [explicit](#explicit-callout) and [magic](#magic-callout))<br>
282-
For explicit callouts, make sure you have a corresponding list item for each callout marker in the code.
255+
Make sure there's a corresponding list item for each explicit callout marker in a code block
283256

284257
**DON'Ts**<br>
285258
❌ Overuse callouts -- they can impede readability<br>
@@ -696,7 +669,3 @@ Standard table layout for structured data. Automatically scrolls horizontally if
696669
❌ Use a table solely for position or spacing purposes<br>
697670

698671
[More details: Tables →](tables.md)
699-
<br>
700-
<br>
701-
702-
---

0 commit comments

Comments
 (0)