-
Notifications
You must be signed in to change notification settings - Fork 159
Update ECE docs to use version variable #1790
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🔍 Preview links for changed docs:
🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes. |
Thousand thanks for this!!!
Edu González de la Herrán
Senior Technical Writer @ Elastic
*Please note: Emails may be stored and shared to provide a better customer
experience. To learn more about how we use your information, please review
Elastic’s **Privacy Statement. *
<https://www.elastic.co/legal/privacy-statement>
El El mié, 18 jun 2025 a las 17:58, David Kilfoyle ***@***.***>
escribió:
… This adds an ece_version variable to make life a little easier for us on
ECE release days. In addition to updating the variable we also need to
append the default system deployment versions
<https://github.com/elastic/docs-content/blob/main/deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md?expand=1>
table.
I've updated the ECE docs release issue template accordingly, via
elastic/dev#3187 <elastic/dev#3187>.
Closes: #1789 <#1789>
@eedugon <https://github.com/eedugon> I know you mentioned that you were
willing to do this, but since I had the release bump PRs in front of me I
figured I'd just push the changes myself. Hope that's okay. :-)
------------------------------
You can view, comment on, or merge this pull request online at:
#1790
Commit Summary
- b3c7e80
<b3c7e80>
Update ECE docs to use version variable
File Changes
(5 files <https://github.com/elastic/docs-content/pull/1790/files>)
- *M*
deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md
<https://github.com/elastic/docs-content/pull/1790/files#diff-a2d2a614d0154893985014e1ab10c4e779b3c9623a1f8de8c59d47c789aff2f3>
(4)
- *M*
deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md
<https://github.com/elastic/docs-content/pull/1790/files#diff-6c8a9846ab45c99ae17d7d194e1cfc427ccd8fa62a9adb9a6377f3efd6e944b3>
(10)
- *M*
deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md
<https://github.com/elastic/docs-content/pull/1790/files#diff-0ee738009c85c47b97d8a0dcdc1b252c350810d149e11b86efe05bd43a0fef80>
(10)
- *M* deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md
<https://github.com/elastic/docs-content/pull/1790/files#diff-738e0056dc4f7e17ddaac203bd5241d7b9759f2f597c1333fbc520adf77abfe3>
(14)
- *M* docset.yml
<https://github.com/elastic/docs-content/pull/1790/files#diff-b27112c0b78d17ae0965f527c87ba54df2567a4f523ff0a693d31d3de8f1d31a>
(1)
Patch Links:
- https://github.com/elastic/docs-content/pull/1790.patch
- https://github.com/elastic/docs-content/pull/1790.diff
—
Reply to this email directly, view it on GitHub
<#1790>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AGBFXJNZBT5PD3VUXKUC6233EGEDJAVCNFSM6AAAAAB7TRLOUOVHI2DSMVQWIX3LMV43ASLTON2WKOZTGE2TONBRGQ4TKMQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
A few small suggestions:
- For the
system deployment versions reference file
(not touched in this PR) it would be great to have it using this variable, at least for the latest release. Then whenever we prepare a new release we just need to add one line, while keeping the latest with the variable. What do you think? THe benefit will be that just searching for{{ece_version}}
we will also find that file in the future.
|
||
```sh | ||
docker save -o ece.4.0.1.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1 | ||
docker save -o ece.{{ece_version}}.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need subs=true in all code blocks if they use variables.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching that!
It's a great idea, however I worry that it's a bit confusing that the line someone needs to add to the table would be for the previous release. At least, I would find that a bit unintuitive. I put a checklist item in the docs ECE release template saying that we need to add a new line to the system deployment versions table, with a direct link. So that should help make sure people find it and they wouldn't need to search on the Also, I included a comment |
This adds an
ece_version
variable to make life a little easier for us on ECE release days. On each release day we'll now need to:I've updated the ECE docs release issue template accordingly, via https://github.com/elastic/dev/pull/3187.
Closes: #1789
@eedugon I know you offered to do this, but since I had the release bump PRs in front of me I figured I'd just push the changes myself. Hope that's okay. :-)