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

[meta] Simplify doc in 7.x branch #860

Merged
merged 2 commits into from
Oct 21, 2020
Merged

[meta] Simplify doc in 7.x branch #860

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3abba7c
Streamline charts README doc
nkammah Oct 21, 2020
eb81574
Reword warning statement
nkammah Oct 21, 2020
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
9 changes: 4 additions & 5 deletions apm-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ 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.10](https://github.com/elastic/helm-charts/releases)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

7.10 isn't released yet so this is not accurate. Also this would require us to update it each time we would release a new minor version (7.11, ...) to stay up to date.

Maybe we could just mention the latest 7.x release

Copy link
Member

@jmlrt jmlrt Oct 21, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment as #859 (comment) about having the warning statement in a single line

release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -51,8 +51,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 @@ -148,7 +148,6 @@ 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
[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
8 changes: 4 additions & 4 deletions elasticsearch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
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.10](https://github.com/elastic/helm-charts/releases)
release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -61,8 +61,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
8 changes: 4 additions & 4 deletions filebeat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
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.10](https://github.com/elastic/helm-charts/releases)
release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -48,8 +48,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
8 changes: 4 additions & 4 deletions kibana/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
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.10](https://github.com/elastic/helm-charts/releases)
release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -49,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 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
8 changes: 4 additions & 4 deletions logstash/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ 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.10](https://github.com/elastic/helm-charts/releases)
release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -51,8 +51,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
8 changes: 4 additions & 4 deletions metricbeat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
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.10](https://github.com/elastic/helm-charts/releases)
release for released version.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -48,8 +48,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