Skip to content

Commit 0ccd969

Browse files
committed
Sort documentation
1 parent 68535e3 commit 0ccd969

10 files changed

+16
-16
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
This collection installs and manages the Elastic Stack. It provides roles for every component of the Stack. Furthermore, it is possible to differentiate between Enterprise or OSS releases.
99

10-
Every role is documented with all variables, please refer to the documentation found in **[Getting-Started](./docs/getting-started.md)**
10+
Every role is documented with all variables, please refer to the documentation found in **[Getting-Started](./docs/02-getting-started.md)**
1111

1212
**Please note**: If you are already using this collection before version `1.0.0`, please note that we had to rename a significant amount of variables due to naming schema changes made by Ansible. Please review the variables you have set in your playbooks and variable files.
1313

@@ -16,16 +16,16 @@ Every role is documented with all variables, please refer to the documentation f
1616
> [!NOTE]
1717
> Some roles have fixed requirements that you must observe. Please have a look at the [requirements](docs/01-requirements.md) before using the collection. (There is a high probability that some of them will be refactored soon)
1818
19-
* [Beats](docs/role-beats.md)
20-
* [Elasticsearch](docs/role-elasticsearch.md)
21-
* [Kibana](docs/role-kibana.md)
22-
* [Logstash](docs/role-logstash.md)
23-
* [Repos](docs/role-repos.md)
19+
* [Beats](docs/14-role-beats.md)
20+
* [Elasticsearch](docs/11-role-elasticsearch.md)
21+
* [Kibana](docs/15-role-kibana.md)
22+
* [Logstash](docs/12-role-logstash.md)
23+
* [Repos](docs/10-role-repos.md)
2424

2525
## Modules documentation
2626

27-
* [elasticsearch_role](docs/module-elasticsearch_role.md)
28-
* [elasticsearch_user](docs/module-elasticsearch_user.md)
27+
* [elasticsearch_role](docs/20-module-elasticsearch_role.md)
28+
* [elasticsearch_user](docs/21-module-elasticsearch_user.md)
2929

3030
## Global variables
3131

@@ -86,7 +86,7 @@ We know from personal experience, that the collections work in following combina
8686

8787
## Usage
8888

89-
Every role is documented with all variables, please refer to the documentation found in **[Getting-Started](./docs/getting-started.md)**
89+
Every role is documented with all variables, please refer to the documentation found in **[Getting-Started](./docs/02-getting-started.md)**
9090

9191
Make sure all hosts that should be configured are part of your playbook. (See below for details on groups etc.). The collection is built to first collect all facts from all hosts (including those only running beats) and then use facts like hostnames or ip addresses to connect the tools to each other.
9292

docs/getting-started.md renamed to docs/02-getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ Or refer to the role with the FQCN of the role.
4747
Roles
4848
-------
4949

50-
* [Beats](role-beats.md)
51-
* [Elasticsearch](role-elasticsearch.md)
52-
* [Kibana](role-kibana.md)
53-
* [Logstash](role-logstash.md)
54-
* [Repos](role-repos.md)
50+
* [Beats](14-role-beats.md)
51+
* [Elasticsearch](11-role-elasticsearch.md)
52+
* [Kibana](15-role-kibana.md)
53+
* [Logstash](12-role-logstash.md)
54+
* [Repos](10-role-repos.md)
5555

5656

5757
Variables
File renamed without changes.
File renamed without changes.

docs/role-logstash.md renamed to docs/12-role-logstash.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ It can optionally configure two types of Logstash pipelines:
99
* Pipeline configuration managed in an external git repository
1010
* A default pipeline which will read from different Redis keys and write into Elasticsearch
1111

12-
For details on how to configure pipelines please refer to our [docs about pipelines](./logstash-pipelines.md).
12+
For details on how to configure pipelines please refer to our [docs about pipelines](./13-logstash-pipelines.md).
1313

1414
Details about configured pipelines will be written into `pipelines.yml` as comments. Same goes for logging configuration in `log4j.options`.
1515

@@ -24,7 +24,7 @@ You will need these packages / libraries installed. Some very basic packages lik
2424

2525
* `passlib` Python library if you do not disable password hashing for logstash user. It should be installed with pip on the Ansible controller.
2626

27-
You need to have the Elastic Repos configured on your system. You can use our [role](./role-repos.md)
27+
You need to have the Elastic Repos configured on your system. You can use our [role](./14-role-repos.md)
2828

2929
If you want to use the default pipeline configuration you need to have `git` available.
3030

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)