Skip to content

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Apr 14, 2025

ECK substitutions applied, using current asciidoc (2.16) substitutions as reference.

eck_helm_minimum_version is an improvement as the minimum supported helm version appeared hardcoded in multiple docs.

Note that in the current asciidoc we also have a substitution like eck_github: https://github.com/elastic/cloud-on-k8s not used here. If that's considered useful I can apply it everywhere also.

Pending to determine if we should add also eck_crd_version the same way it was used in original asciidoc files.

Comment on lines +275 to +276
eck_release_branch: "3.0"
eck_helm_minimum_version: "3.2.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC these fields are going to be maintained by the ECK team? If it is the case we should update our release issue template: https://github.com/elastic/k8s-dev/blob/main/.github/ISSUE_TEMPLATE/release-issue-template.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@barkbay , yes, you will be in charge of maintaining the V3-docs after 9.0 / 3.0.0 releases.

Now the majority of ECK docs are in docs-content, while release notes, known issues, breaking changes, etc are kept in the cloud-on-k8s repo.

That means that for the moment the substitution variables need to be maintained in both places. Although I've heard from @bmorelli25 that we have plans to improve this and provide a single point for the global variables definition and maintenance.

Do you want me to write a PR or an issue to update your k8s-dev releases template? Although I'm not familiar with your overall releasing procedure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want me to write a PR or an issue to update your k8s-dev releases template? Although I'm not familiar with your overall releasing procedure.

I update the last step in the release process to not forget to update this template. See the last step in the "Post release" section here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect! In that template I still see mentions to the old asciidoc files and not to the new markdown docs.
Remember that now we don't use the asciidoc system anymore and some of the docs that appear in the template doesn't exist in main.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @eedugon and @barkbay I will make sure the references to asciidoc are updated and also will add the other changes to the releasee template

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect @kvalliyurnatt, thanks! If you need any help or information from my side about new docs system or when to touch the old asciidoc files (available only for 2.x branches), ping me in private!

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

variables lgtm.

@eedugon eedugon enabled auto-merge (squash) April 15, 2025 07:50
@eedugon eedugon merged commit 59ae70a into main Apr 15, 2025
3 of 4 checks passed
@eedugon eedugon deleted the eck_version_substitution branch April 15, 2025 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants