Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

use announce section in material theme #3423

Merged
merged 2 commits into from Feb 10, 2021
Merged

use announce section in material theme #3423

merged 2 commits into from Feb 10, 2021

Conversation

dholbach
Copy link
Member

	Fixes: #3422

Signed-off-by: Daniel Holbach <daniel@weave.works>
@hiddeco hiddeco added the docs Issue or PR relates to documentation label Feb 10, 2021
@dholbach
Copy link
Member Author

The thing is, @alisondy pointed out that this is just going to be reflected in our last /stable/ release. I checked if there's a global readthedocs way to resolve this, but I couldn't find it. This might be the only way to do it. The most global it will easily get. 🤷

Co-authored-by: Hidde Beydals <hiddeco@users.noreply.github.com>
Signed-off-by: Daniel Holbach <daniel@weave.works>
@hiddeco
Copy link
Member

hiddeco commented Feb 10, 2021

@dholbach I think we may be able to enable the feature that warns people if they are not looking at the latest version of the documentation (with a likewise banner), that would guide them towards the right message.

@alisondy
Copy link

https://docs.readthedocs.io/en/stable/versions.html#version-warning ? 👀

@dholbach
Copy link
Member Author

https://docs.readthedocs.io/en/stable/versions.html#version-warning ? eyes

Looks like it's only available for Sphinx projects (we're using mkdocs).

@hiddeco
Copy link
Member

hiddeco commented Feb 10, 2021

Then there is little we can do I am afraid :-(

@alisondy
Copy link

@dholbach
Copy link
Member Author

The way I understand https://github.com/shopsys/readthedocs-version-warning-mkdocs-plugin/blob/master/mkdocs_version_warning/__init__.py#L41-L50 is that the banner text is fixed?

But thanks for looking. Maybe we'll find another plugin?

@dholbach
Copy link
Member Author

@dholbach
Copy link
Member Author

Maybe we land this change first, as it will at least resolve things for ALL pages of /stable/ and /latest/ and next we worry about old releases?

Is the look of it too disruptive?

@dholbach dholbach merged commit 6a50112 into fluxcd:master Feb 10, 2021
@dholbach dholbach deleted the fix-3422 branch February 10, 2021 16:21
@kingdonb kingdonb mentioned this pull request Feb 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Issue or PR relates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

create a giant warning banner on flux v1 docs
3 participants