Add a banner for unsupported and pre-release #3653
Conversation
github-actions
bot
added
Needs tech review
guides/common/header.adoc
Outdated
| @@ -6,10 +6,22 @@ | |||
| :toclevels: 3 | |||
| ifndef::satellite[] | |||
| :docinfodir: common | |||
| ++++ | |||
There was a problem hiding this comment.
Using passthrough blocks like this is ugly but I couldn't find a better way.
aneta-petrova
removed
Needs testing
|
This seems to break some guides and while I don't know why yet, this is what the banners look like locally:
|
aneta-petrova
force-pushed
the
ribbon
branch
2 times, most recently
from
93187ed to
80916b6
Compare
|
Something about adding the ribbon made GHA suddenly remember that there are a few issues with incorrect heading levels. So I'm now including a few lines to fix these headings. I also moved the ribbon to the bottom right corner where it's arguably easier to overlook but at least it doesn't overlap with anything important like the version dropdown. |
I think the banners should be fixed so that they don't go away with scrolling. Users should see them at all times, not just when they open a guide for the first time. I reverted to the top-right position. You can take a look at any non-satellite guide preview to check it out:
This is not great but I can only assume that I could tweak the position of the ribbon to make it start below the blue top menu bar so that there is no overlap? I haven't really tried yet, though.
I'd rather keep the wording as clear as possible and I don't think the "RC" acronym is quite that. I chose "pre-release" based on #695 (comment) and was hoping that because the ribbon links to the docs.theforeman.org main landing page, all the supported/unsupported/supported RC context will be clarified there. |
aneta-petrova
force-pushed
the
ribbon
branch
from
60360f0 to
59fc1b6
Compare
aneta-petrova
force-pushed
the
ribbon
branch
2 times, most recently
from
fa54312 to
54767c1
Compare
Add a ribbon Credit: https://simonwhitaker.github.io/github-fork-ribbon-css/ Display ribbon only if unsupported or pre-release
This reverts commit d4a34b2.
aneta-petrova
force-pushed
the
ribbon
branch
from
54767c1 to
b5bc07a
Compare
|
Notes from today's triage: Generally, ack. The only real blocker is the overlap described in #3653 (comment). @kmalyjur can help with that. We also discussed possibly using a different color that's more aligned with the Foreman color palette. That decision doesn't have to be made as part of this PR, it can be a follow up. |
Co-authored-by: Ewoud Kohl van Wijngaarden <[email protected]>
What changes are you introducing?
This should show a banner/ribbon for all guides in nightly and unsupported releases, with a link leading to the main docs.theforeman.org page where users can read more information on supported releases.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Solution suggested in #695 (comment)
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Credit: https://simonwhitaker.github.io/github-fork-ribbon-css/
Checklists
Please cherry-pick my commits into: