Add is-current-version attribute #2044
Conversation
dedemorton
left a comment
dedemorton
left a comment
There was a problem hiding this comment.
LGTM.
I think the value of putting this in a central location outweighs the minor inconvenience of having an extra setting to change at release time. Plus if someone forgets, that's OK because it just means that the video will display in older versions (not a deal breaker).
It's been awhile since I've bumped doc versions, but beats has a script they use. If we don't have that for the docs build, might be time to add it (general comment, not intended for this PR).
gtback
left a comment
gtback
left a comment
There was a problem hiding this comment.
I'm 👍🏻 with this approach. It's not the most elegant, but practicality beats complexity 😁
|
This reminds me of the work @nik9000 did to create a {source_branch} attribute seamlessly for us to use via #1147. Since "current" is currently defined in the conf.yaml, it would have been nice to have the build therefore set an "isCurrent" attribute (or whatever) from that info too. But I don't think it's worth investing time in a fancy solution like that in the current system. |
lcawl
left a comment
lcawl
left a comment
There was a problem hiding this comment.
Added comments and link for future vision, but LGTM in current world
4 participants
Summary
This PR proposes the addition of a new shared attribute,
is-current-version.is-current-versionwill be set totruein the currently released stack version, andfalsein all other versions.Release
At each minor and major release, a two-line update will be required. The previously current version will need to be set to
false, and the newly current version will need to be set totrue.For example, in the 7.11 release,
shared/versions/stack/7.10.asciidocwill set:is-current-version:tofalseandshared/versions/stack/7.11.asciidoc:will set:is-current-version:totrue.If Greg and Lisa are cool with this, I'll update the release documentation as well.
Related
Required for elastic/observability-docs#350.