[meta] remove support matrix + nit doc changes (elastic#1337)

This commit removes the existing support matrix and replace it by a mention of the charts status (alpha, beta, ga) in the stack version table. This change will avoid issue where the support matrix isn't updated during a release. Also remove the links to stack product docker image doc which are already present in each chart specific README. Also reorganize informations related to supported configuration under this title and format line length.
jmlrt · Sep 13, 2021 · 86a69ef · 86a69ef
1 parent baed17f
commit 86a69ef
Showing 1 changed file with 22 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -8,76 +8,48 @@
 
 - [Charts](#charts)
 - [Supported Configurations](#supported-configurations)
-  - [Support Matrix](#support-matrix)
+  - [Stack Versions](#stack-versions)
   - [Kubernetes Versions](#kubernetes-versions)
-  - [Helm versions](#helm-versions)
+  - [Helm Versions](#helm-versions)
 - [ECK](#eck)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto-update -->
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 
 ## Charts
 
-These Helm charts are designed to be a lightweight way to configure our official
-Docker images. Links to the relevant Docker image documentation have also been
-added below.
+These Helm charts are designed to be a lightweight way to configure Elastic
+official Docker images.
 
-We recommend that the Helm chart version is aligned to the version of the product
-you want to deploy. This will ensure that you using a chart version that has been
-tested against the corresponding production version.
-This will also ensure that the documentation and examples for the chart will work
-with the version of the product, you are installing.
+## Supported Configurations
+
+We recommend that the Helm chart version is aligned to the version of the
+product you want to deploy. This will ensure that you are using a chart version
+that has been tested against the corresponding production version.
+This will also ensure that the documentation and examples for the chart will
+work with the version of the product, you are installing.
 
 For example, if you want to deploy an Elasticsearch `7.7.1` cluster, use the
 corresponding `7.7.1` [tag][elasticsearch-771].
 
-The `master` version of these charts are intended to support the latest pre-release
-versions of our products, and therefore may or may not work with current released
-versions.
-
-| Chart                                      | Docker documentation                                                            | Latest 7 Version            | Latest 6 Version            |
-|--------------------------------------------|---------------------------------------------------------------------------------|-----------------------------|-----------------------------|
-| [APM-Server](./apm-server/README.md)       | https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html       | [`7.13.3`][apm-7]           | [`6.8.18`][apm-6]           |
-| [Elasticsearch](./elasticsearch/README.md) | https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html     | [`7.13.3`][elasticsearch-7] | [`6.8.18`][elasticsearch-6] |
-| [Filebeat](./filebeat/README.md)           | https://www.elastic.co/guide/en/beats/filebeat/current/running-on-docker.html   | [`7.13.3`][filebeat-7]      | [`6.8.18`][filebeat-6]      |
-| [Kibana](./kibana/README.md)               | https://www.elastic.co/guide/en/kibana/current/docker.html                      | [`7.13.3`][kibana-7]        | [`6.8.18`][kibana-6]        |
-| [Logstash](./logstash/README.md)           | https://www.elastic.co/guide/en/logstash/current/docker.html                    | [`7.13.3`][logstash-7]      | [`6.8.18`][logstash-6]      |
-| [Metricbeat](./metricbeat/README.md)       | https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html | [`7.13.3`][metricbeat-7]    | [`6.8.18`][metricbeat-6]    |
-
-## Supported Configurations
-
-Starting with the `7.7.0` release, some charts are reaching GA.
-
+The `master` version of these charts is intended to support the latest
+pre-release versions of our products, and therefore may or may not work with
+current released versions.
 Note that only the released charts coming from [Elastic Helm repo][] or
 [GitHub releases][] are supported.
 
-### Support Matrix
-
-|      | Elasticsearch | Kibana | Logstash | Filebeat | Metricbeat | APM Server |
-|------|---------------|--------|----------|----------|------------|------------|
-| 6.8  | Beta          | Beta   | Beta     | Beta     | Beta       | Alpha      |
-| 7.0  | Alpha         | Alpha  | /        | /        | /          | /          |
-| 7.1  | Beta          | Beta   | /        | Beta     | /          | /          |
-| 7.2  | Beta          | Beta   | /        | Beta     | Beta       | /          |
-| 7.3  | Beta          | Beta   | /        | Beta     | Beta       | /          |
-| 7.4  | Beta          | Beta   | /        | Beta     | Beta       | /          |
-| 7.5  | Beta          | Beta   | Beta     | Beta     | Beta       | Alpha      |
-| 7.6  | Beta          | Beta   | Beta     | Beta     | Beta       | Alpha      |
-| 7.7  | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.8  | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.9  | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.10 | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.11 | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.12 | GA            | GA     | Beta     | GA       | GA         | Beta       |
-| 7.13 | GA            | GA     | Beta     | GA       | GA         | Beta       |
+
+### Stack Versions
+
+Look at [Stack Versions table on master branch][stack-versions-master].
 
 ### Kubernetes Versions
 
 The charts are [currently tested][] against all GKE versions available. The
 exact versions are defined under `KUBERNETES_VERSIONS` in
 [helpers/matrix.yml][].
 
-### Helm versions
+### Helm Versions
 
 While we are checking backward compatibility, the charts are only tested with
 Helm version mentioned in [helm-tester Dockerfile][] (currently 3.5.3).
@@ -100,18 +72,6 @@ Kubernetes. There is a dedicated Helm chart for ECK which can be found
 [github releases]: https://github.com/elastic/helm-charts/releases
 [helm-tester Dockerfile]: https://github.com/elastic/helm-charts/blob/6.8/helpers/helm-tester/Dockerfile
 [helpers/matrix.yml]: https://github.com/elastic/helm-charts/blob/6.8/helpers/matrix.yml
-[operator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
+[oper ator pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
 [elasticsearch-771]: https://github.com/elastic/helm-charts/tree/7.7.1/elasticsearch/
-
-[apm-7]: https://github.com/elastic/helm-charts/tree/7.13.3/apm-server/README.md
-[apm-6]: https://github.com/elastic/helm-charts/tree/6.8.18/apm-server/README.md
-[elasticsearch-7]: https://github.com/elastic/helm-charts/tree/7.13.3/elasticsearch/README.md
-[elasticsearch-6]: https://github.com/elastic/helm-charts/tree/6.8.18/elasticsearch/README.md
-[filebeat-7]: https://github.com/elastic/helm-charts/tree/7.13.3/filebeat/README.md
-[filebeat-6]: https://github.com/elastic/helm-charts/tree/6.8.18/filebeat/README.md
-[kibana-7]: https://github.com/elastic/helm-charts/tree/7.13.3/kibana/README.md
-[kibana-6]: https://github.com/elastic/helm-charts/tree/6.8.18/kibana/README.md
-[logstash-7]: https://github.com/elastic/helm-charts/tree/7.13.3/logstash/README.md
-[logstash-6]: https://github.com/elastic/helm-charts/tree/6.8.18/logstash/README.md
-[metricbeat-7]: https://github.com/elastic/helm-charts/tree/7.13.3/metricbeat/README.md
-[metricbeat-6]: https://github.com/elastic/helm-charts/tree/6.8.18/metricbeat/README.md
+[stack-versions-master]: https://github.com/elastic/helm-charts/blob/master/README.md#stack-versions