Skip to content
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

Open
melcorr opened this issue Aug 26, 2021 · 8 comments · May be fixed by #3653
Open

Add Release Candidate Banner #695

melcorr opened this issue Aug 26, 2021 · 8 comments · May be fixed by #3653
Assignees

Comments

@melcorr
Copy link
Member

melcorr commented Aug 26, 2021

Just as @upadhyeammit is doing theforeman/theforeman.org#1887
We need to have an RC banner.

@lzap
Copy link
Member

lzap commented Sep 3, 2021

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.

@lzap
Copy link
Member

lzap commented Sep 3, 2021

Implemented in #710

@ekohl
Copy link
Member

ekohl commented Mar 21, 2024

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.

@aneta-petrova
Copy link
Member

Where exactly should the banner be shown? In every guide published for a version that's not intended for production?

The version dropdown currently includes nightly/supported/unsupported:
Screenshot From 2025-01-10 15-19-46
I take it we're looking for something more than this? That "nightly/unsupported" doesn't automatically mean "not intended for production"?

@maximiliankolb
Copy link
Contributor

I had something as follows in mind saying "Update now":

image

source: https://simonwhitaker.github.io/github-fork-ribbon-css/

@ekohl
Copy link
Member

ekohl commented Jan 10, 2025

Where exactly should the banner be shown? In every guide published for a version that's not intended for production?

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".

The version dropdown currently includes nightly/supported/unsupported:

I wonder if we should group things under headers instead of listing it for every item. Basically:

  • Prerelease
    • Nightly
    • RC (if any)
  • Supported
    • 3.13
    • 3.12
  • Unsupported
    • 3.11
    • 3.10
    • ...

I take it we're looking for something more than this? That "nightly/unsupported" doesn't automatically mean "not intended for production"?

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.

I had something as follows in mind saying "Update now":

That could work, especially if it directs you to the correct upgrade guide though that always is a bit tricky. Previously we had ProjectVersionNext or something to store that, but it's something extra to maintain.

@aneta-petrova
Copy link
Member

To summarize what we want:

  • A banner that says "Pre-release version", displayed in each guide for nightly and release candidate
  • A banner that says "Unsupported version", displayed in each guide for an unsupported release. This should also link to somewhere useful (perhaps simply just to the landing page which explains the context of supported/unsupported versions?)

@aneta-petrova
Copy link
Member

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?

@aneta-petrova aneta-petrova self-assigned this Feb 11, 2025
@aneta-petrova aneta-petrova linked a pull request Feb 11, 2025 that will close this issue
9 tasks
@aneta-petrova aneta-petrova linked a pull request Feb 12, 2025 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment