[Docs] Use attribute to resolve libbeat paths (elastic#9979)

leweafan · Jan 22, 2019 · 8c56735 · 8c56735
1 parent 927c6b8
commit 8c56735
Show file tree

Hide file tree

Showing 78 changed files with 335 additions and 316 deletions.
diff --git a/auditbeat/docs/auditbeat-filtering.asciidoc b/auditbeat/docs/auditbeat-filtering.asciidoc
@@ -1,6 +1,6 @@
 [[filtering-and-enhancing-data]]
 == Filter and enhance the exported data
 
-include::../../libbeat/docs/processors.asciidoc[]
+include::{libbeat-dir}/docs/processors.asciidoc[]
 
-include::../../libbeat/docs/processors-using.asciidoc[]
+include::{libbeat-dir}/docs/processors-using.asciidoc[]
diff --git a/auditbeat/docs/auditbeat-general-options.asciidoc b/auditbeat/docs/auditbeat-general-options.asciidoc
@@ -4,4 +4,4 @@
 You can specify settings in the +{beatname_lc}.yml+ config file to control the
 general behavior of {beatname_uc}.
 
-include::../../libbeat/docs/generalconfig.asciidoc[]
+include::{libbeat-dir}/docs/generalconfig.asciidoc[]
diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -49,34 +49,34 @@ include::./auditbeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-include::../../libbeat/docs/queueconfig.asciidoc[]
+include::{libbeat-dir}/docs/queueconfig.asciidoc[]
 
-include::../../libbeat/docs/outputconfig.asciidoc[]
+include::{libbeat-dir}/docs/outputconfig.asciidoc[]
 
-include::../../libbeat/docs/shared-ssl-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[]
 
 include::./auditbeat-filtering.asciidoc[]
 
-include::../../libbeat/docs/shared-config-ingest.asciidoc[]
+include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[]
 
-include::../../libbeat/docs/shared-path-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-path-config.asciidoc[]
 
-include::../../libbeat/docs/shared-kibana-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[]
 
-include::../../libbeat/docs/setup-config.asciidoc[]
+include::{libbeat-dir}/docs/setup-config.asciidoc[]
 
-include::../../libbeat/docs/loggingconfig.asciidoc[]
+include::{libbeat-dir}/docs/loggingconfig.asciidoc[]
 
 :standalone:
-include::../../libbeat/docs/shared-env-vars.asciidoc[]
+include::{libbeat-dir}/docs/shared-env-vars.asciidoc[]
 :standalone!:
 
 :standalone:
-include::../../libbeat/docs/yaml.asciidoc[]
+include::{libbeat-dir}/docs/yaml.asciidoc[]
 :standalone!:
 
-include::../../libbeat/docs/regexp.asciidoc[]
+include::{libbeat-dir}/docs/regexp.asciidoc[]
 
-include::../../libbeat/docs/http-endpoint.asciidoc[]
+include::{libbeat-dir}/docs/http-endpoint.asciidoc[]
 
-include::../../libbeat/docs/reference-yml.asciidoc[]
+include::{libbeat-dir}/docs/reference-yml.asciidoc[]
diff --git a/auditbeat/docs/faq.asciidoc b/auditbeat/docs/faq.asciidoc
@@ -7,6 +7,6 @@ https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum]
 
 include::./faq-ulimit.asciidoc[]
 
-include::../../libbeat/docs/faq-limit-bandwidth.asciidoc[]
+include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[]
 
-include::../../libbeat/docs/shared-faq.asciidoc[]
+include::{libbeat-dir}/docs/shared-faq.asciidoc[]
diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -1,7 +1,7 @@
 [id="{beatname_lc}-getting-started"]
 == Getting started with {beatname_uc}
 
-include::../../libbeat/docs/shared-getting-started-intro.asciidoc[]
+include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[]
 
 * <<{beatname_lc}-installation>>
 * <<{beatname_lc}-configuration>>
@@ -16,7 +16,7 @@ include::../../libbeat/docs/shared-getting-started-intro.asciidoc[]
 
 Install {beatname_uc} on all the servers you want to monitor.
 
-include::../../libbeat/docs/shared-download-and-install.asciidoc[]
+include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[]
 
 [[deb]]
 *deb:*
@@ -160,7 +160,7 @@ For more information about these options, see
 [id="{beatname_lc}-configuration"]
 === Step 2: Configure {beatname_uc}
 
-include::../../libbeat/docs/shared-configuring.asciidoc[]
+include::{libbeat-dir}/docs/shared-configuring.asciidoc[]
 
 To configure {beatname_uc}:
 
@@ -190,25 +190,25 @@ If you accept the default configuration without specifying additional modules,
 +
 See <<configuring-howto-{beatname_lc}>> for more details about configuring modules.
 
-include::../../libbeat/docs/step-configure-output.asciidoc[]
+include::{libbeat-dir}/docs/step-configure-output.asciidoc[]
 
-include::../../libbeat/docs/step-configure-kibana-endpoint.asciidoc[]
+include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[]
 
-include::../../libbeat/docs/step-configure-credentials.asciidoc[]
+include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[]
 
-include::../../libbeat/docs/step-test-config.asciidoc[]
+include::{libbeat-dir}/docs/step-test-config.asciidoc[]
 
-include::../../libbeat/docs/step-look-at-config.asciidoc[]
+include::{libbeat-dir}/docs/step-look-at-config.asciidoc[]
 
 [id="{beatname_lc}-template"]
 === Step 3: Load the index template in {es}
 
-include::../../libbeat/docs/shared-template-load.asciidoc[]
+include::{libbeat-dir}/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the {kib} dashboards
 
-include::../../libbeat/docs/dashboards.asciidoc[]
+include::{libbeat-dir}/docs/dashboards.asciidoc[]
 
 [id="{beatname_lc}-starting"]
 === Step 5: Start {beatname_uc}
@@ -276,7 +276,7 @@ To make it easier for you to start auditing the activities of users and
 processes on your system, we have created example {beatname_uc} dashboards.
 You loaded the dashboards earlier when you ran the `setup` command.
 
-include::../../libbeat/docs/opendashboards.asciidoc[]
+include::{libbeat-dir}/docs/opendashboards.asciidoc[]
 
 The dashboards are provided as examples. We recommend that you
 {kibana-ref}/dashboard.html[customize] them to meet your needs.

diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -1,6 +1,8 @@
 = Auditbeat Reference
 
-include::../../libbeat/docs/version.asciidoc[]
+:libbeat-dir: ../../libbeat
+
+include::{libbeat-dir}/docs/version.asciidoc[]
 
 include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 
@@ -19,13 +21,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :win_os:
 :linux_os:
 
-include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
+include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]
 
 include::./overview.asciidoc[]
 
 include::./getting-started.asciidoc[]
 
-include::../../libbeat/docs/repositories.asciidoc[]
+include::{libbeat-dir}/docs/repositories.asciidoc[]
 
 include::./breaking.asciidoc[]
 
@@ -37,13 +39,13 @@ include::./modules.asciidoc[]
 
 include::./fields.asciidoc[]
 
-include::../../libbeat/docs/monitoring/monitoring-beats.asciidoc[]
+include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[]
 
-include::../../libbeat/docs/shared-securing-beat.asciidoc[]
+include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[]
 
 include::./troubleshooting.asciidoc[]
 
 include::./faq.asciidoc[]
 
-include::../../libbeat/docs/contributing-to-beats.asciidoc[]
+include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[]
 
diff --git a/auditbeat/docs/overview.asciidoc b/auditbeat/docs/overview.asciidoc
@@ -11,3 +11,5 @@ can use {beatname_uc} to collect and centralize audit events from the Linux
 Audit Framework. You can also use {beatname_uc} to detect changes to critical
 files, like binaries and configuration files, and identify potential security
 policy violations.
+
+include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[]
diff --git a/auditbeat/docs/running-on-docker.asciidoc b/auditbeat/docs/running-on-docker.asciidoc
@@ -1,4 +1,4 @@
-include::../../libbeat/docs/shared-docker.asciidoc[]
+include::{libbeat-dir}/docs/shared-docker.asciidoc[]
 
 ==== Special requirements
 

diff --git a/auditbeat/docs/setting-up-running.asciidoc b/auditbeat/docs/setting-up-running.asciidoc
@@ -23,12 +23,12 @@ This section includes additional information on how to set up and run
 
 //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too.
 
-include::../../libbeat/docs/shared-directory-layout.asciidoc[]
+include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[]
 
-include::../../libbeat/docs/keystore.asciidoc[]
+include::{libbeat-dir}/docs/keystore.asciidoc[]
 
-include::../../libbeat/docs/command-reference.asciidoc[]
+include::{libbeat-dir}/docs/command-reference.asciidoc[]
 
 include::./running-on-docker.asciidoc[]
 
-include::../../libbeat/docs/shared-shutdown.asciidoc[]
+include::{libbeat-dir}/docs/shared-shutdown.asciidoc[]
diff --git a/auditbeat/docs/troubleshooting.asciidoc b/auditbeat/docs/troubleshooting.asciidoc
@@ -17,14 +17,14 @@ following tips:
 [[getting-help]]
 == Get Help
 
-include::../../libbeat/docs/getting-help.asciidoc[]
+include::{libbeat-dir}/docs/getting-help.asciidoc[]
 
 //sets block macro for debugging.asciidoc included in next section
 
 [id="enable-{beatname_lc}-debugging"]
 == Debug
 
-include::../../libbeat/docs/debugging.asciidoc[]
+include::{libbeat-dir}/docs/debugging.asciidoc[]
 
 
 
diff --git a/docs/devguide/index.asciidoc b/docs/devguide/index.asciidoc
@@ -1,19 +1,21 @@
 [[beats-reference]]
 = Beats Developer Guide
 
-include::../../libbeat/docs/version.asciidoc[]
+:libbeat-dir: ../../libbeat
+
+include::{libbeat-dir}/docs/version.asciidoc[]
 
 :dev-guide: true
 :beatname_lc: beatname
 :beatname_uc: a Beat
 
 include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 
-include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
+include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]
 
 include::./contributing.asciidoc[]
 
-include::../../libbeat/docs/communitybeats.asciidoc[]
+include::{libbeat-dir}/docs/communitybeats.asciidoc[]
 
 include::./newbeat.asciidoc[]
 

diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -57,40 +57,40 @@ include::./filebeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-include::../../libbeat/docs/queueconfig.asciidoc[]
+include::{libbeat-dir}/docs/queueconfig.asciidoc[]
 
-include::../../libbeat/docs/outputconfig.asciidoc[]
+include::{libbeat-dir}/docs/outputconfig.asciidoc[]
 
 include::./load-balancing.asciidoc[]
 
-include::../../libbeat/docs/shared-ssl-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[]
 
 include::./filebeat-filtering.asciidoc[]
 
-include::../../libbeat/docs/shared-config-ingest.asciidoc[]
+include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[]
 
-include::../../libbeat/docs/shared-path-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-path-config.asciidoc[]
 
-include::../../libbeat/docs/shared-kibana-config.asciidoc[]
+include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[]
 
-include::../../libbeat/docs/setup-config.asciidoc[]
+include::{libbeat-dir}/docs/setup-config.asciidoc[]
 
-include::../../libbeat/docs/loggingconfig.asciidoc[]
+include::{libbeat-dir}/docs/loggingconfig.asciidoc[]
 
 :standalone:
-include::../../libbeat/docs/shared-env-vars.asciidoc[]
+include::{libbeat-dir}/docs/shared-env-vars.asciidoc[]
 :standalone!:
 
 :autodiscoverJolokia:
 :autodiscoverHints:
-include::../../libbeat/docs/shared-autodiscover.asciidoc[]
+include::{libbeat-dir}/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-include::../../libbeat/docs/yaml.asciidoc[]
+include::{libbeat-dir}/docs/yaml.asciidoc[]
 :standalone!:
 
-include::../../libbeat/docs/regexp.asciidoc[]
+include::{libbeat-dir}/docs/regexp.asciidoc[]
 
-include::../../libbeat/docs/http-endpoint.asciidoc[]
+include::{libbeat-dir}/docs/http-endpoint.asciidoc[]
 
-include::../../libbeat/docs/reference-yml.asciidoc[]
+include::{libbeat-dir}/docs/reference-yml.asciidoc[]
diff --git a/filebeat/docs/faq.asciidoc b/filebeat/docs/faq.asciidoc
@@ -130,5 +130,5 @@ reached EOF or not. Note that this option can lead to data loss if the file is
 deleted before {beatname_uc} reaches the end of the file.
 
 
-include::../../libbeat/docs/faq-limit-bandwidth.asciidoc[]
-include::../../libbeat/docs/shared-faq.asciidoc[]
+include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[]
+include::{libbeat-dir}/docs/shared-faq.asciidoc[]
diff --git a/filebeat/docs/filebeat-filtering.asciidoc b/filebeat/docs/filebeat-filtering.asciidoc
@@ -22,7 +22,7 @@ global processing across all data exported by {beatname_uc}.
 [[using-processors]]
 === Processors
 
-include::../../libbeat/docs/processors.asciidoc[]
+include::{libbeat-dir}/docs/processors.asciidoc[]
 
 [float]
 [[drop-event-example]]
@@ -103,4 +103,4 @@ The resulting output looks something like this:
 }
 -----------------------------------------------------
 
-include::../../libbeat/docs/processors-using.asciidoc[]
+include::{libbeat-dir}/docs/processors-using.asciidoc[]
diff --git a/filebeat/docs/filebeat-general-options.asciidoc b/filebeat/docs/filebeat-general-options.asciidoc
@@ -118,4 +118,4 @@ Example configuration:
 filebeat.shutdown_timeout: 5s
 -------------------------------------------------------------------------------------
 
-include::../../libbeat/docs/generalconfig.asciidoc[]
+include::{libbeat-dir}/docs/generalconfig.asciidoc[]
diff --git a/filebeat/docs/filebeat-modules-options.asciidoc b/filebeat/docs/filebeat-modules-options.asciidoc
@@ -18,7 +18,7 @@ implement and deploy a log monitoring solution.
 * <<enable-modules-cli>>
 * <<enable-modules-config-file>>
 
-include::../../libbeat/docs/shared-note-file-permissions.asciidoc[]
+include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[]
 
 When you enable modules, you can also
 <<specify-variable-settings,specify variable settings>> to change the default