Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport to 6.3: Multiple doc changes (#6428, #6828, #7357, #7360, #7370) #7409

Merged
merged 5 commits into from
Jun 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
[id="{beatname_lc}-getting-started"]
== Getting started with {beatname_uc}

To get started with your own {beatname_uc} setup, install and configure these
related products:

* Elasticsearch for storage and indexing the data.
* Kibana for the UI.
* Logstash (optional) for inserting data into Elasticsearch.

See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack]
for more information.

After installing the Elastic Stack, read the following topics to learn how to
install, configure, and run {beatname_uc}:
include::../../libbeat/docs/shared-getting-started-intro.asciidoc[]

* <<{beatname_lc}-installation>>
* <<{beatname_lc}-configuration>>
Expand All @@ -25,7 +14,7 @@ install, configure, and run {beatname_uc}:
[id="{beatname_lc}-installation"]
=== Step 1: Install {beatname_uc}

You should install {beatname_uc} on all the servers you want to monitor.
Install {beatname_uc} on all the servers you want to monitor.

include::../../libbeat/docs/shared-download-and-install.asciidoc[]

Expand Down
1 change: 1 addition & 0 deletions docs/devguide/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

include::../../libbeat/docs/version.asciidoc[]

:dev-guide: true
:beatname_lc: beatname
:beatname_uc: a Beat

Expand Down
13 changes: 1 addition & 12 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
[[filebeat-getting-started]]
== Getting Started With Filebeat

To get started with your own Filebeat setup, install and configure these related products:

* Elasticsearch for storage and indexing the data.
* Kibana for the UI.
* Logstash (optional) for inserting data into Elasticsearch.

See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack] for more information.

After installing the Elastic Stack, read the following topics to learn how to install, configure, and run Filebeat:
include::../../libbeat/docs/shared-getting-started-intro.asciidoc[]

* <<filebeat-installation>>
* <<filebeat-configuration>>
Expand All @@ -24,9 +16,6 @@ After installing the Elastic Stack, read the following topics to learn how to in
[[filebeat-installation]]
=== Step 1: Install Filebeat

Before running Filebeat, you need to install and configure the Elastic stack. See
{libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack].

include::../../libbeat/docs/shared-download-and-install.asciidoc[]

[[deb]]
Expand Down
8 changes: 5 additions & 3 deletions filebeat/docs/migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ to use for tailing log files and forwarding them to Logstash.
changed.
* Command line options were removed and moved to the configuration file.
* Configuration options for outputs are now inherited from libbeat. For details, see the {libbeat}/index.html[Beats Platform Reference].
* The https://www.elastic.co/guide/en/logstash/current/plugins-inputs-beats.html[Beats input plugin for Logstash] is required.
* The {logstash-ref}/plugins-inputs-beats.html[Beats input plugin for Logstash] is required.

The following topics describe how to migrate from
https://github.com/elastic/logstash-forwarder[Logstash Forwarder] to {beatname_uc}:
Expand All @@ -29,8 +29,10 @@ https://github.com/elastic/logstash-forwarder[Logstash Forwarder] to {beatname_u
[[migration-input-plugin]]
== Migrate to the Beats input plugin for Logstash

{beatname_uc} requires the https://www.elastic.co/guide/en/logstash/current/plugins-inputs-beats.html[Beats input plugin for Logstash].
For information about getting started with this plugin, see {libbeat}/logstash-installation.html#logstash-setup[Setting up Logstash].
{beatname_uc} requires the {logstash-ref}/plugins-inputs-beats.html[Beats input
plugin for Logstash]. For information about getting started with this plugin,
see {stack-ov}/get-started-elastic-stack.html#logstash-setup[Configure Logstash to
listen for Beats input] in the {stack} getting started tutorial.

In both the 1.5.x and 2.x versions of Logstash, this plugin can be loaded in
parallel with the
Expand Down
2 changes: 1 addition & 1 deletion filebeat/docs/modules-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ following the numbered steps under <<filebeat-getting-started>>.
Before running Filebeat modules, you need to:

* Install and configure the Elastic stack. See
{libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack].
{stack-ov}/get-started-elastic-stack.html[Getting started with the {stack}].

* Complete the Filebeat installation instructions described in
<<filebeat-installation>>. After installing Filebeat, return to this
Expand Down
13 changes: 1 addition & 12 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
[[heartbeat-getting-started]]
== Getting Started With Heartbeat

To get started with your own Heartbeat setup, install and configure these
related products:

* Elasticsearch for storage and indexing the data.
* Kibana for the UI.
* Logstash (optional) for inserting data into Elasticsearch.

See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack]
for more information.

After installing the Elastic Stack, read the following topics to learn how to
install, configure, and run Heartbeat:
include::../../libbeat/docs/shared-getting-started-intro.asciidoc[]

* <<heartbeat-installation>>
* <<heartbeat-configuration>>
Expand Down
8 changes: 6 additions & 2 deletions libbeat/docs/communitybeats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@
//////////////////////////////////////////////////////////////////////////

[[community-beats]]
== Community beats
== Community Beats

The open source community has been hard at work developing new Beats. You can check
out some of them here.

Have a question about a community Beat? You can post questions and discuss issues in the
https://discuss.elastic.co/c/beats/community-beats[Community Beats] category of the Beats discussion forum.

Have you created a Beat that's not listed? If so, add the name and description of your Beat to the source document for
Have you created a Beat that's not listed? Add the name and description of your Beat to the source document for
https://github.com/elastic/beats/blob/master/libbeat/docs/communitybeats.asciidoc[Community Beats] and https://help.github.com/articles/using-pull-requests[open a pull request] in the https://github.com/elastic/beats[Beats GitHub repository] to get your change merged. When you're ready, go ahead and https://discuss.elastic.co/c/annoucements[announce] your new Beat in the Elastic
discussion forum.

ifndef::dev-guide[]
Want to contribute? See <<contributing-to-beats>>.
endif::[]

NOTE: Elastic provides no warranty or support for community-sourced Beats.

[horizontal]
Expand Down
9 changes: 7 additions & 2 deletions libbeat/docs/dashboardsconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,14 @@ You can specify the following options in the `setup.dashboards` section of the
==== `setup.dashboards.enabled`

If this option is set to true, {beatname_uc} loads the sample Kibana dashboards
automatically on startup. If no other options are set, the dashboard are loaded
from the local `kibana` directory in the home path of the installation.
from the local `kibana` directory in the home path of the {beatname_uc} installation.

NOTE: When dashboard loading is enabled, {beatname_uc} overwrites any existing
dashboards that match the names of the dashboards you are loading. This happens
every time {beatname_uc} starts.

If no other options are set, the dashboard are loaded
from the local `kibana` directory in the home path of the {beatname_uc} installation.
To load dashboards from a different location, you can configure one of the
following options: <<directory-option,`setup.dashboards.directory`>>,
<<url-option,`setup.dashboards.url`>>, or
Expand Down
Loading