Fix issues from todo list

elastic · Mar 9, 2020 · 0d54ed9 · 0d54ed9
1 parent 700933c
commit 0d54ed9
Show file tree

Hide file tree

Showing 33 changed files with 143 additions and 110 deletions.
diff --git a/auditbeat/docs/auditbeat-general-options.asciidoc b/auditbeat/docs/auditbeat-general-options.asciidoc
@@ -1,5 +1,9 @@
 [[configuration-general-options]]
-== Specify general settings
+== Configure general settings
+
+++++
+<titleabbrev>General settings</titleabbrev>
+++++
 
 You can specify settings in the +{beatname_lc}.yml+ config file to control the
 general behavior of {beatname_uc}.

diff --git a/auditbeat/docs/auditbeat-modules-config.asciidoc b/auditbeat/docs/auditbeat-modules-config.asciidoc
@@ -1,5 +1,5 @@
 [id="configuration-{beatname_lc}"]
-== Specify which modules to run
+== Configure modules
 
 ++++
 <titleabbrev>Modules</titleabbrev>

diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -1,10 +1,10 @@
 [id="configuring-howto-{beatname_lc}"]
-= {beatname_uc} configuration
+= Configure {beatname_uc}
 
 [partintro]
 --
 ++++
-<titleabbrev>Configuration</titleabbrev>
+<titleabbrev>Configure</titleabbrev>
 ++++
 
 Before modifying configuration settings, make sure you've completed the
@@ -25,18 +25,19 @@ The following topics describe how to configure {beatname_uc}:
 
 * <<configuration-{beatname_lc}>>
 * <<configuration-general-options>>
-* <<configuring-internal-queue>>
+* <<configuration-path>>
+* <<auditbeat-configuration-reloading>>
 * <<configuring-output>>
-* <<ilm>>
 * <<configuration-ssl>>
-* <<filtering-and-enhancing-data>>
-* <<configuration-path>>
+* <<ilm>>
+* <<configuration-template>>
 * <<setup-kibana-endpoint>>
 * <<configuration-dashboards>>
-* <<configuration-template>>
+* <<filtering-and-enhancing-data>>
+* <<configuring-internal-queue>>
 * <<configuration-logging>>
-* <<regexp-support>>
 * <<http-endpoint>>
+* <<regexp-support>>
 * <<{beatname_lc}-reference-yml>>
 
 After changing configuration settings, you need to restart {beatname_uc} to
@@ -48,26 +49,26 @@ include::./auditbeat-modules-config.asciidoc[]
 
 include::./auditbeat-general-options.asciidoc[]
 
-include::{libbeat-dir}/queueconfig.asciidoc[]
+include::{libbeat-dir}/shared-path-config.asciidoc[]
 
-include::{libbeat-dir}/outputconfig.asciidoc[]
+include::./reload-configuration.asciidoc[]
 
-include::{libbeat-dir}/shared-ilm.asciidoc[]
+include::{libbeat-dir}/outputconfig.asciidoc[]
 
 include::{libbeat-dir}/shared-ssl-config.asciidoc[]
 
-include::./auditbeat-filtering.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::./auditbeat-filtering.asciidoc[]
 
-include::{libbeat-dir}/setup-config.asciidoc[]
+include::{libbeat-dir}/queueconfig.asciidoc[]
 
 include::{libbeat-dir}/loggingconfig.asciidoc[]
 
-include::{libbeat-dir}/regexp.asciidoc[]
-
 include::{libbeat-dir}/http-endpoint.asciidoc[]
 
+include::{libbeat-dir}/regexp.asciidoc[]
+
 include::{libbeat-dir}/reference-yml.asciidoc[]
diff --git a/auditbeat/docs/reload-configuration.asciidoc b/auditbeat/docs/reload-configuration.asciidoc
@@ -2,7 +2,7 @@
 == Reload the configuration dynamically
 
 ++++
-<titleabbrev>Config Reloading</titleabbrev>
+<titleabbrev>Config file reloading</titleabbrev>
 ++++
 
 beta[]

diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -1,10 +1,10 @@
 [[configuring-howto-filebeat]]
-= {beatname_uc} configuration
+= Configure {beatname_uc}
 
 [partintro]
 --
 ++++
-<titleabbrev>Configuration</titleabbrev>
+<titleabbrev>Configure</titleabbrev>
 ++++
 
 Before modifying configuration settings, make sure you've completed the
@@ -23,15 +23,16 @@ _Beats Platform Reference_ for more about the structure of the config file.
 
 The following topics describe how to configure Filebeat:
 
+* <<configuration-filebeat-options>>
 * <<configuration-general-options>>
 * <<configuration-path>>
-* <<configuration-filebeat-options>>
+* <<filebeat-configuration-reloading>>
 * <<configuring-output>>
 * <<configuration-ssl>>
 * <<ilm>>
+* <<configuration-template>>
 * <<setup-kibana-endpoint>>
 * <<configuration-dashboards>>
-* <<configuration-template>>
 * <<filtering-and-enhancing-data>>
 * <<configuration-autodiscover>>
 * <<configuring-internal-queue>>
@@ -43,11 +44,13 @@ The following topics describe how to configure Filebeat:
 
 --
 
+include::./filebeat-options.asciidoc[]
+
 include::./filebeat-general-options.asciidoc[]
 
 include::{libbeat-dir}/shared-path-config.asciidoc[]
 
-include::./filebeat-options.asciidoc[]
+include::./reload-configuration.asciidoc[]
 
 include::{libbeat-dir}/outputconfig.asciidoc[]
 
@@ -57,8 +60,6 @@ include::../../libbeat/docs/shared-ilm.asciidoc[]
 
 include::{libbeat-dir}/setup-config.asciidoc[]
 
-include::{libbeat-dir}/shared-kibana-config.asciidoc[]
-
 include::./filebeat-filtering.asciidoc[]
 
 :autodiscoverJolokia:

diff --git a/filebeat/docs/filebeat-general-options.asciidoc b/filebeat/docs/filebeat-general-options.asciidoc
@@ -1,5 +1,9 @@
 [[configuration-general-options]]
-== Specify general settings
+== Configure general settings
+
+++++
+<titleabbrev>General settings</titleabbrev>
+++++
 
 You can specify settings in the +{beatname_lc}.yml+ config file to control the
 general behavior of {beatname_uc}. This includes:

diff --git a/filebeat/docs/filebeat-modules-options.asciidoc b/filebeat/docs/filebeat-modules-options.asciidoc
@@ -131,7 +131,7 @@ appropriate for your environment. To change the default configurations, you need
 to <<specify-variable-settings,specify variable settings>>.
 
 [[specify-variable-settings]]
-=== Specify variable settings
+=== Configure variable settings
 
 include::./include/set-paths.asciidoc[]
 

diff --git a/filebeat/docs/howto/howto.asciidoc b/filebeat/docs/howto/howto.asciidoc
@@ -8,7 +8,6 @@ Learn how to perform common {beatname_uc} configuration tasks.
 * <<configuration-filebeat-options>>
 * <<{beatname_lc}-geoip>>
 * <<{beatname_lc}-deduplication>>
-* <<filebeat-configuration-reloading>>
 * <<using-environ-vars>>
 * <<configuring-ingest-node>>
 * <<yaml-tips>>
@@ -22,8 +21,6 @@ include::{libbeat-dir}/shared-geoip.asciidoc[]
 
 include::{libbeat-dir}/shared-deduplication.asciidoc[]
 
-include::{docdir}/../docs/reload-configuration.asciidoc[]
-
 :standalone:
 include::{libbeat-dir}/shared-env-vars.asciidoc[]
 :standalone!:

diff --git a/filebeat/docs/reload-configuration.asciidoc b/filebeat/docs/reload-configuration.asciidoc
@@ -1,6 +1,10 @@
 [[filebeat-configuration-reloading]]
 == Load external configuration files
 
+++++
+<titleabbrev>Config file loading</titleabbrev>
+++++
+
 {beatname_uc} can load external configuration files for inputs and modules,
 allowing you to separate your configuration into multiple smaller
 configuration files. See the <<load-input-config>> and the

diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc
@@ -1,10 +1,10 @@
 [[configuring-howto-heartbeat]]
-= {beatname_uc} configuration
+= Configure {beatname_uc}
 
 [partintro]
 --
 ++++
-<titleabbrev>Configuration</titleabbrev>
+<titleabbrev>Configure</titleabbrev>
 ++++
 
 Before modifying configuration settings, make sure you've completed the
@@ -32,13 +32,12 @@ The following topics describe how to configure Heartbeat:
 * <<configuration-ssl>>
 * <<ilm>>
 * <<configuration-template>>
-* <<setup-kibana-endpoint>>
 * <<filtering-and-enhancing-data>>
+* <<configuration-autodiscover>>
 * <<configuring-internal-queue>>
 * <<configuration-logging>>
-* <<configuration-autodiscover>>
-* <<regexp-support>>
 * <<http-endpoint>>
+* <<regexp-support>>
 * <<{beatname_lc}-reference-yml>>
 
 --
@@ -57,22 +56,20 @@ include::{libbeat-dir}/shared-ilm.asciidoc[]
 
 include::{libbeat-dir}/setup-config.asciidoc[]
 
-include::{libbeat-dir}/shared-kibana-config.asciidoc[]
-
 include::./heartbeat-filtering.asciidoc[]
 
-include::{libbeat-dir}/queueconfig.asciidoc[]
-
-include::{libbeat-dir}/loggingconfig.asciidoc[]
-
 :autodiscoverAWSELB:
 :autodiscoverHints:
 include::{libbeat-dir}/shared-autodiscover.asciidoc[]
 :autodiscoverHints!:
 :autodiscoverAWSELB!:
 
-include::{libbeat-dir}/regexp.asciidoc[]
+include::{libbeat-dir}/queueconfig.asciidoc[]
+
+include::{libbeat-dir}/loggingconfig.asciidoc[]
 
 include::{libbeat-dir}/http-endpoint.asciidoc[]
 
+include::{libbeat-dir}/regexp.asciidoc[]
+
 include::{libbeat-dir}/reference-yml.asciidoc[]
diff --git a/heartbeat/docs/heartbeat-general-options.asciidoc b/heartbeat/docs/heartbeat-general-options.asciidoc
@@ -1,5 +1,9 @@
 [[configuration-general-options]]
-== Specify general settings
+== Configure general settings
+
+++++
+<titleabbrev>General settings</titleabbrev>
+++++
 
 You can specify settings in the +{beatname_lc}.yml+ config file to control the
 general behavior of {beatname_uc}.

diff --git a/journalbeat/docs/configuring-howto.asciidoc b/journalbeat/docs/configuring-howto.asciidoc
@@ -1,10 +1,10 @@
 [id="configuring-howto-{beatname_lc}"]
-= {beatname_uc} configuration
+= Configure {beatname_uc}
 
 [partintro]
 --
 ++++
-<titleabbrev>Configuration</titleabbrev>
+<titleabbrev>Configure</titleabbrev>
 ++++
 
 Before modifying configuration settings, make sure you've completed the
@@ -15,14 +15,13 @@ include::{libbeat-dir}/shared-configuring.asciidoc[]
 
 The following topics describe how to configure {beatname_uc}:
 
+* <<configuration-{beatname_lc}-options>>
 * <<configuration-general-options>>
 * <<configuration-path>>
-* <<configuration-{beatname_lc}-options>>
 * <<configuring-output>>
 * <<configuration-ssl>>
 * <<ilm>>
 * <<configuration-template>>
-* <<setup-kibana-endpoint>>
 * <<filtering-and-enhancing-data>>
 * <<configuring-internal-queue>>
 * <<configuration-logging>>
@@ -32,12 +31,12 @@ The following topics describe how to configure {beatname_uc}:
 
 --
 
+include::./config-options.asciidoc[]
+
 include::./general-options.asciidoc[]
 
 include::{libbeat-dir}/shared-path-config.asciidoc[]
 
-include::./config-options.asciidoc[]
-
 include::{libbeat-dir}/outputconfig.asciidoc[]
 
 include::{libbeat-dir}/shared-ssl-config.asciidoc[]
@@ -46,8 +45,6 @@ include::{libbeat-dir}/shared-ilm.asciidoc[]
 
 include::{libbeat-dir}/setup-config.asciidoc[]
 
-include::{libbeat-dir}/shared-kibana-config.asciidoc[]
-
 include::./filtering.asciidoc[]
 
 include::{libbeat-dir}/queueconfig.asciidoc[]

diff --git a/journalbeat/docs/general-options.asciidoc b/journalbeat/docs/general-options.asciidoc
@@ -1,5 +1,9 @@
 [[configuration-general-options]]
-== Specify general settings
+== Configure general settings
+
+++++
+<titleabbrev>General settings</titleabbrev>
+++++
 
 You can specify settings in the +{beatname_lc}.yml+ config file to control the
 general behavior of {beatname_uc}. This includes:

diff --git a/libbeat/docs/dashboardsconfig.asciidoc b/libbeat/docs/dashboardsconfig.asciidoc
@@ -10,7 +10,7 @@
 //////////////////////////////////////////////////////////////////////////
 
 [[configuration-dashboards]]
-== Set up Kibana dashboards
+== Configure Kibana dashboard loading
 
 ++++
 <titleabbrev>Kibana dashboards</titleabbrev>

diff --git a/libbeat/docs/generalconfig.asciidoc b/libbeat/docs/generalconfig.asciidoc
@@ -15,7 +15,7 @@
 === General configuration options
 
 ++++
-<titleabbrev>General</titleabbrev>
+<titleabbrev>General settings</titleabbrev>
 ++++
 
 These options are supported by all Elastic Beats. Because they are common

diff --git a/libbeat/docs/http-endpoint.asciidoc b/libbeat/docs/http-endpoint.asciidoc
@@ -10,7 +10,11 @@
 //////////////////////////////////////////////////////////////////////////
 
 [[http-endpoint]]
-== HTTP Endpoint
+== Configure an HTTP endpoint for metrics
+
+++++
+<titleabbrev>HTTP endpoint</titleabbrev>
+++++
 
 experimental[]
 

diff --git a/libbeat/docs/monitoring/monitoring-metricbeat.asciidoc b/libbeat/docs/monitoring/monitoring-metricbeat.asciidoc
@@ -123,7 +123,7 @@ metricbeat modules enable beat-xpack
 ----------------------------------------------------------------------
 
 For more information, see 
-{metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and 
+{metricbeat-ref}/configuration-metricbeat.html[Configure modules] and 
 {metricbeat-ref}/metricbeat-module-beat.html[beat module]. 
 // end::enable-beat-module[]
 --

diff --git a/libbeat/docs/setup-config.asciidoc b/libbeat/docs/setup-config.asciidoc
@@ -2,6 +2,8 @@
 include::./template-config.asciidoc[]
 
 ifndef::no_dashboards[]
+include::./shared-kibana-config.asciidoc[]
+
 include::./dashboardsconfig.asciidoc[]
 endif::no_dashboards[]
 
diff --git a/libbeat/docs/shared-deduplication.asciidoc b/libbeat/docs/shared-deduplication.asciidoc
@@ -1,5 +1,5 @@
 [id="{beatname_lc}-deduplication"]
-== Data deduplication
+== Deduplicate data
 
 The {beats} framework guarantees at-least-once delivery to ensure that no data
 is lost when events are sent to outputs that support acknowledgement, such as
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     == Reload the configuration dynamically
     ++++
-    <titleabbrev>Config Reloading</titleabbrev>
+    <titleabbrev>Config file reloading</titleabbrev>
     ++++
     beta[]
@@ Expand Down @@