Skip to content

Commit

Permalink
[DOCS] Replace description attributes with frontmatter for migration (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored May 24, 2023
1 parent 3a4f5ec commit 668968b
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 27 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
[[maintenance-windows]]
== Maintenance windows
:description: Maintenance windows enable you to suppress rule notifications.
:tags-products: [kibana, alerting]
:tags-content-type: [overview]
:tags-user-goals: [manage]

:frontmatter-description: Maintenance windows enable you to suppress rule notifications.
:frontmatter-tags-products: [kibana, alerting]
:frontmatter-tags-content-type: [overview]
:frontmatter-tags-user-goals: [manage]

preview::[]

Expand Down
5 changes: 3 additions & 2 deletions docs/management/manage-data-views.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[[managing-data-views]]
== Manage data views
:keywords: administrator, data view, data views, management, runtime fields, runtime fields in Kibana, scripted fields, field formatters, data fields, index pattern, index patterns
:description: Conceptual and step-by-step procedures for using runtime fields, scripted fields, and field formatters.

:frontmatter-description: Conceptual and step-by-step procedures for using runtime fields, scripted fields, and field formatters.
:frontmatter-tags-products: [kibana]

To customize the data fields in your data view,
you can add runtime fields to the existing documents,
Expand Down
8 changes: 4 additions & 4 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<titleabbrev>Alerting and action settings</titleabbrev>
++++

:description: Learn about the settings that affect {kib} {alert-features}.
:tags-products: [kibana, alerting]
:tags-content-type: [reference]
:tags-user-goals: [configure]
:frontmatter-description: Learn about the settings that affect {kib} {alert-features}.
:frontmatter-tags-products: [kibana, alerting]
:frontmatter-tags-content-type: [reference]
:frontmatter-tags-user-goals: [configure]

Alerting and actions are enabled by default in {kib}, but require you to configure the following:

Expand Down
7 changes: 5 additions & 2 deletions docs/settings/reporting-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@
++++
<titleabbrev>Reporting settings</titleabbrev>
++++
:keywords: administrator, reference, setup, reporting
:description: A reference of the reporting settings administrators configure in kibana.yml.

:frontmatter-description: A reference of the reporting settings administrators configure in kibana.yml.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [reference]
:frontmatter-tags-user-goals: [configure]

You can configure `xpack.reporting` settings in your `kibana.yml` to:

Expand Down
8 changes: 4 additions & 4 deletions docs/user/dashboard/make-dashboards-interactive.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
[[drilldowns]]
== Make dashboards interactive

:keywords: administrator, analyst, concept, task, analyze, dashboard, controls, range slider, options list, author, drilldowns
:description: Add interactive capabilities to your dashboard, such as controls that allow \
you to apply dashboard-level filters, and drilldowns that allow you to navigate to other \
dashboards and external websites.
:frontmatter-description: Add interactive filter and navigation capabilities to your dashboard.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [analyze, visualize]

Add interactive capabilities to your dashboard, such as interactive filter controls, and drilldowns that allow you to navigate to *Discover*, other dashboards, and external websites.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
++++
<titleabbrev>Reporting</titleabbrev>
++++
:keywords: administrator, analyst, concept, setup, reporting
:description: Consider the production components that are used to generate reports.

:frontmatter-description: Consider the production components that are used to generate reports.
:frontmatter-tags-products: [kibana]

To generate reports, {kib} uses the Chromium web browser, which runs on the server in headless mode. Chromium is an open-source project not related to Elastic, and is embedded into {kib}. Chromium may require additional OS dependencies to run properly.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
++++
<titleabbrev>Security</titleabbrev>
++++
:keywords: administrator, analyst, concept, setup, security
:description: Consider the production components for {kib} security.

:frontmatter-description: Consider the production components for {kib} security.
:frontmatter-tags-products: [kibana]

To secure your {kib} installation in production, consider these high-priority topics to ensure
that only authorized users can access {kib}.
Expand Down
6 changes: 2 additions & 4 deletions docs/user/reporting/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
[role="xpack"]
[[reporting-getting-started]]
= Reporting and sharing

[partintro]

--

:keywords: analyst, concept, task, reporting
:description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website.
:frontmatter-description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website.
:frontmatter-tags-products: [kibana]

{kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads.

Expand Down
6 changes: 3 additions & 3 deletions docs/user/security/authentication/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[role="xpack"]
[[kibana-authentication]]
=== Authentication in {kib}
++++
<titleabbrev>Authentication</titleabbrev>
++++
:keywords: administrator, concept, security, authentication
:description: A list of the supported authentication mechanisms in {kib}.

:frontmatter-description: A list of the supported authentication mechanisms in {kib}.
:frontmatter-tags-products: [kibana]

{kib} supports the following authentication mechanisms:

Expand Down

0 comments on commit 668968b

Please sign in to comment.