From 8a59efe2c628f62e444cbe36c55049b08fd4a45e Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 30 Aug 2018 09:05:16 -0700 Subject: [PATCH 1/3] [DOCS] Creates new Getting Started book --- .../get-started-stack.asciidoc | 8 +++---- .../images/metricbeat-system-host-details.png | Bin .../images/metricbeat-system-overview.png | Bin docs/en/getting-started/index.asciidoc | 20 ++++++++++++++++++ .../get-started-trial.asciidoc | 0 .../images/management-license.png | Bin 6 files changed, 24 insertions(+), 4 deletions(-) rename docs/en/{stack => }/getting-started/get-started-stack.asciidoc (99%) rename docs/en/{stack => getting-started}/images/metricbeat-system-host-details.png (100%) rename docs/en/{stack => getting-started}/images/metricbeat-system-overview.png (100%) create mode 100644 docs/en/getting-started/index.asciidoc rename docs/en/stack/{getting-started => }/get-started-trial.asciidoc (100%) rename docs/en/stack/{getting-started => }/images/management-license.png (100%) diff --git a/docs/en/stack/getting-started/get-started-stack.asciidoc b/docs/en/getting-started/get-started-stack.asciidoc similarity index 99% rename from docs/en/stack/getting-started/get-started-stack.asciidoc rename to docs/en/getting-started/get-started-stack.asciidoc index e007d705f..7d75b8ff7 100644 --- a/docs/en/stack/getting-started/get-started-stack.asciidoc +++ b/docs/en/getting-started/get-started-stack.asciidoc @@ -21,8 +21,8 @@ laptop. IMPORTANT: Implementing security is a critical step in setting up the {stack}. To get up and running quickly with a sample installation, you skip those steps right now. Before sending sensitive data across the network, make sure you -<> and enable -<>. +{stack-ov}/elasticsearch-security.html[secure the {stack}] and enable +{stack-ov}/encrypting-communications.html[encrypted communications]. [float] [[install-prereqs]] @@ -864,8 +864,8 @@ how to use {ls} to filter events collected by {metricbeat}. Next, you'll want to set up {security} and activate your trial license so you can unlock the full capabilities of the {stack}. To learn how, read: -* <> -* <> +* {stack-ov}/elasticsearch-security.html[Securing the {stack}] +* {stack-ov}/license-management.html[License Management] Later, when you're ready to set up a production environment, also see the {stack-ref}/installing-elastic-stack.html[{stack} Installation and Upgrade diff --git a/docs/en/stack/images/metricbeat-system-host-details.png b/docs/en/getting-started/images/metricbeat-system-host-details.png similarity index 100% rename from docs/en/stack/images/metricbeat-system-host-details.png rename to docs/en/getting-started/images/metricbeat-system-host-details.png diff --git a/docs/en/stack/images/metricbeat-system-overview.png b/docs/en/getting-started/images/metricbeat-system-overview.png similarity index 100% rename from docs/en/stack/images/metricbeat-system-overview.png rename to docs/en/getting-started/images/metricbeat-system-overview.png diff --git a/docs/en/getting-started/index.asciidoc b/docs/en/getting-started/index.asciidoc new file mode 100644 index 000000000..6dab64da4 --- /dev/null +++ b/docs/en/getting-started/index.asciidoc @@ -0,0 +1,20 @@ += Getting Started + +:doctype: book + +:forum: https://discuss.elastic.co/c/x-pack +:security-forum: https://discuss.elastic.co/c/shield +:watcher-forum: https://discuss.elastic.co/c/watcher +:monitoring-forum: https://discuss.elastic.co/c/marvel +:graph-forum: https://discuss.elastic.co/c/graph + +:blog-ref: https://www.elastic.co/blog/ +:wikipedia: https://en.wikipedia.org/wiki + +:kib-repo-dir: {docdir}/../../../../kibana/docs +:xes-repo-dir: {docdir}/../../../../elasticsearch/x-pack/docs/en + +include::{asciidoc-dir}/../../shared/versions.asciidoc[] +include::{asciidoc-dir}/../../shared/attributes.asciidoc[] + +include::get-started-stack.asciidoc[] diff --git a/docs/en/stack/getting-started/get-started-trial.asciidoc b/docs/en/stack/get-started-trial.asciidoc similarity index 100% rename from docs/en/stack/getting-started/get-started-trial.asciidoc rename to docs/en/stack/get-started-trial.asciidoc diff --git a/docs/en/stack/getting-started/images/management-license.png b/docs/en/stack/images/management-license.png similarity index 100% rename from docs/en/stack/getting-started/images/management-license.png rename to docs/en/stack/images/management-license.png From 222f0e175ff5013bc211539904fc1163db32dc7a Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 30 Aug 2018 09:18:10 -0700 Subject: [PATCH 2/3] [DOCS] Removes tutorial from Stack Overview --- docs/en/stack/index.asciidoc | 2 -- docs/en/stack/introduction.asciidoc | 2 +- docs/en/stack/ml/getting-started.asciidoc | 5 +++-- .../stack/security/get-started-security.asciidoc | 14 +++++++++----- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/en/stack/index.asciidoc b/docs/en/stack/index.asciidoc index 2166d7f86..911da4d8d 100644 --- a/docs/en/stack/index.asciidoc +++ b/docs/en/stack/index.asciidoc @@ -19,8 +19,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] include::introduction.asciidoc[] -include::getting-started/get-started-stack.asciidoc[] - :edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/security/index.asciidoc include::security/index.asciidoc[] diff --git a/docs/en/stack/introduction.asciidoc b/docs/en/stack/introduction.asciidoc index 5774c66dd..d15aaaa2f 100644 --- a/docs/en/stack/introduction.asciidoc +++ b/docs/en/stack/introduction.asciidoc @@ -10,7 +10,7 @@ For a quick overview, see: https://www.elastic.co/products [float] === Where to Go Next -* <> +* {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}] * <> * <> * <> diff --git a/docs/en/stack/ml/getting-started.asciidoc b/docs/en/stack/ml/getting-started.asciidoc index 910ba30aa..716f836a0 100644 --- a/docs/en/stack/ml/getting-started.asciidoc +++ b/docs/en/stack/ml/getting-started.asciidoc @@ -25,7 +25,8 @@ data: [[ml-gs-sysoverview]] === Before you begin -. Install {es} and {kib}. You can follow the steps in <>. +. Install {es} and {kib}. You can follow the steps in +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. {es} stores the data and the analysis results. {kib} provides a helpful user interface for creating and viewing jobs. + @@ -42,7 +43,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601]. . Obtain a license that includes the {ml} features. + -- -include::{docdir}/getting-started/get-started-trial.asciidoc[] +include::{docdir}/get-started-trial.asciidoc[] -- . If {security} is enabled in your cluster, you need a user that has appropriate diff --git a/docs/en/stack/security/get-started-security.asciidoc b/docs/en/stack/security/get-started-security.asciidoc index f5545d004..3ee19fa24 100644 --- a/docs/en/stack/security/get-started-security.asciidoc +++ b/docs/en/stack/security/get-started-security.asciidoc @@ -11,7 +11,7 @@ roles in {es}, {kib}, {ls}, and {metricbeat}. === Before you begin . Install and configure {es}, {kib}, {ls}, and {metricbeat} as described in -<>. +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. . Stop {ls}. The method for starting and stopping {ls} varies depending on whether you are running it from the command line or running it as a service. For example, @@ -28,7 +28,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601]. [[get-started-license]] === Install a trial license -include::{docdir}/getting-started/get-started-trial.asciidoc[] +include::{docdir}/get-started-trial.asciidoc[] [role="xpack"] [[get-started-enable-security]] @@ -114,7 +114,8 @@ choose a role yet--we'll come back to that in subsequent steps. . Click *Create user* and create a `logstash_internal` user. + -- -In <>, you configured {ls} to listen for {metricbeat} +In {stack-gs}/get-started-elastic-stack.html[Geting started with the {stack}], +you configured {ls} to listen for {metricbeat} input and to send the events to {es}. You therefore need to create a user that {ls} can use to communicate with {es}. For example: @@ -154,7 +155,8 @@ image::security/images/assign-role.jpg["Assigning a role to a user in Kibana"] This user now has the minimum privileges required to use {kib}. -If you completed all of the steps in <>, you should +If you completed all of the steps in +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}], you should have {metricbeat} data stored in {es}. Let's create two roles that grant different levels of access to that data. @@ -285,7 +287,9 @@ To start {ls} as a service, see . If you were connecting directly from {metricbeat} to {es}, you would need to configure authentication credentials for the {es} output in the {metricbeat} -configuration file. In <>, however, you configured +configuration file. In +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}], +however, you configured {metricbeat} to send the data to {ls} for additional parsing, so no extra settings are required in {metricbeat}. For more information, see {metricbeat-ref}/securing-metricbeat.html[Securing {metricbeat}]. From 195ed649a6d94dbe1b1e3673ebdd2c34ee86109c Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 30 Aug 2018 09:33:09 -0700 Subject: [PATCH 3/3] [DOCS] Adds redirects --- docs/en/stack/index.asciidoc | 3 +++ docs/en/stack/redirects.asciidoc | 12 ++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 docs/en/stack/redirects.asciidoc diff --git a/docs/en/stack/index.asciidoc b/docs/en/stack/index.asciidoc index 911da4d8d..c018f74ab 100644 --- a/docs/en/stack/index.asciidoc +++ b/docs/en/stack/index.asciidoc @@ -39,3 +39,6 @@ include::limitations.asciidoc[] :edit_url: include::license.asciidoc[] + +:edit_url: +include::redirects.asciidoc[] diff --git a/docs/en/stack/redirects.asciidoc b/docs/en/stack/redirects.asciidoc new file mode 100644 index 000000000..6bff9fcba --- /dev/null +++ b/docs/en/stack/redirects.asciidoc @@ -0,0 +1,12 @@ +["appendix",role="exclude",id="redirects"] += Deleted pages + +The following pages have moved or been deleted. + + +[role="exclude",id="get-started-elastic-stack"] +=== Getting started with the Elastic Stack + +See {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. + +