Skip to content

Commit 2226a5c

Browse files
committed
Comment two sections out of version guidelines
1 parent 7f68ab4 commit 2226a5c

File tree

3 files changed

+92
-90
lines changed

3 files changed

+92
-90
lines changed

docs/docset.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ subs:
2727
a-global-variable: "This was defined in docset.yml"
2828
stack: Elastic Stack
2929
serverless-short: Serverless
30+
ece: "Elastic Cloud Enterprise"
31+
eck: "Elastic Cloud on Kubernetes"
3032
toc:
3133
- file: index.md
3234
- hidden: developer-notes.md

docs/versions/_snippets/content-patterns-list.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
| --- | --- |
33
| [Page-level `applies` tags](/versions/content-patterns.md#page-level-applies-tags) | Provide signals that a page applies to the reader. |
44
| [Section/heading-level `applies` tags](/versions/content-patterns.md#sectionheading-level-applies-tags) | Provide signals about a section’s scope so a user can choose to read or skip it as needed. |
5-
| [List item suffixes](/versions/content-patterns.md#list-item-suffixes) | Identify features in a **list of features** that are exclusive to a specific context, or that were introduced in a specific version. |
65
| [Tabs](/versions/content-patterns.md#tabs) | Provide two sets of procedures when one or more steps in a process differs between contexts or versions. |
7-
| [Sibling bullets](/versions/content-patterns.md#sibling-bullets) | List differing requirements, limits, and other simple, mirrored facts. |
86
| [Callouts](/versions/content-patterns.md#callouts) | Draw attention to happy differences and basic clarifications. |
97
| [Prose](/versions/content-patterns.md#prose) | Provide clarifying or secondary information, explain differences with a "why". |
10-
| [Sibling pages](/versions/content-patterns.md#sibling-pages) | When the information is too complex to be addressed with only the other content patterns. See specific examples in the sibling pages section. |
8+
| [Sibling pages](/versions/content-patterns.md#sibling-pages) | When the information is too complex to be addressed with only the other content patterns. See specific examples in the sibling pages section. |
9+
10+
% | [List item suffixes](/versions/content-patterns.md#list-item-suffixes) | Identify features in a **list of features** that are exclusive to a specific context, or that were introduced in a specific version. |
11+
% | [Sibling bullets](/versions/content-patterns.md#sibling-bullets) | List differing requirements, limits, and other simple, mirrored facts. |

docs/versions/content-patterns.md

Lines changed: 86 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Add tags for all **versioning facets** relevant to the page.
2525

2626
See [Versions and lifecycle states](/versions/index.md#versions-and-lifecycle-states) to learn when to specify versions in these tags.
2727

28-
### Example
28+
### Examples
29+
2930
[Manage your Cloud organization](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/deploy-manage/cloud-organization)
3031

3132
## Section/heading-level `applies` tags
@@ -48,47 +49,47 @@ See [Versions and lifecycle states](/versions/index.md#versions-and-lifecycle-st
4849
**Example**
4950
See above
5051

51-
## List item suffixes
52-
53-
**Use case:** When features in a **list of features** are exclusive to a specific context, or were introduced in a specific version
54-
55-
**Number to use:** Three max. If the number of tags is longer than that, consider:
56-
57-
* Breaking up the list by facet
58-
* Using labels that don't have version / lifecycle information and deferring that information to the page or section for the feature
59-
60-
**Approach:**
61-
62-
Append the information to the bullet item in bolded square brackets `**[]**`. Add all information within a single set of square brackets. The brackets should appear after any final punctuation. Consider using words like `only` to help people to understand that this information indicates the applicability of a feature.
63-
64-
### Example
65-
66-
Spaces let you organize your content and users according to your needs.
67-
68-
::::{tab-set}
69-
:group: one-two
70-
71-
:::{tab-item} One
72-
:sync: one
73-
74-
* Each space has its own saved objects.
75-
* Users can only access the spaces that they have been granted access to. This access is based on user roles, and a given role can have different permissions per space.
76-
* Each space has its own navigation. **[{{stack}} v9 only]**
77-
78-
:::
79-
:::{tab-item} Two
80-
:sync: two
81-
82-
83-
* Learn about internal users, which are responsible for the operations that take place inside an Elasticsearch cluster
84-
* Learn about service accounts, which are used for integration with external services that connect to Elasticsearch
85-
* Learn about the services used for token-based authentication
86-
* Learn about the services used by orchestrators **[Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes]**
87-
* Learn about user lookup technologies
88-
* Manage the user cache
89-
90-
:::
91-
::::
52+
% ## List item suffixes
53+
%
54+
% **Use case:** When features in a **list of features** are exclusive to a specific context, or were introduced in a specific version
55+
%
56+
% **Number to use:** Three max. If the number of tags is longer than that, consider:
57+
%
58+
% * Breaking up the list by facet
59+
% * Using labels that don't have version / lifecycle information and deferring that information to the page or section for the feature
60+
%
61+
% **Approach:**
62+
%
63+
% Append the information to the bullet item in bolded square brackets `**[]**`. Add all information within a single set of square brackets. The brackets should appear after any final punctuation. Consider using words like `only` to help people to understand that this information indicates the applicability of a feature.
64+
%
65+
% ### Examples
66+
%
67+
% Spaces let you organize your content and users according to your needs.
68+
%
69+
% ::::{tab-set}
70+
% :group: one-two
71+
%
72+
% :::{tab-item} One
73+
% :sync: one
74+
%
75+
% * Each space has its own saved objects.
76+
% * Users can only access the spaces that they have been granted access to. This access is based on user roles, and a given role can have different permissions per space.
77+
% * Each space has its own navigation. **[{{stack}} v9 only]**
78+
%
79+
% :::
80+
% :::{tab-item} Two
81+
% :sync: two
82+
%
83+
%
84+
% * Learn about internal users, which are responsible for the operations that take place inside an Elasticsearch cluster
85+
% * Learn about service accounts, which are used for integration with external services that connect to Elasticsearch
86+
% * Learn about the services used for token-based authentication
87+
% * Learn about the services used by orchestrators **[Elastic Cloud Hosted, {{ece}}, {{eck}}]**
88+
% * Learn about user lookup technologies
89+
% * Manage the user cache
90+
%
91+
% :::
92+
% ::::
9293

9394

9495
## Tabs
@@ -97,13 +98,7 @@ Spaces let you organize your content and users according to your needs.
9798

9899
**Number to use:** Max 4 or 5 (in a deployment type / versioning context - might be different for other situations)
99100

100-
Try to minimize the number of tabs where you can - try to work around small differences by rewording or adding context in prose or in `note` style admonitions:
101-
102-
* In {{stack}} 9.1.0 and earlier, **Spaces** were referred to as **Places**.
103-
*
104-
::::{note}
105-
In {{stack}} 9.1.0 and earlier, click the **Permissions** tab.
106-
::::
101+
Try to minimize the number of tabs where you can - try to work around small differences by rewording or adding context in prose or in `note` style admonitions. Check out the [prose](#prose) guidelines.
107102

108103
Try not to include information surrounding a procedure in the tabs. Make the tab content as small as possible apart from the procedure itself.
109104

@@ -112,7 +107,8 @@ Consider breaking up procedures into sets of procedures if only one section diff
112107
:::{tip}
113108
For consistency, use [substitutions](/syntax/substitutions.md) for the tab labels.
114109
:::
115-
### Example
110+
111+
### Examples
116112

117113
To create a space:
118114

@@ -157,37 +153,37 @@ To create a space:
157153

158154
You can edit all of the space settings you just defined at any time, except for the URL identifier.
159155

160-
## Sibling bullets
161-
162-
**Use case:** Requirements, limits, other simple, mirrored facts.
163-
164-
**Number to use:** Ideal is one per option (e.g. one per deployment type). You might consider nested bullets in limited cases.
165-
166-
### Examples
167-
168-
::::{tab-set}
169-
:group: one-two
170-
171-
:::{tab-item} One
172-
:sync: one
173-
174-
#### Required permissions
175-
176-
* **{{serverless-short}}**: `Admin` or equivalent
177-
* **{{stack}} v9**: `kibana_admin` or equivalent
178-
179-
:::
180-
:::{tab-item} Two
181-
:sync: two
182-
183-
#### Create a space
184-
185-
The maximum number of spaces that you can have differs by [what do we call this]:
186-
187-
* **{{serverless-short}}**: Maximum of 100 spaces.
188-
* **{{stack}} v9**: Controlled by the `xpack.spaces.maxSpaces` setting. Default is 1000.
189-
:::
190-
::::
156+
% ## Sibling bullets
157+
%
158+
% **Use case:** Requirements, limits, other simple, mirrored facts.
159+
%
160+
% **Number to use:** Ideal is one per option (e.g. one per deployment type). You might consider nested bullets in limited cases.
161+
%
162+
% ### Examples
163+
%
164+
% ::::{tab-set}
165+
% :group: one-two
166+
%
167+
% :::{tab-item} One
168+
% :sync: one
169+
%
170+
% #### Required permissions
171+
%
172+
% * **{{serverless-short}}**: `Admin` or equivalent
173+
% * **{{stack}} v9**: `kibana_admin` or equivalent
174+
%
175+
% :::
176+
% :::{tab-item} Two
177+
% :sync: two
178+
%
179+
% #### Create a space
180+
%
181+
% The maximum number of spaces that you can have differs by [what do we call this]:
182+
%
183+
% * **{{serverless-short}}**: Maximum of 100 spaces.
184+
% * **{{stack}} v9**: Controlled by the `xpack.spaces.maxSpaces` setting. Default is 1000.
185+
% :::
186+
% ::::
191187

192188
## Callouts
193189

@@ -217,14 +213,17 @@ If there’s a terminology change or other minor change (especially where x equa
217213
**When to use:**
218214
* Cases where the information isn’t wildly important, but nice to know, or to add basic terminology change info to overviews
219215
* Comparative overviews
216+
* Differences that are small enough or not significant enough to warrant an admonition or tabs or separate sections with frontmatter.
220217

221218
In some cases, you might want to add a paragraph specific to one version or another in prose to clarify behavior or terminology.
222219

223220
In cases where there are significant differences between contexts, close explanation of the differences helps people to understand how something works, or why something behaves the way it does. Compare and contrast differences in paragraphs when the explanation helps people to use our features effectively.
224221

225-
You also might do this to compare approaches between deployment types, when [sibling bullets](#sibling-bullets) aren't enough.
222+
% You also might do this to compare approaches between deployment types, when [sibling bullets](#sibling-bullets) aren't enough.
223+
224+
### Examples
226225

227-
### Example
226+
* In {{stack}} 9.1.0 and earlier, **Spaces** were referred to as **Places**.
228227

229228
::::{tab-set}
230229
:group: one-two-three
@@ -234,11 +233,11 @@ You also might do this to compare approaches between deployment types, when [sib
234233

235234
The way that TLS certificates are managed depends on your deployment type:
236235

237-
In **self-managed Elasticsearch**, you manage both of these certificates yourself.
236+
In self-managed Elasticsearch, you manage both of these certificates yourself.
238237

239-
In **Elastic Cloud on Kubernetes**, you can manage certificates for the HTTP layer. Certificates for the transport layer are managed by ECK and can’t be changed. However, you can set your own certificate authority, customize certificate contents, and provide your own certificate generation tools using transport settings.
238+
In {{eck}}, you can manage certificates for the HTTP layer. Certificates for the transport layer are managed by ECK and can’t be changed. However, you can set your own certificate authority, customize certificate contents, and provide your own certificate generation tools using transport settings.
240239

241-
In **Elastic Cloud Enterprise**, you can use one or more proxy certificates to secure the HTTP layer. These certificates are managed at the ECE installation level. Transport-level encryption is managed by ECE and certificates can’t be changed.
240+
In {{ece}}, you can use one or more proxy certificates to secure the HTTP layer. These certificates are managed at the ECE installation level. Transport-level encryption is managed by ECE and certificates can’t be changed.
242241
:::
243242

244243
:::{tab-item} Two
@@ -282,7 +281,7 @@ When version differences are just too large to be handled with any of our other
282281

283282
% Down the line, if we need to, we could easily convert version-sensitive sibling pages into “picker” pages
284283

285-
### Example
284+
### Examples
286285

287286
[Cloud Hosted deployment billing dimensions](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.html)
288287

0 commit comments

Comments
 (0)