Skip to content

Commit abd28cf

Browse files
authored
Add more prose use cases (#479)
1 parent e4d16e0 commit abd28cf

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
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. |
55
| [Tabs](/versions/content-patterns.md#tabs) | Provide two sets of procedures when one or more steps in a process differs between contexts or versions. |
66
| [Callouts](/versions/content-patterns.md#callouts) | Draw attention to happy differences and basic clarifications. |
7-
| [Prose](/versions/content-patterns.md#prose) | Provide clarifying or secondary information, explain differences with a "why". |
7+
| [Prose](/versions/content-patterns.md#prose) | - Identify features in a list of features that are exclusive to a specific context, or that were introduced in a specific version<br>- List differing requirements, limits, and other simple, mirrored facts<br>- Provide clarifying or secondary information<br>- Explain differences with a "why" (e.g. comparative overviews) |
88
| [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. |
99

1010
% | [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. |

docs/versions/content-patterns.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -208,12 +208,12 @@ If there’s a terminology change or other minor change (especially where x equa
208208

209209
## Prose
210210

211-
**Use case**: Clarifying or secondary information, differences with a "why"
212-
213-
**When to use:**
211+
**Use cases:**
212+
* When features in a list of features are exclusive to a specific context, or were introduced in a specific version
213+
* Requirements, limits, other simple, mirrored facts
214214
* Cases where the information isn’t wildly important, but nice to know, or to add basic terminology change info to overviews
215215
* Comparative overviews
216-
* Differences that are small enough or not significant enough to warrant an admonition or tabs or separate sections with frontmatter.
216+
* Differences that are small enough or not significant enough to warrant an admonition or tabs or separate sections with front matter
217217

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

@@ -223,12 +223,44 @@ In cases where there are significant differences between contexts, close explana
223223

224224
### Examples
225225

226-
* In {{stack}} 9.1.0 and earlier, **Spaces** were referred to as **Places**.
227226

228227
::::{tab-set}
229-
:group: one-two-three
228+
:group: five-six-four-one-three
229+
230+
:::{tab-item} Unique features
231+
:sync: five
232+
233+
* Each space has its own saved objects.
234+
* 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.
235+
* In {{stack}} 9.0.0+, each space has its own navigation.
236+
237+
:::
238+
239+
:::{tab-item} Unique reqs / limits
240+
:sync: six
241+
242+
* In serverless, use `Admin` or equivalent
243+
* In {{stack}} 9.0.0+, use `kibana_admin` or equivalent
244+
245+
OR
246+
247+
The maximum number of spaces that you can have differs by [what do we call this]:
248+
249+
* In serverless, you can have a maximum of 100 spaces.
250+
* In {{stack}} 9.0.0+, the maximum is controlled by the `xpack.spaces.maxSpaces` setting. Default is 1000.
251+
:::
230252

231-
:::{tab-item} One
253+
:::{tab-item} Nice-to-know
254+
:sync: four
255+
256+
In {{stack}} 9.1.0 and earlier, **Spaces** were referred to as **Places**.
257+
258+
OR
259+
260+
If you're managing a {{stack}} v9 deployment, then you can also assign roles and define permissions for a space from the **Permissions** tab of the space settings.
261+
:::
262+
263+
:::{tab-item} Comparative overviews
232264
:sync: one
233265

234266
The way that TLS certificates are managed depends on your deployment type:
@@ -240,12 +272,7 @@ In {{eck}}, you can manage certificates for the HTTP layer. Certificates for the
240272
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.
241273
:::
242274

243-
:::{tab-item} Two
244-
:sync: two
245-
If you're managing a {{stack}} v9 deployment, then you can also assign roles and define permissions for a space from the **Permissions** tab of the space settings.
246-
:::
247-
248-
:::{tab-item} Three
275+
:::{tab-item} Comparative overviews II
249276
:sync: three
250277

251278
**Managed security in Elastic Cloud**
@@ -264,6 +291,7 @@ You can augment Elastic Cloud security features in the following ways:
264291
:::
265292
::::
266293

294+
267295
## Sibling pages
268296

269297
**Use case:**

0 commit comments

Comments
 (0)