Skip to content

Commit 2ce1591

Browse files
[Docs] Convert asciidoc lifecycle markers into new syntax (elastic#236292)
Preview/Beta/Deprecated information is handled using a specific syntax in markdown docs. This PR removes some outdated (asciidoc) markers and instead adds the expected syntax where appropriate. Rel: elastic/docs-content#2951 (cherry picked from commit 86e0a47)
1 parent c18ebeb commit 2ce1591

4 files changed

Lines changed: 19 additions & 17 deletions

File tree

docs/extend/ui-settings-service.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,11 @@ Configuration through the Advanced Settings UI is restricted to users authorised
3232

3333

3434
## Configuration with UI settings overrides [uisettings-overrides]
35+
```{applies_to}
36+
stack: preview
37+
```
3538

36-
[preview] When a setting is configured as an override in kibana.yml, it will override any other value stored in the config saved object. If an override is misconfigured, it will fail config validation and prevent Kibana from starting up. The override applies to Kibana as a whole for all spaces and users and the option will be disabled in the Advanced Settings page. We refer to these as "global" overrides.
39+
When a setting is configured as an override in kibana.yml, it will override any other value stored in the config saved object. If an override is misconfigured, it will fail config validation and prevent Kibana from starting up. The override applies to Kibana as a whole for all spaces and users and the option will be disabled in the Advanced Settings page. We refer to these as "global" overrides.
3740

3841
Use the top-level `uiSettings` key for this, for example:
3942

docs/reference/advanced-settings.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,15 +161,11 @@ $$$shortdots-enable$$$`shortDots:enable`
161161
$$$sort-options$$$`sort:options`
162162
: Options for the Elasticsearch [sort](elasticsearch://reference/elasticsearch/rest-apis/sort-search-results.md) parameter.
163163

164-
$$$state-storeinsessionstorage$$$`state:storeInSessionStorage`
165-
: [preview] Kibana tracks UI state in the URL, which can lead to problems when there is a lot of state information, and the URL gets very long. Enabling this setting stores part of the URL in your browser session to keep the URL short.
164+
$$$state-storeinsessionstorage$$$`state:storeInSessionStorage` {applies_to}`stack: preview`
165+
: Kibana tracks UI state in the URL, which can lead to problems when there is a lot of state information, and the URL gets very long. Enabling this setting stores part of the URL in your browser session to keep the URL short.
166166

167-
$$$theme-darkmode$$$`theme:darkMode`
168-
: :::{admonition} Deprecated in 9.0.0
169-
This setting was deprecated in 9.0.0.
170-
:::
171-
172-
The UI theme that the {{kib}} UI should use. Set to `enabled` or `disabled` to enable or disable the dark theme. Set to `system` to have the {{kib}} UI theme follow the system theme. You must refresh the page to apply the setting.
167+
$$$theme-darkmode$$$`theme:darkMode` {applies_to}`stack: deprecated 9.0`
168+
: The UI theme that the {{kib}} UI should use. Set to `enabled` or `disabled` to enable or disable the dark theme. Set to `system` to have the {{kib}} UI theme follow the system theme. You must refresh the page to apply the setting.
173169

174170
$$$theme-version$$$`theme:version`
175171
: Kibana only ships with the v8 theme now, so this setting can no longer be edited.
@@ -268,8 +264,8 @@ $$$discover-sample-size$$$`discover:sampleSize`
268264
$$$discover-searchonpageload$$$`discover:searchOnPageLoad`
269265
: Controls whether a search is executed when **Discover** first loads. This setting does not have an effect when loading a saved Discover session.
270266

271-
$$$discover:showFieldStatistics$$$`discover:showFieldStatistics`
272-
: [beta] Enables the Field statistics view. Examine details such as the minimum and maximum values of a numeric field or a map of a geo field.
267+
$$$discover:showFieldStatistics$$$`discover:showFieldStatistics` {applies_to}`stack: beta`
268+
: Enables the Field statistics view. Examine details such as the minimum and maximum values of a numeric field or a map of a geo field.
273269

274270
$$$discover:showMultiFields$$$`discover:showMultiFields`
275271
: Controls the display of multi-fields in the expanded document view.
@@ -355,8 +351,11 @@ $$$observability-apm-enable-profiling$$$`observability:apmEnableProfilingIntegra
355351
$$$observability-profiling-show-error-frames$$$`observability:profilingShowErrorFrames`
356352
: Show error frames in the Universal Profiling views to indicate stack unwinding failures.
357353

358-
$$$observability-apm-enable-table-search-bar$$$`observability:apmEnableTableSearchBar`
359-
: [beta] Enables faster searching in APM tables by adding a handy search bar with live filtering. Available for the following tables: Services, Transactions, and Errors.
354+
$$$observability-apm-enable-table-search-bar$$$`observability:apmEnableTableSearchBar` {applies_to}`stack: preview`
355+
: Enables faster searching in APM tables by adding a handy search bar with live filtering. Available for the following tables: Services, Transactions, and Errors.
356+
357+
$$$observability-apm-enable-service-inventory-table-search-bar$$$`observability:apmEnableServiceInventoryTableSearchBar` {applies_to}`stack: preview`
358+
: Enables faster searching in the APM Service inventory table by adding a handy search bar with live filtering.
360359

361360
$$$observability-enable-aws-lambda-metrics$$$`observability:enableAwsLambdaMetrics`
362361
: [preview] Display Amazon Lambda metrics in the service metrics tab.

docs/reference/cloud/elastic-cloud-kibana-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,8 @@ $$$csp-strict$$$ `csp.strict`
364364
`csp.warnLegacyBrowsers`
365365
: Shows a warning message after loading Kibana to any browser that does not enforce even rudimentary CSP rules, though Kibana is still accessible. This configuration is effectively ignored when [`csp.strict`](#csp-strict) is enabled. **Default: `true`**
366366

367-
`csp.disableUnsafeEval`
368-
: [preview] Set this to `true` to remove the [`unsafe-eval`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#unsafe_eval_expressions) source expression from the `script-src` directive. **Default: `false`**
367+
`csp.disableUnsafeEval` {applies_to}`stack: preview`
368+
: Set this to `true` to remove the [`unsafe-eval`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#unsafe_eval_expressions) source expression from the `script-src` directive. **Default: `false`**
369369

370370
By enabling `csp.disableUnsafeEval`, Kibana will use a custom version of the Handlebars template library which doesn’t support [inline partials](https://handlebarsjs.com/guide/partials.md#inline-partials). Handlebars is used in various locations in the Kibana frontend where custom templates can be supplied by the user when for instance setting up a visualisation. If you experience any issues rendering Handlebars templates after turning on `csp.disableUnsafeEval`, or if you rely on inline partials, please revert this setting to `false` and [open an issue](https://github.com/elastic/kibana/issues/new/choose) in the Kibana GitHub repository.
371371

docs/reference/configuration-reference/general-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,8 +321,8 @@ $$$server-compression$$$ `server.compression.enabled`
321321
`server.cors.allowCredentials`
322322
: Set to `true` to allow browser code to access response body whenever request performed with user credentials. **Default:** `false`. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
323323

324-
`server.cors.allowOrigin`
325-
: experimental::[] List of origins permitted to access resources. You must specify explicit hostnames and not use `server.cors.allowOrigin: ["*"]` when `server.cors.allowCredentials: true`. **Default:** ["*"]
324+
`server.cors.allowOrigin` {applies_to}`stack: preview`
325+
: List of origins permitted to access resources. You must specify explicit hostnames and not use `server.cors.allowOrigin: ["*"]` when `server.cors.allowCredentials: true`. **Default:** ["*"]
326326

327327
`server.compression.referrerWhitelist`
328328
: Specifies an array of trusted hostnames, such as the {{kib}} host, or a reverse proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request `Referer` header. This setting may not be used when [`server.compression.enabled`](#server-compression) is set to `false`. **Default: `none`**

0 commit comments

Comments
 (0)