More work on navigation

elastic · Mar 7, 2020 · 700933c · 700933c
1 parent be04b2a
commit 700933c
Show file tree

Hide file tree

Showing 77 changed files with 538 additions and 290 deletions.
diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -3,6 +3,10 @@
 
 [partintro]
 --
+++++
+<titleabbrev>Configuration</titleabbrev>
+++++
+
 Before modifying configuration settings, make sure you've completed the
 <<{beatname_lc}-configuration,configuration steps>> in the Getting Started.
 This section describes some common use cases for changing configuration options.
@@ -21,21 +25,16 @@ The following topics describe how to configure {beatname_uc}:
 
 * <<configuration-{beatname_lc}>>
 * <<configuration-general-options>>
-* <<{beatname_lc}-configuration-reloading>>
 * <<configuring-internal-queue>>
 * <<configuring-output>>
 * <<ilm>>
 * <<configuration-ssl>>
 * <<filtering-and-enhancing-data>>
-* <<configuring-ingest-node>>
-* <<{beatname_lc}-geoip>>
 * <<configuration-path>>
 * <<setup-kibana-endpoint>>
 * <<configuration-dashboards>>
 * <<configuration-template>>
 * <<configuration-logging>>
-* <<using-environ-vars>>
-* <<yaml-tips>>
 * <<regexp-support>>
 * <<http-endpoint>>
 * <<{beatname_lc}-reference-yml>>
@@ -49,8 +48,6 @@ include::./auditbeat-modules-config.asciidoc[]
 
 include::./auditbeat-general-options.asciidoc[]
 
-include::./reload-configuration.asciidoc[]
-
 include::{libbeat-dir}/queueconfig.asciidoc[]
 
 include::{libbeat-dir}/outputconfig.asciidoc[]
@@ -61,10 +58,6 @@ include::{libbeat-dir}/shared-ssl-config.asciidoc[]
 
 include::./auditbeat-filtering.asciidoc[]
 
-include::{libbeat-dir}/shared-config-ingest.asciidoc[]
-
-include::{libbeat-dir}/shared-geoip.asciidoc[]
-
 include::{libbeat-dir}/shared-path-config.asciidoc[]
 
 include::{libbeat-dir}/shared-kibana-config.asciidoc[]
@@ -73,14 +66,6 @@ include::{libbeat-dir}/setup-config.asciidoc[]
 
 include::{libbeat-dir}/loggingconfig.asciidoc[]
 
-:standalone:
-include::{libbeat-dir}/shared-env-vars.asciidoc[]
-:standalone!:
-
-:standalone:
-include::{libbeat-dir}/yaml.asciidoc[]
-:standalone!:
-
 include::{libbeat-dir}/regexp.asciidoc[]
 
 include::{libbeat-dir}/http-endpoint.asciidoc[]

diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -1,5 +1,9 @@
 [id="{beatname_lc}-getting-started"]
-== Getting started with {beatname_uc}
+== Get started with {beatname_uc}
+
+++++
+<titleabbrev>Get started</titleabbrev>
+++++
 
 include::{libbeat-dir}/shared-getting-started-intro.asciidoc[]
 

diff --git a/auditbeat/docs/howto/howto.asciidoc b/auditbeat/docs/howto/howto.asciidoc
@@ -0,0 +1,29 @@
+[[howto-guides]]
+= How to
+
+[partintro]
+--
+Learn how to perform common {beatname_uc} configuration tasks.
+
+* <<{beatname_lc}-geoip>>
+* <<using-environ-vars>>
+* <<configuring-ingest-node>>
+* <<yaml-tips>>
+
+
+--
+
+include::{libbeat-dir}/shared-geoip.asciidoc[]
+
+:standalone:
+include::{libbeat-dir}/shared-env-vars.asciidoc[]
+:standalone!:
+
+include::{libbeat-dir}/shared-config-ingest.asciidoc[]
+
+:standalone:
+include::{libbeat-dir}/yaml.asciidoc[]
+:standalone!:
+
+
+
diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -39,6 +39,8 @@ include::./upgrading.asciidoc[]
 
 include::./configuring-howto.asciidoc[]
 
+include::{docdir}/howto/howto.asciidoc[]
+
 include::./modules.asciidoc[]
 
 include::./fields.asciidoc[]

diff --git a/auditbeat/docs/setting-up-running.asciidoc b/auditbeat/docs/setting-up-running.asciidoc
@@ -5,7 +5,11 @@
 /////
 
 [[setting-up-and-running]]
-== Setting up and running {beatname_uc}
+== Set up and run {beatname_uc}
+
+++++
+<titleabbrev>Set up and run</titleabbrev>
+++++
 
 Before reading this section, see the
 <<{beatname_lc}-getting-started,getting started documentation>> for basic

diff --git a/auditbeat/docs/troubleshooting.asciidoc b/auditbeat/docs/troubleshooting.asciidoc
@@ -1,5 +1,5 @@
 [[troubleshooting]]
-= Troubleshooting
+= Troubleshoot
 
 [partintro]
 --

diff --git a/auditbeat/docs/upgrading.asciidoc b/auditbeat/docs/upgrading.asciidoc
@@ -1,7 +1,7 @@
 [[upgrading-auditbeat]]
-== Upgrading Auditbeat
+== Upgrade Auditbeat
 
 For information about upgrading to a new version, see the following topics in the _Beats Platform Reference_:
 
 * {beats-ref}/breaking-changes.html[Breaking Changes]
-* {beats-ref}/upgrading.html[Upgrading]
+* {beats-ref}/upgrading.html[Upgrade]
diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -3,6 +3,10 @@
 
 [partintro]
 --
+++++
+<titleabbrev>Configuration</titleabbrev>
+++++
+
 Before modifying configuration settings, make sure you've completed the
 <<filebeat-configuration,configuration steps>> in the Getting Started.
 This section describes some common use cases for changing configuration options.
@@ -24,12 +28,12 @@ The following topics describe how to configure Filebeat:
 * <<configuration-filebeat-options>>
 * <<configuring-output>>
 * <<configuration-ssl>>
-* <<configuration-autodiscover>>
 * <<ilm>>
-* <<configuration-template>>
-* <<configuration-dashboards>>
 * <<setup-kibana-endpoint>>
+* <<configuration-dashboards>>
+* <<configuration-template>>
 * <<filtering-and-enhancing-data>>
+* <<configuration-autodiscover>>
 * <<configuring-internal-queue>>
 * <<load-balancing>>
 * <<configuration-logging>>
@@ -49,10 +53,6 @@ include::{libbeat-dir}/outputconfig.asciidoc[]
 
 include::{libbeat-dir}/shared-ssl-config.asciidoc[]
 
-:autodiscoverJolokia:
-:autodiscoverHints:
-include::{libbeat-dir}/shared-autodiscover.asciidoc[]
-
 include::../../libbeat/docs/shared-ilm.asciidoc[]
 
 include::{libbeat-dir}/setup-config.asciidoc[]
@@ -61,6 +61,10 @@ include::{libbeat-dir}/shared-kibana-config.asciidoc[]
 
 include::./filebeat-filtering.asciidoc[]
 
+:autodiscoverJolokia:
+:autodiscoverHints:
+include::{libbeat-dir}/shared-autodiscover.asciidoc[]
+
 include::{libbeat-dir}/queueconfig.asciidoc[]
 
 include::./load-balancing.asciidoc[]

diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc
@@ -1,5 +1,9 @@
 [[filebeat-getting-started]]
-== Getting Started With Filebeat
+== Get started with {beatname_uc}
+
+++++
+<titleabbrev>Get started</titleabbrev>
+++++
 
 include::{libbeat-dir}/shared-getting-started-intro.asciidoc[]
 

diff --git a/filebeat/docs/howto/filebeat-howto.asciidoc → filebeat/docs/howto/howto.asciidoc b/filebeat/docs/howto/filebeat-howto.asciidoc → filebeat/docs/howto/howto.asciidoc
@@ -1,5 +1,5 @@
 [[howto-guides]]
-= How-to guides
+= How to
 
 [partintro]
 --

diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -46,7 +46,7 @@ include::./how-filebeat-works.asciidoc[]
 
 include::./configuring-howto.asciidoc[]
 
-include::{docdir}/howto/filebeat-howto.asciidoc[]
+include::{docdir}/howto/howto.asciidoc[]
 
 include::{libbeat-dir}/shared-central-management.asciidoc[]
 

diff --git a/filebeat/docs/modules-getting-started.asciidoc b/filebeat/docs/modules-getting-started.asciidoc
@@ -22,7 +22,7 @@ Can't find a module for your log file type? Follow the numbered steps under
 Before running {beatname_uc} modules:
 
 * Install and configure the Elastic stack. See
-{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
+{stack-gs}/get-started-elastic-stack.html[Get started with the {stack}].
 
 * Complete the {beatname_uc} installation instructions described in
 <<filebeat-installation>>. After installing {beatname_uc}, return to this

diff --git a/filebeat/docs/setting-up-running.asciidoc b/filebeat/docs/setting-up-running.asciidoc
@@ -5,7 +5,11 @@
 /////
 
 [[setting-up-and-running]]
-== Setting up and running {beatname_uc}
+== Set up and run {beatname_uc}
+
+++++
+<titleabbrev>Set up and run</titleabbrev>
+++++
 
 Before reading this section, see the
 <<{beatname_lc}-getting-started,getting started documentation>> for basic

diff --git a/filebeat/docs/troubleshooting.asciidoc b/filebeat/docs/troubleshooting.asciidoc
@@ -1,5 +1,5 @@
 [[troubleshooting]]
-= Troubleshooting
+= Troubleshoot
 
 [partintro]
 --

diff --git a/filebeat/docs/upgrading.asciidoc b/filebeat/docs/upgrading.asciidoc
@@ -1,7 +1,7 @@
 [[upgrading-filebeat]]
-== Upgrading Filebeat
+== Upgrade Filebeat
 
 For information about upgrading to a new version, see the following topics in the _Beats Platform Reference_:
 
 * {beats-ref}/breaking-changes.html[Breaking Changes]
-* {beats-ref}/upgrading.html[Upgrading]
+* {beats-ref}/upgrading.html[Upgrade]
diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc
@@ -3,6 +3,10 @@
 
 [partintro]
 --
+++++
+<titleabbrev>Configuration</titleabbrev>
+++++
+
 Before modifying configuration settings, make sure you've completed the
 <<heartbeat-configuration,configuration steps>> in the Getting Started.
 This section describes some common use cases for changing configuration options.
@@ -23,20 +27,16 @@ The following topics describe how to configure Heartbeat:
 
 * <<configuration-heartbeat-options>>
 * <<configuration-general-options>>
-* <<configuring-internal-queue>>
+* <<configuration-path>>
 * <<configuring-output>>
-* <<ilm>>
 * <<configuration-ssl>>
-* <<filtering-and-enhancing-data>>
-* <<configuring-ingest-node>>
-* <<{beatname_lc}-geoip>>
-* <<configuration-path>>
-* <<setup-kibana-endpoint>>
+* <<ilm>>
 * <<configuration-template>>
+* <<setup-kibana-endpoint>>
+* <<filtering-and-enhancing-data>>
+* <<configuring-internal-queue>>
 * <<configuration-logging>>
-* <<using-environ-vars>>
 * <<configuration-autodiscover>>
-* <<yaml-tips>>
 * <<regexp-support>>
 * <<http-endpoint>>
 * <<{beatname_lc}-reference-yml>>
@@ -47,44 +47,30 @@ include::./heartbeat-options.asciidoc[]
 
 include::./heartbeat-general-options.asciidoc[]
 
-include::./heartbeat-observer-options.asciidoc[]
-
-include::{libbeat-dir}/queueconfig.asciidoc[]
+include::{libbeat-dir}/shared-path-config.asciidoc[]
 
 include::{libbeat-dir}/outputconfig.asciidoc[]
 
-include::{libbeat-dir}/shared-ilm.asciidoc[]
-
 include::{libbeat-dir}/shared-ssl-config.asciidoc[]
 
-include::./heartbeat-filtering.asciidoc[]
-
-include::{libbeat-dir}/shared-config-ingest.asciidoc[]
-
-include::{libbeat-dir}/shared-geoip.asciidoc[]
+include::{libbeat-dir}/shared-ilm.asciidoc[]
 
-include::{libbeat-dir}/shared-path-config.asciidoc[]
+include::{libbeat-dir}/setup-config.asciidoc[]
 
 include::{libbeat-dir}/shared-kibana-config.asciidoc[]
 
-include::{libbeat-dir}/setup-config.asciidoc[]
+include::./heartbeat-filtering.asciidoc[]
 
-include::{libbeat-dir}/loggingconfig.asciidoc[]
+include::{libbeat-dir}/queueconfig.asciidoc[]
 
-:standalone:
-include::{libbeat-dir}/shared-env-vars.asciidoc[]
-:standalone!:
+include::{libbeat-dir}/loggingconfig.asciidoc[]
 
 :autodiscoverAWSELB:
 :autodiscoverHints:
 include::{libbeat-dir}/shared-autodiscover.asciidoc[]
 :autodiscoverHints!:
 :autodiscoverAWSELB!:
 
-:standalone:
-include::{libbeat-dir}/yaml.asciidoc[]
-:standalone!:
-
 include::{libbeat-dir}/regexp.asciidoc[]
 
 include::{libbeat-dir}/http-endpoint.asciidoc[]

diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc
@@ -1,5 +1,5 @@
 [[heartbeat-getting-started]]
-== Getting Started With Heartbeat
+== Get started With Heartbeat
 
 include::{libbeat-dir}/shared-getting-started-intro.asciidoc[]
 

diff --git a/heartbeat/docs/heartbeat-filtering.asciidoc b/heartbeat/docs/heartbeat-filtering.asciidoc
@@ -1,5 +1,9 @@
 [[filtering-and-enhancing-data]]
-== Filter and Enhance the exported data
+== Filter and enhance the exported data
+
+++++
+<titleabbrev>Processors</titleabbrev>
+++++
 
 include::{libbeat-dir}/processors.asciidoc[]
 

diff --git a/heartbeat/docs/heartbeat-observer-options.asciidoc b/heartbeat/docs/heartbeat-observer-options.asciidoc
@@ -1,5 +1,5 @@
 [[configuration-observer-options]]
-== Specify Observer and Geo Options
+== Add observer and geo metadata
 
 It is often useful to view and query various attributes of the instance Heartbeat is running on. This data is attached to events via the <<add-observer-metadata,`add_observer_metadata`>> processor. This processor populates the ECS `observer.*` fields. One field of particular utility is the `observer.geo.name` field, which you can configure via this processor. Use this field to create distinctive geographic regions for your uptime checks. You might label your regions by datacenter name or geographic region, e.g. `virginia-dc-1`, or `us-east-1a`, or `virginia-us`.
 

diff --git a/heartbeat/docs/heartbeat-options.asciidoc b/heartbeat/docs/heartbeat-options.asciidoc
@@ -1,8 +1,8 @@
 [[configuration-heartbeat-options]]
-== Set up {beatname_uc} monitors
+== Configure {beatname_uc} monitors
 
 ++++
-<titleabbrev>Set up monitors</titleabbrev>
+<titleabbrev>Monitors</titleabbrev>
 ++++
 
 To configure {beatname_uc} define a set of `monitors` to check your remote hosts.