From c57b5c9bb498cd727ca545e16d550c62ead89517 Mon Sep 17 00:00:00 2001 From: Julien Mailleret <8582351+jmlrt@users.noreply.github.com> Date: Mon, 23 Nov 2020 09:58:26 +0100 Subject: [PATCH] [meta] remove version from dev install section title (#928) This commit update charts readme to remove the version from the dev install section title. This is required to simplify bumping automation and avoid having to manage toc update. This was done in 7.9 branch in #831 Also remove a unused link --- apm-server/README.md | 7 ++++--- elasticsearch/README.md | 9 ++++----- filebeat/README.md | 8 +++----- kibana/README.md | 8 ++++---- logstash/README.md | 9 ++++----- metricbeat/README.md | 8 ++++---- 6 files changed, 23 insertions(+), 26 deletions(-) diff --git a/apm-server/README.md b/apm-server/README.md index dfffce418..bab2cf9bf 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -42,7 +42,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -53,11 +53,12 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install apm-server --version elastic/apm-server` - with Helm 2 (deprecated): `helm install --name apm-server --version elastic/apm-server` - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` + * Install it: - with Helm 3: `helm install apm-server ./helm-charts/apm-server --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name apm-server ./helm-charts/apm-server --set imageTag=7.11.0-SNAPSHOT` diff --git a/elasticsearch/README.md b/elasticsearch/README.md index dd3fab733..807113981 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -52,7 +52,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -63,12 +63,12 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install elasticsearch --version elastic/elasticsearch` - with Helm 2 (deprecated): `helm install --name elasticsearch --version elastic/elasticsearch` - - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` + * Install it: - with Helm 3: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=7.11.0-SNAPSHOT` @@ -389,7 +389,6 @@ 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 [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/filebeat/README.md b/filebeat/README.md index fcd0e2d85..949ba218f 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -39,7 +39,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -50,12 +50,11 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install filebeat --version elastic/filebeat` - with Helm 2 (deprecated): `helm install --name filebeat --version elastic/filebeat` - - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` * Install it: - with Helm 3: `helm install filebeat ./helm-charts/filebeat --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name filebeat ./helm-charts/filebeat --set imageTag=7.11.0-SNAPSHOT` @@ -187,7 +186,6 @@ 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 [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/kibana/README.md b/kibana/README.md index c770f3ebd..8b63e2deb 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -40,7 +40,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -51,11 +51,12 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install kibana --version elastic/kibana` - with Helm 2 (deprecated): `helm install --name kibana --version elastic/kibana` - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` + * Install it: - with Helm 3: `helm install kibana ./helm-charts/kibana --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name kibana ./helm-charts/kibana --set imageTag=7.11.0-SNAPSHOT` @@ -203,7 +204,6 @@ 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 [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/logstash/README.md b/logstash/README.md index fa0d2aab9..2b38847f4 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -42,7 +42,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -53,12 +53,12 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install logstash --version elastic/logstash` - with Helm 2 (deprecated): `helm install --name logstash --version elastic/logstash` - - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` + * Install it: - with Helm 3: `helm install logstash ./helm-charts/logstash --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name logstash ./helm-charts/logstash --set imageTag=7.11.0-SNAPSHOT` @@ -192,7 +192,6 @@ 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 [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md diff --git a/metricbeat/README.md b/metricbeat/README.md index 28cd6a354..66a566c99 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -39,7 +39,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.11.0-SNAPSHOT versions. +This chart is tested with the latest 7.11.0-SNAPSHOT version. ### Install released version using Helm repository @@ -50,11 +50,12 @@ This chart is tested with the latest 7.11.0-SNAPSHOT versions. - with Helm 3: `helm install metricbeat --version elastic/metricbeat` - with Helm 2 (deprecated): `helm install --name metricbeat --version elastic/metricbeat` - -### Install development version using 7.x branch and 7.11.0-SNAPSHOT versions +### Install development version from a branch * Clone the git repo: `git clone git@github.com:elastic/helm-charts.git` +* Checkout the branch : `git checkout 7.x` + * Install it: - with Helm 3: `helm install metricbeat ./helm-charts/metricbeat --set imageTag=7.11.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name metricbeat ./helm-charts/metricbeat --set imageTag=7.11.0-SNAPSHOT` @@ -211,7 +212,6 @@ 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 [CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md [CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md