Backport to 6.5: Docs for new beats (#8811, #8864, #8744) (#9025)

* Add conditions for each platform (#8811) * Add conditions for each platform * Add conditions to directory layout topic * Combine conditions for deb and rpm * Update Journalbeat docs (#8864) * More updates for journalbeat * Remove unwanted comments and extra files * Add changes from review * Changes from second round of reviews * Remove backoff options * Remove questions for reviewers * Change file to journal * Change default max_backoff in docs to 20s * More fixes from review * Revert "Remove backoff options" This reverts commit d57e4b3. * Add global options back * Initialize docs for functionbeat (#8744) * Initialize docs * Run make update * In progress fixes from review * More changes from the review and testing * Add fixes from the review * Fixed download path * Remove unused dashboard image placeholders * Add missing options and remove boiler plate text * Run make update * Remove broken link
elastic · Nov 12, 2018 · 2df6560 · 2df6560
1 parent fd45e59
commit 2df6560
Show file tree

Hide file tree

Showing 57 changed files with 1,121 additions and 468 deletions.
diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc
@@ -49,7 +49,6 @@ include::./auditbeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -70,10 +69,11 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc
@@ -181,13 +181,11 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [id="{beatname_lc}-template"]
 === Step 3: Load the index template in {es}
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the {kib} dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [id="{beatname_lc}-starting"]
@@ -201,14 +199,7 @@ NOTE: If you use an init.d script to start {beatname_uc} on deb or rpm, you can'
 specify command line flags (see <<command-line-options>>). To specify flags,
 start {beatname_uc} in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc} start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc
@@ -54,7 +54,6 @@ include::./filebeat-general-options.asciidoc[]
 
 include::./reload-configuration.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -77,14 +76,15 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 :autodiscoverJolokia:
 :autodiscoverHints:
 include::../../libbeat/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc
@@ -186,19 +186,16 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [[config-filebeat-logstash]]
 === Step 3: Configure Filebeat to use Logstash
 
-:allplatforms:
 include::../../libbeat/docs/shared-logstash-config.asciidoc[]
 
 [[filebeat-template]]
 === Step 4: Load the index template in Elasticsearch
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 5: Set up the Kibana dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [[filebeat-starting]]
@@ -212,14 +209,7 @@ NOTE: If you use an init.d script to start Filebeat on deb or rpm, you can't
 specify command line flags (see <<command-line-options>>). To specify flags,
 start Filebeat in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc} start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc
@@ -46,7 +46,6 @@ include::./heartbeat-options.asciidoc[]
 
 include::./heartbeat-general-options.asciidoc[]
 
-:allplatforms:
 include::../../libbeat/docs/queueconfig.asciidoc[]
 
 include::../../libbeat/docs/outputconfig.asciidoc[]
@@ -67,12 +66,13 @@ include::../../libbeat/docs/loggingconfig.asciidoc[]
 
 :standalone:
 include::../../libbeat/docs/shared-env-vars.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/shared-autodiscover.asciidoc[]
 
 :standalone:
-:allplatforms:
 include::../../libbeat/docs/yaml.asciidoc[]
+:standalone!:
 
 include::../../libbeat/docs/regexp.asciidoc[]
 

diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc
@@ -205,13 +205,11 @@ include::../../libbeat/docs/step-look-at-config.asciidoc[]
 [[heartbeat-template]]
 === Step 3: Load the index template in Elasticsearch
 
-:allplatforms:
 include::../../libbeat/docs/shared-template-load.asciidoc[]
 
 [[load-kibana-dashboards]]
 === Step 4: Set up the Kibana dashboards
 
-:allplatforms:
 include::../../libbeat/docs/dashboards.asciidoc[]
 
 [[heartbeat-starting]]
@@ -225,14 +223,7 @@ NOTE: If you use an init.d script to start Heartbeat on deb or rpm, you can't
 specify command line flags (see <<command-line-options>>). To specify flags,
 start Heartbeat in the foreground.
 
-*deb:*
-
-["source","sh",subs="attributes"]
-----------------------------------------------------------------------
-sudo service {beatname_lc}-elastic start
-----------------------------------------------------------------------
-
-*rpm:*
+*deb and rpm:*
 
 ["source","sh",subs="attributes"]
 ----------------------------------------------------------------------

diff --git a/heartbeat/docs/index.asciidoc b/heartbeat/docs/index.asciidoc
@@ -12,6 +12,11 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs: yes
+:deb_os:
+:rpm_os:
+:mac_os:
+:docker_platform:
+:win_os:
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]