ECH available stack versions statements updated #4607
Conversation
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
🔍 Preview links for changed docs |
jakommo
left a comment
jakommo
left a comment
There was a problem hiding this comment.
Thank you Edu! Left two small comments. But LGTM
| * {{version.stack | M.M }} and {{version.stack | M.M+1 | M.M }} | ||
| * 8.19 | ||
|
|
||
| Additional versions can appear in the UI, such as [release candidate builds](#ec-release-builds) or older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. |
There was a problem hiding this comment.
| Additional versions can appear in the UI, such as [release candidate builds](#ec-release-builds) or older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. | |
| Additional versions can appear in the UI, such as [release candidate builds](#ec-release-builds) or older versions that you have a running deployment on. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. |
There might be better ways to say thif, but basically if you run a non-EOL version that doesn't match the definition in https://github.com/elastic/docs-content/pull/4607/changes#diff-6f210dc543344c05d32b32b3e89f7efa7fbccb88e4bc6baeabd1394ff341ced2R29-R30 they will also show up as available version to allow spinning up a clone to test upgrades etc.
There was a problem hiding this comment.
Should we also add a link to https://www.elastic.co/docs/reference/cloud/cloud-hosted/ec-api-deployment-crud#ec_using_the_api_to_create_deployment_with_non_eol_versions and say that any non-EOL version can be deployed via API?
There was a problem hiding this comment.
Great point @jakommo , I'll find a way to include your first statement properly, so users understand that they will also have available their "currently used" versions as long as they are supported.
About your second question:
Should we also add a link to https://www.elastic.co/docs/reference/cloud/cloud-hosted/ec-api-deployment-crud#ec_using_the_api_to_create_deployment_with_non_eol_versions and say that any non-EOL version can be deployed via API?
That's your & PM decision I'd say. I don't have any strong opinion. Considering your background and experience in this area, I'd do whatever you suggest, or if you prefer to double check with a PM that's totally ok too.
There was a problem hiding this comment.
I'd say let's add a link to the API instructions. It's already in the public docs and if a user reaches out to support we well them the same, so I see no reason to "hide" this.
| {{stack}} uses a version numbering scheme based on three numbers separated by dots. The leftmost number indicates the major release, the middle number indicates the minor release, and the rightmost number indicates the maintenance release. For example, `8.3.2` represents major release 8, minor release 3, and maintenance release 2. | ||
|
|
||
| You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](#ec-release-builds) and older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. | ||
| In {{ech}}, not all [{{stack}} versions](https://www.elastic.co/support/eol) are available for deploying. By default, the following versions are available in the UI: |
There was a problem hiding this comment.
| In {{ech}}, not all [{{stack}} versions](https://www.elastic.co/support/eol) are available for deploying. By default, the following versions are available in the UI: | |
| By default, the following versions are available in the {{ech}} UI: |
Trying to make this sound more positive (the "not all stack versions are available" has a bit of a negative touch IMHO) but free free to reword or disregard this suggestion.
Improvement of the available stack versions on ECH.
Closes #1397
Needs elastic/docs-builder#2454 to be able to render the previous minor version (
{{version.stack | M.M-1 | M.M }}). If we don't add that feature we can hardcode the example in the doc, but it would look much better showing always the latest 2 minors that are available, for reference purposes.Update: to be able to create the preview properly I'm temporary changing the mutation to
{{version.stack | M.M+1 | M.M }}for reference purposes.