Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Commit

Permalink
[all] Simplify doc in 7.x branch (#860)
Browse files Browse the repository at this point in the history
* Streamline charts README doc
  • Loading branch information
nkammah authored Oct 21, 2020
1 parent d8f2b4b commit 5d351fb
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 37 deletions.
11 changes: 4 additions & 7 deletions apm-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ The design and code is less mature than official GA features and is being
provided as-is with no warranties. Alpha features are not subject to the support
SLA of official GA features (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -51,8 +49,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name apm-server elastic/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server elastic/apm-server`
- with Helm 2: `helm install --name apm-server --version <version> elastic/apm-server`
- with [Helm 3 (beta)][]: `helm install apm-server --version <version> elastic/apm-server`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -147,8 +145,7 @@ An example of APM Server deployment using OSS version can be found in
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/apm-server/README.md
[7.x]: https://github.com/elastic/helm-charts/releases
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
[CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md
Expand Down
10 changes: 4 additions & 6 deletions elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
This Helm chart is a lightweight way to configure and run our official
[Elasticsearch Docker image][].

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -61,8 +59,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name elasticsearch elastic/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch elastic/elasticsearch`
- with Helm 2: `helm install --name elasticsearch --version <version> elastic/elasticsearch`
- with [Helm 3 (beta)][]: `helm install elasticsearch --version <version> elastic/elasticsearch`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -387,7 +385,7 @@ lifecycle:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.
[7.x]: https://github.com/elastic/helm-charts/releases
[#63]: https://github.com/elastic/helm-charts/issues/63
[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/elasticsearch/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
Expand Down
10 changes: 4 additions & 6 deletions filebeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
This Helm chart is a lightweight way to configure and run our official
[Filebeat Docker image][].

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -48,8 +46,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name filebeat elastic/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat elastic/filebeat`
- with Helm 2: `helm install --name filebeat --version <version> elastic/filebeat`
- with [Helm 3 (beta)][]: `helm install filebeat --version <version> elastic/filebeat`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -186,7 +184,7 @@ readinessProbe:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[7.x]: https://github.com/elastic/helm-charts/releases
[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/filebeat/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
Expand Down
10 changes: 4 additions & 6 deletions kibana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
This Helm chart is a lightweight way to configure and run our official
[Kibana Docker image][].

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -49,8 +47,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name kibana elastic/kibana`
- with [Helm 3 (beta)][]: `helm install kibana elastic/kibana`
- with Helm 2: `helm install --name kibana --version <version> elastic/kibana`
- with [Helm 3 (beta)][]: `helm install kibana --version <version> elastic/kibana`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -203,7 +201,7 @@ lifecycle:
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.
[7.x]: https://github.com/elastic/helm-charts/releases
[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/kibana/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
Expand Down
10 changes: 4 additions & 6 deletions logstash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ The design and code is less mature than official GA features and is being
provided as-is with no warranties. Alpha features are not subject to the support
SLA of official GA features (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -51,8 +49,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name logstash elastic/logstash`
- with [Helm 3 (beta)][]: `helm install logstash elastic/logstash`
- with Helm 2: `helm install --name logstash --version <version> elastic/logstash`
- with [Helm 3 (beta)][]: `helm install logstash --version <version> elastic/logstash`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -191,7 +189,7 @@ against best practices of containers and immutable infrastructure.
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[7.x]: https://github.com/elastic/helm-charts/releases
[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/logstash/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
Expand Down
10 changes: 4 additions & 6 deletions metricbeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
This Helm chart is a lightweight way to configure and run our official
[Metricbeat Docker image][].

**Warning**: This branch is used for development, please use [7.7.1][] release
for released version.

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -48,8 +46,8 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions.
`helm repo add elastic https://helm.elastic.co`

* Install it:
- with Helm 2: `helm install --name metricbeat elastic/metricbeat`
- with [Helm 3 (beta)][]: `helm install metricbeat elastic/metricbeat`
- with Helm 2: `helm install --name metricbeat --version <version> elastic/metricbeat`
- with [Helm 3 (beta)][]: `helm install metricbeat --version <version> elastic/metricbeat`


### Install development version using 7.x branch and 7.10.0-SNAPSHOT versions
Expand Down Expand Up @@ -210,7 +208,7 @@ same node.
Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.


[7.x]: https://github.com/elastic/helm-charts/releases
[#471]: https://github.com/elastic/helm-charts/pull/471
[7.7.1]: https://github.com/elastic/helm-charts/blob/7.7.1/metricbeat/README.md
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
Expand Down

0 comments on commit 5d351fb

Please sign in to comment.