Skip to content

Commit 3afa61d

Browse files
authored
[DOCS] Creates Getting Started book
2 parents 7ddd33f + 195ed64 commit 3afa61d

11 files changed

+52
-14
lines changed

docs/en/stack/getting-started/get-started-stack.asciidoc renamed to docs/en/getting-started/get-started-stack.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ laptop.
2121
IMPORTANT: Implementing security is a critical step in setting up the {stack}.
2222
To get up and running quickly with a sample installation, you skip those steps
2323
right now. Before sending sensitive data across the network, make sure you
24-
<<elasticsearch-security,secure the stack>> and enable
25-
<<encrypting-communications,encrypted communications>>.
24+
{stack-ov}/elasticsearch-security.html[secure the {stack}] and enable
25+
{stack-ov}/encrypting-communications.html[encrypted communications].
2626

2727
[float]
2828
[[install-prereqs]]
@@ -864,8 +864,8 @@ how to use {ls} to filter events collected by {metricbeat}.
864864
Next, you'll want to set up {security} and activate your trial license so
865865
you can unlock the full capabilities of the {stack}. To learn how, read:
866866

867-
* <<elasticsearch-security,Securing the {stack}>>
868-
* <<license-management,License Management>>
867+
* {stack-ov}/elasticsearch-security.html[Securing the {stack}]
868+
* {stack-ov}/license-management.html[License Management]
869869

870870
Later, when you're ready to set up a production environment, also see the
871871
{stack-ref}/installing-elastic-stack.html[{stack} Installation and Upgrade
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
= Getting Started
2+
3+
:doctype: book
4+
5+
:forum: https://discuss.elastic.co/c/x-pack
6+
:security-forum: https://discuss.elastic.co/c/shield
7+
:watcher-forum: https://discuss.elastic.co/c/watcher
8+
:monitoring-forum: https://discuss.elastic.co/c/marvel
9+
:graph-forum: https://discuss.elastic.co/c/graph
10+
11+
:blog-ref: https://www.elastic.co/blog/
12+
:wikipedia: https://en.wikipedia.org/wiki
13+
14+
:kib-repo-dir: {docdir}/../../../../kibana/docs
15+
:xes-repo-dir: {docdir}/../../../../elasticsearch/x-pack/docs/en
16+
17+
include::{asciidoc-dir}/../../shared/versions.asciidoc[]
18+
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
19+
20+
include::get-started-stack.asciidoc[]

docs/en/stack/index.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
1919

2020
include::introduction.asciidoc[]
2121

22-
include::getting-started/get-started-stack.asciidoc[]
23-
2422
:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/security/index.asciidoc
2523
include::security/index.asciidoc[]
2624

@@ -41,3 +39,6 @@ include::limitations.asciidoc[]
4139

4240
:edit_url:
4341
include::license.asciidoc[]
42+
43+
:edit_url:
44+
include::redirects.asciidoc[]

docs/en/stack/introduction.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For a quick overview, see: https://www.elastic.co/products
1010
[float]
1111
=== Where to Go Next
1212

13-
* <<get-started-elastic-stack, Getting started with the {stack}>>
13+
* {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]
1414
* <<security-getting-started, Getting Started with Security>>
1515
* <<xpack-monitoring, Getting Started with Monitoring>>
1616
* <<watcher-getting-started, Getting Started with Alerting and Notification>>

docs/en/stack/ml/getting-started.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ data:
2525
[[ml-gs-sysoverview]]
2626
=== Before you begin
2727

28-
. Install {es} and {kib}. You can follow the steps in <<get-started-elastic-stack>>.
28+
. Install {es} and {kib}. You can follow the steps in
29+
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
2930
{es} stores the data and the analysis results. {kib} provides a helpful user
3031
interface for creating and viewing jobs.
3132
+
@@ -42,7 +43,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601].
4243
. Obtain a license that includes the {ml} features.
4344
+
4445
--
45-
include::{docdir}/getting-started/get-started-trial.asciidoc[]
46+
include::{docdir}/get-started-trial.asciidoc[]
4647
--
4748

4849
. If {security} is enabled in your cluster, you need a user that has appropriate

docs/en/stack/redirects.asciidoc

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
["appendix",role="exclude",id="redirects"]
2+
= Deleted pages
3+
4+
The following pages have moved or been deleted.
5+
6+
7+
[role="exclude",id="get-started-elastic-stack"]
8+
=== Getting started with the Elastic Stack
9+
10+
See {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
11+
12+

docs/en/stack/security/get-started-security.asciidoc

+9-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ roles in {es}, {kib}, {ls}, and {metricbeat}.
1111
=== Before you begin
1212

1313
. Install and configure {es}, {kib}, {ls}, and {metricbeat} as described in
14-
<<get-started-elastic-stack>>.
14+
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
1515

1616
. Stop {ls}. The method for starting and stopping {ls} varies depending on whether
1717
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].
2828
[[get-started-license]]
2929
=== Install a trial license
3030

31-
include::{docdir}/getting-started/get-started-trial.asciidoc[]
31+
include::{docdir}/get-started-trial.asciidoc[]
3232

3333
[role="xpack"]
3434
[[get-started-enable-security]]
@@ -114,7 +114,8 @@ choose a role yet--we'll come back to that in subsequent steps.
114114
. Click *Create user* and create a `logstash_internal` user.
115115
+
116116
--
117-
In <<get-started-elastic-stack>>, you configured {ls} to listen for {metricbeat}
117+
In {stack-gs}/get-started-elastic-stack.html[Geting started with the {stack}],
118+
you configured {ls} to listen for {metricbeat}
118119
input and to send the events to {es}. You therefore need to create a user
119120
that {ls} can use to communicate with {es}. For example:
120121

@@ -154,7 +155,8 @@ image::security/images/assign-role.jpg["Assigning a role to a user in Kibana"]
154155

155156
This user now has the minimum privileges required to use {kib}.
156157

157-
If you completed all of the steps in <<get-started-elastic-stack>>, you should
158+
If you completed all of the steps in
159+
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}], you should
158160
have {metricbeat} data stored in {es}. Let's create two roles that grant
159161
different levels of access to that data.
160162

@@ -285,7 +287,9 @@ To start {ls} as a service, see
285287

286288
. If you were connecting directly from {metricbeat} to {es}, you would need
287289
to configure authentication credentials for the {es} output in the {metricbeat}
288-
configuration file. In <<get-started-elastic-stack>>, however, you configured
290+
configuration file. In
291+
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}],
292+
however, you configured
289293
{metricbeat} to send the data to {ls} for additional parsing, so no extra
290294
settings are required in {metricbeat}. For more information, see
291295
{metricbeat-ref}/securing-metricbeat.html[Securing {metricbeat}].

0 commit comments

Comments
 (0)