From 36f0bf2f6e1618846ce05b9ba736db33305e48e0 Mon Sep 17 00:00:00 2001 From: Julien Mailleret <8582351+jmlrt@users.noreply.github.com> Date: Mon, 23 Nov 2020 09:09:08 +0100 Subject: [PATCH] [meta] remove version from dev install section title 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 https://github.com/elastic/helm-charts/pull/831 --- apm-server/README.md | 9 +++++---- elasticsearch/README.md | 11 +++++------ filebeat/README.md | 11 +++++------ kibana/README.md | 11 +++++------ logstash/README.md | 10 +++++----- metricbeat/README.md | 10 +++++----- 6 files changed, 30 insertions(+), 32 deletions(-) diff --git a/apm-server/README.md b/apm-server/README.md index 8570ff52b..9572a6b35 100644 --- a/apm-server/README.md +++ b/apm-server/README.md @@ -18,7 +18,7 @@ SLA of official GA features (see [supported configurations][] for more details). - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -42,7 +42,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -53,11 +53,12 @@ This chart is tested with the latest 7.10.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.10.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.10` + * Install it: - with Helm 3: `helm install apm-server ./helm-charts/apm-server --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name apm-server ./helm-charts/apm-server --set imageTag=7.10.0-SNAPSHOT` diff --git a/elasticsearch/README.md b/elasticsearch/README.md index 1afd20496..4e353a781 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -13,7 +13,7 @@ This Helm chart is a lightweight way to configure and run our official - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -52,7 +52,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -63,17 +63,16 @@ This chart is tested with the latest 7.10.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.10.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.10` + * Install it: - with Helm 3: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=7.10.0-SNAPSHOT` - ## Upgrading Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before diff --git a/filebeat/README.md b/filebeat/README.md index 081786d82..d4200aee5 100644 --- a/filebeat/README.md +++ b/filebeat/README.md @@ -13,7 +13,7 @@ This Helm chart is a lightweight way to configure and run our official - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -39,7 +39,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -50,17 +50,16 @@ This chart is tested with the latest 7.10.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.10.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.10` + * Install it: - with Helm 3: `helm install filebeat ./helm-charts/filebeat --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name filebeat ./helm-charts/filebeat --set imageTag=7.10.0-SNAPSHOT` - ## Upgrading Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before diff --git a/kibana/README.md b/kibana/README.md index 3b7207513..131c56b16 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -13,7 +13,7 @@ This Helm chart is a lightweight way to configure and run our official - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -40,7 +40,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -50,17 +50,16 @@ This chart is tested with the latest 7.10.0-SNAPSHOT versions. * Install it: - 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.10.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.10` + * Install it: - with Helm 3: `helm install kibana ./helm-charts/kibana --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name kibana ./helm-charts/kibana --set imageTag=7.10.0-SNAPSHOT` - ## Upgrading Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before diff --git a/logstash/README.md b/logstash/README.md index 0f01132b0..ecd2a3c8e 100644 --- a/logstash/README.md +++ b/logstash/README.md @@ -18,7 +18,7 @@ SLA of official GA features (see [supported configurations][] for more details). - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -42,7 +42,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -53,12 +53,12 @@ This chart is tested with the latest 7.10.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.10.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.10` + * Install it: - with Helm 3: `helm install logstash ./helm-charts/logstash --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name logstash ./helm-charts/logstash --set imageTag=7.10.0-SNAPSHOT` diff --git a/metricbeat/README.md b/metricbeat/README.md index ce8bcf32b..8c5b0af38 100644 --- a/metricbeat/README.md +++ b/metricbeat/README.md @@ -13,7 +13,7 @@ This Helm chart is a lightweight way to configure and run our official - [Requirements](#requirements) - [Installing](#installing) - [Install released version using Helm repository](#install-released-version-using-helm-repository) - - [Install development version using 7.x branch and 7.10.0-SNAPSHOT versions](#install-development-version-using-7x-branch-and-7100-snapshot-versions) + - [Install development version from a branch](#install-development-version-from-a-branch) - [Upgrading](#upgrading) - [Usage notes](#usage-notes) - [Configuration](#configuration) @@ -39,7 +39,7 @@ See [supported configurations][] for more details. ## Installing -This chart is tested with the latest 7.10.0-SNAPSHOT versions. +This chart is tested with the latest 7.10.0-SNAPSHOT version. ### Install released version using Helm repository @@ -50,16 +50,16 @@ This chart is tested with the latest 7.10.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.10.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.10` + * Install it: - with Helm 3: `helm install metricbeat ./helm-charts/metricbeat --set imageTag=7.10.0-SNAPSHOT` - with Helm 2 (deprecated): `helm install --name metricbeat ./helm-charts/metricbeat --set imageTag=7.10.0-SNAPSHOT` - ## Upgrading Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before