-
Notifications
You must be signed in to change notification settings - Fork 98
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
Add Release Candidate Banner #695
Comments
Yeah I agree, the banner should be rewritten in a way we can put any text in there. Another candidate would be: Unsupported for very old releases. |
Implemented in #710 |
This is still open issue. The goal of this banner is to inform users that the documentation they're reading documentation for a version that's not intended for production. |
I had something as follows in mind saying "Update now": source: https://simonwhitaker.github.io/github-fork-ribbon-css/ |
Probably. If you look at an unsupported version on the current website you can see a block on the top left: https://theforeman.org/manuals/3.11/index.html. Right now we don't have an RC available, but https://theforeman.org/manuals/nightly/index.html also shows "Not yet released".
I wonder if we should group things under headers instead of listing it for every item. Basically:
It kind of does mean that. We want users on supported releases. All guides are published for historic reasons, but mostly so users can upgrade. You can argue they only need the upgrade guide, but in my experience it can be very useful to compare different releases.
That could work, especially if it directs you to the correct upgrade guide though that always is a bit tricky. Previously we had |
To summarize what we want:
|
A possible solution that is based on pure asciidoc is to add a section to master.adoc, but include it only for pre-release/unsupported versions (with section numbering disabled). A section like that would be displayed at the beginning of each guide + in the ToC, essentially working as a banner of sorts. A fancier solution is to add a ribbon or a banner in the header (anything that stays in view and doesn't disappear with scrolling) but there I don't know how to make it show only for the pre-release and unsupported versions. Is there anyone who might be able to take a stab at this? Or do you think it's good enough if I just go with the simple asciidoc solution? |
Just as @upadhyeammit is doing theforeman/theforeman.org#1887
We need to have an RC banner.
The text was updated successfully, but these errors were encountered: