-
Notifications
You must be signed in to change notification settings - Fork 123
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
Provide slider for choosing a stream for examples. #395
Comments
The slider can just be some site-wide JavaScript that knows how to do the substitution. Antora shouldn't need to know about it. The |
👍 - Unfortunately I know nothing about web development, so really don't know how easy or hard things are. I assumed this would be hard because we're using some tools to generate the site and wasn't sure how hard it would be to go outside their normal feature set.
Thanks for the context. |
Born from this PR discussion.
We have
{stable-version}
throughout a few of our docs pages that gets substituted with the current value ofstable-version
fromantora.yml
:fedora-coreos-docs/antora.yml
Line 11 in 0790bcd
This means that examples can be copy/pasted directly and the user is using the latest stable version at that point in time. The problem is, what if the user wants to use a different stream? Some of our docs pages have the user choose by setting a
STREAM=
env var and then downloading/choosing artifacts that way and then setting anFCOS_VERSION
env var that can be used for later operations.I propose that we either give the user some slider to be able to auto update examples for copy/pasting or we maybe do away with the
{stable-version}
substitution. The problem with the slider is that I don't know how we would pull that off with the current tooling that we have for generating the docs.The text was updated successfully, but these errors were encountered: