Get all books building

auditbeat/docs/configuring-howto.asciidoc

@@ -7,19 +7,7 @@
 <titleabbrev>Configure</titleabbrev>
 ++++
 
-TIP: To get started quickly, read the <<auditbeat-getting-started>>.
-
-To configure {beatname_uc}, you edit the configuration file. For rpm and deb,
-you’ll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+.
-There's also a full example configuration file at
-+/etc/{beatname_lc}/{beatname_lc}.reference.yml+ that shows all non-deprecated
-options. For mac and win, look in the archive that you extracted.
-
-The {beatname_uc} configuration file uses http://yaml.org/[YAML] for its syntax.
-See the {beats-ref}/config-file-format.html[Config File Format] section of the
-_Beats Platform Reference_ for more about the structure of the config file.
-
-The following topics describe how to configure {beatname_uc}:
+include::{libbeat-dir}/shared/configuring-intro.asciidoc[]
 
 * <<configuration-{beatname_lc}>>
 * <<configuration-general-options>>

auditbeat/docs/getting-started.asciidoc

@@ -84,12 +84,10 @@ auditbeat.modules:
   - /etc
 -------------------------------------
 
-include::{libbeat-dir}/step-test-config.asciidoc[]
-
 include::{libbeat-dir}/step-look-at-config.asciidoc[]
 
 [float]
-[[setup-modules]]
+[[setup-assets]]
 === Step 4: Set up assets
 
 include::{libbeat-dir}/shared/setup.asciidoc[]
@@ -98,8 +96,16 @@ include::{libbeat-dir}/shared/setup.asciidoc[]
 [id="{beatname_lc}-starting"]
 === Step 5: Start {beatname_uc}
 
-include::{libbeat-dir}/shared/start-beat.asciidoc[]
+Before starting {beatname_uc}, modify the user credentials in
++{beatname_lc}.yml+ and specify a user who has restricted privileges,
+especially if you're running {beatname_uc} in a production environment.
+For more information, see <<privileges-to-publish-events>>.
+
+To start {beatname_uc}, run:
+
+include::{libbeat-dir}/tab-widgets/start-widget.asciidoc[]
 
+{beatname_uc} should begin streaming events to {es}.
 If you see a warning about too many open files, you need to increase the
 `ulimit`. See the <<ulimit,FAQ>> for more details.
 
@@ -115,7 +121,7 @@ To make it easier for you to start auditing the activities of users and
 processes on your system, {beatname_uc} comes with preconfigured dashboards and
 UIs for visualizing your data.
 
-include::{libbeat-dir}/shared/opendashboards.asciidoc[]
+include::{libbeat-dir}/shared/opendashboards.asciidoc[tag=open-dashboards]
 
 Example dashboard:
 

filebeat/docs/configuring-filebeat.asciidoc

@@ -7,7 +7,7 @@ This guide describes how to configure {beatname_uc} manually. When possible,
 use <<filebeat-modules-overview,Filebeat modules>> for the fastest getting
 started experience.
 
-include::{libbeat-dir}/shared-configuring.asciidoc[]
+include::{libbeat-dir}/shared/configuring-intro.asciidoc[]
 
 Here is a sample of the `filebeat` section of the `filebeat.yml` file. Filebeat uses predefined
 default values for most configuration options.

filebeat/docs/configuring-howto.asciidoc

@@ -7,19 +7,7 @@
 <titleabbrev>Configure</titleabbrev>
 ++++
 
-TIP: To get started quickly, read the <<filebeat-getting-started>>.
-
-To configure {beatname_uc}, you edit the configuration file. For rpm and deb,
-you’ll find the configuration file at +/etc/{beatname_lc}/{beatname_lc}.yml+.
-There's also a full example configuration file at
-+/etc/{beatname_lc}/{beatname_lc}.reference.yml+ that shows all non-deprecated
-options. For mac and win, look in the archive that you extracted.
-
-The {beatname_uc} configuration file uses http://yaml.org/[YAML] for its syntax.
-See the {beats-ref}/config-file-format.html[Config File Format] section of the
-_Beats Platform Reference_ for more about the structure of the config file.
-
-The following topics describe how to configure {beatname_uc}:
+include::{libbeat-dir}/shared/configuring-intro.asciidoc[]
 
 * <<configuration-filebeat-options>>
 * <<configuration-general-options>>

filebeat/docs/getting-started.asciidoc

@@ -4,7 +4,7 @@
 //TODO: Remove release-state definition before merging.
 
 [[filebeat-getting-started]]
-== Get started
+== Get started with {beatname_uc}
 
 //TODO: We need to add a separate topic that provides a summary of the different
 //ways to parse log lines: ingest node, dissect processor, Logstash, etc. That
@@ -21,6 +21,12 @@ You'll learn how to:
 * specify the location of your log files
 * parse log data into fields and send it to {es}
 * visualize the log data in {kib}
++
+[role="screenshot"]
+image::./images/kibana-system.png[]
+
+//REVIEWERS: I think that moving up these dashboards makes the value FB adds
+//more obvious. Should I do this with all the GS guides?
 
 [float]
 === Before you begin
@@ -70,10 +76,8 @@ include::{libbeat-dir}/shared/connecting-to-es.asciidoc[]
 
 {beatname_uc} uses modules to collect and parse log data.
 
-. Identify the modules you need to enable.
-+
-To see the list of available <<filebeat-modules,modules>>,
-run:
+. Identify the modules you need to enable. To see a list of available
+<<filebeat-modules,modules>>, run:
 +
 --
 include::{libbeat-dir}/tab-widgets/list-modules-widget.asciidoc[]
@@ -108,7 +112,7 @@ default locations, set the `paths` variable. For example:
 include::{libbeat-dir}/step-look-at-config.asciidoc[]
 
 [float]
-[[setup-modules]]
+[[setup-assets]]
 === Step 4: Set up assets
 
 include::{libbeat-dir}/shared/setup.asciidoc[]
@@ -126,40 +130,34 @@ you need to <<load-ingest-pipelines>>.
 [[filebeat-starting]]
 === Step 5: Start {beatname_uc}
 
-include::{libbeat-dir}/shared/start-beat.asciidoc[]
+Before starting {beatname_uc}, modify the user credentials in
++{beatname_lc}.yml+ and specify a user who has restricted privileges,
+especially if you're running {beatname_uc} in a production environment.
+For more information, see <<privileges-to-publish-events>>.
+
+To start {beatname_uc}, run:
+
+include::{libbeat-dir}/tab-widgets/start-widget.asciidoc[]
+
+{beatname_uc} should begin streaming events to {es}.
 
 [float]
 [[view-kibana-dashboards]]
 === Step 6: View your data in {kib}
 
-{beatname_uc} comes with preconfigured dashboards and UIs for visualizing log
-data. 
-
-include::{libbeat-dir}/shared/opendashboards.asciidoc[]
-
-Example dashboard:
+include::{libbeat-dir}/shared/opendashboards.asciidoc[tag=open-dashboards-intro]
 
-[role="screenshot"]
-image::./images/kibana-system.png[]
+include::{libbeat-dir}/shared/opendashboards.asciidoc[tag=open-dashboards]
 
 [float]
 === What's next?
 
-Now that you have log data streaming into {es}, learn how to unify your logs,
-metrics, uptime, and application performance data:
+include::{libbeat-dir}/shared/obs-apps.asciidoc[tag=obs-intro]
+
+include::{libbeat-dir}/shared/obs-apps.asciidoc[tag=add-metrics]
 
-* Add infrastructure metrics:
-{metricbeat-ref}/metricbeat-getting-started.html[Get started with {metricbeat}]
-* Add uptime info:
-{heartbeat-ref}/heartbeat-getting-started.html[Get Started with {heartbeat}]
-* Add application metrics:
-{apm-get-started-ref}/index.html[APM overview]
+include::{libbeat-dir}/shared/obs-apps.asciidoc[tag=add-uptime]
 
-Then use the Observability apps in {kib} to search across all your data:
+include::{libbeat-dir}/shared/obs-apps.asciidoc[tag=add-apm]
 
-** Explore metrics about systems and services across your ecosystem: 
-{kibana-ref}/xpack-infra[Metrics app]
-** Drill down into related log data and tail your logs in real time:
-{kibana-ref}/xpack-logs.html[Logs app]
-** View related traces and monitor application performance:
-{kibana-ref}/xpack-apm.html[APM app]
+include::{libbeat-dir}/shared/obs-apps.asciidoc[tag=obs-apps]

heartbeat/docs/configuring-howto.asciidoc

@@ -7,23 +7,7 @@
 <titleabbrev>Configure</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.
-
-To configure Heartbeat, you edit the configuration file. For rpm and deb,
-you’ll find the default configuration file at
-+/etc/heartbeat/heartbeat.yml+. There's also a full example
-configuration file at +/etc/heartbeat/heartbeat.reference.yml+ that shows
-all non-deprecated options. For mac and win, look in the archive that you
-extracted.
-
-The Heartbeat configuration file uses http://yaml.org/[YAML] for its syntax.
-See the
-{beats-ref}/config-file-format.html[Config File Format] section of the
-_Beats Platform Reference_ for more about the structure of the config file.
-
-The following topics describe how to configure Heartbeat:
+include::{libbeat-dir}/shared/configuring-intro.asciidoc[]
 
 * <<configuration-heartbeat-options>>
 * <<monitors-scheduler>>