Add docs for new subcommands (elastic#4832)

* Add docs for new subcommands * Add changes from review
tsg · Aug 15, 2017 · 0e91ea0 · 0e91ea0
1 parent 7f4fd5b
commit 0e91ea0
Show file tree

Hide file tree

Showing 24 changed files with 765 additions and 212 deletions.
diff --git a/auditbeat/docs/command-line.asciidoc b/auditbeat/docs/command-line.asciidoc
diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -23,12 +23,10 @@ include::../../libbeat/docs/contributing-to-beats.asciidoc[]
 
 include::./getting-started.asciidoc[]
 
-include::./command-line.asciidoc[]
-
-include::../../libbeat/docs/shared-directory-layout.asciidoc[]
-
 include::../../libbeat/docs/repositories.asciidoc[]
 
+include::./setting-up-running.asciidoc[]
+
 include::./configuring-howto.asciidoc[]
 
 include::./modules.asciidoc[]

diff --git a/auditbeat/docs/setting-up-running.asciidoc b/auditbeat/docs/setting-up-running.asciidoc
@@ -0,0 +1,25 @@
+/////
+// NOTE:
+// Each beat has its own setup overview to allow for the addition of content
+// that is unique to each beat.
+/////
+
+[[seting-up-and-running]]
+== Setting up and running {beatname_uc}
+
+Before reading this section, see the
+<<{beatname_lc}-getting-started,getting started documentation>> for basic
+installation instructions to get you started.
+
+This section includes additional information on how to set up and run
+{beatname_uc}, including:
+
+* <<directory-layout>>
+
+* <<command-line-options>>
+
+//MAINTAINERS: If you add a new file to this section, make sure you update the bulletedl ist ^^ too.
+
+include::../../libbeat/docs/shared-directory-layout.asciidoc[]
+
+include::../../libbeat/docs/command-reference.asciidoc[]
diff --git a/filebeat/docs/command-line.asciidoc b/filebeat/docs/command-line.asciidoc
diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -28,13 +28,9 @@ include::./getting-started.asciidoc[]
 
 include::./modules-getting-started.asciidoc[]
 
-include::./command-line.asciidoc[]
-
-include::../../libbeat/docs/shared-directory-layout.asciidoc[]
-
 include::../../libbeat/docs/repositories.asciidoc[]
 
-include::./running-on-docker.asciidoc[]
+include::./setting-up-running.asciidoc[]
 
 include::./upgrading.asciidoc[]
 

diff --git a/filebeat/docs/setting-up-running.asciidoc b/filebeat/docs/setting-up-running.asciidoc
@@ -0,0 +1,30 @@
+/////
+// NOTE:
+// Each beat has its own setup overview to allow for the addition of content
+// that is unique to each beat.
+/////
+
+[[seting-up-and-running]]
+== Setting up and running {beatname_uc}
+
+Before reading this section, see the
+<<{beatname_lc}-getting-started,getting started documentation>> for basic
+installation instructions to get you started.
+
+This section includes additional information on how to set up and run
+{beatname_uc}, including:
+
+* <<directory-layout>>
+
+* <<command-line-options>>
+
+* <<running-on-docker>>
+
+
+//MAINTAINERS: If you add a new file to this section, make sure you update the bulletedl ist ^^ too.
+
+include::../../libbeat/docs/shared-directory-layout.asciidoc[]
+
+include::../../libbeat/docs/command-reference.asciidoc[]
+
+include::./running-on-docker.asciidoc[]
diff --git a/heartbeat/docs/command-line.asciidoc b/heartbeat/docs/command-line.asciidoc
diff --git a/heartbeat/docs/index.asciidoc b/heartbeat/docs/index.asciidoc
@@ -26,13 +26,9 @@ include::../../libbeat/docs/contributing-to-beats.asciidoc[]
 
 include::./getting-started.asciidoc[]
 
-include::./command-line.asciidoc[]
-
-include::../../libbeat/docs/shared-directory-layout.asciidoc[]
-
 include::../../libbeat/docs/repositories.asciidoc[]
 
-include::./running-on-docker.asciidoc[]
+include::./setting-up-running.asciidoc[]
 
 //
 //include::./upgrading.asciidoc[]

diff --git a/heartbeat/docs/setting-up-running.asciidoc b/heartbeat/docs/setting-up-running.asciidoc
@@ -0,0 +1,29 @@
+/////
+// NOTE:
+// Each beat has its own setup overview to allow for the addition of content
+// that is unique to each beat.
+/////
+
+[[seting-up-and-running]]
+== Setting up and running {beatname_uc}
+
+Before reading this section, see the
+<<{beatname_lc}-getting-started,getting started documentation>> for basic
+installation instructions to get you started.
+
+This section includes additional information on how to set up and run
+{beatname_uc}, including:
+
+* <<directory-layout>>
+
+* <<command-line-options>>
+
+* <<running-on-docker>>
+
+//MAINTAINERS: If you add a new file to this section, make sure you update the bulletedl ist ^^ too.
+
+include::../../libbeat/docs/shared-directory-layout.asciidoc[]
+
+include::../../libbeat/docs/command-reference.asciidoc[]
+
+include::./running-on-docker.asciidoc[]