docs: show a warning banner for the latest docs (readthedocs+mkdocs) #5855
Conversation
|
@bmartinez287 please review this 🙂 |
|
Oh fantastic! |
|
Looks good, I am testing an alternative with the announcement block bar. |
There was a problem hiding this comment.
That's great!
The below suggested change makes the language a little more explicit, e.g. removing "latest" and emphasising "unreleased", since some people might skim read and see "latest" and think "well good, im using the latest version" without realising the specific meaning here that "latest" implies "unreleased"
rfay
force-pushed
the
20240216_stasadev_warning_banner_for_latest_docs
branch
from
029461d
to
e7b3f61
Compare
|
Rebased to get docs test passing. |
rfay
changed the title
stasadev
force-pushed
the
20240216_stasadev_warning_banner_for_latest_docs
branch
from
2f51a80
to
85f87b2
Compare
|
I made it work for PRs as well and moved the warning banner, so now the menu doesn't jump, only the content: |
|
Pretty cool, that is better. |
Co-authored-by: Guy Sartorelli <36352093+GuySartorelli@users.noreply.github.com>
stasadev
force-pushed
the
20240216_stasadev_warning_banner_for_latest_docs
branch
from
85f87b2
to
ced1643
Compare
stasadev
changed the title
|
I made it work as it should. No more flickering 🎉 Updated the description. If this ever breaks, we have an alternative described in the OP. |
|
Looks great. |
| @@ -46,7 +46,8 @@ There are cases like access to hosting provider integrations that have essential | |||
| * **CircleCI**: Maintainers automatically have some access via their GitHub team membership, but should probably get more. | |||
| * **developer.apple.com**: Add to the DDEV team there so certificates can be managed. | |||
| * **hub.docker.com**: Add user to owners team in DDEV org. | |||
| * **Chocolatey**: Add user to [Manage maintainers](https://community.chocolatey.org/packages/ddev/1.22.5/ManagePackageOwners). | |||
| * **Chocolatey**: Add user to [Manage maintainers](https://community.chocolatey.org/packages/ddev/ManagePackageOwners). | |||
| * **Read the Docs**: Add user to [Maintainers](https://readthedocs.org/dashboard/ddev/users/). | |||
| @@ -62,7 +62,7 @@ These environments can be extended, version controlled, and shared, so you can t | |||
|
|
|||
| 1. Install Docker with [recommended settings](users/install/docker-installation.md#windows). | |||
| 2. Install [DDEV for Windows](users/install/ddev-installation.md#windows). | |||
| 3. Launch your [first project](users/project) and start developing. 🚀 | |||
| 3. Launch your [first project](users/project.md) and start developing. 🚀 | |||
There was a problem hiding this comment.
I wonder why these weren't caught by links check.
There was a problem hiding this comment.
I saw the warning in the build only after I fixed the deprecated emoji plugins 🙂.
The link itself works as before (mkdocs gives us some slack).
|
@mattstein do you want to take a look? |
stasadev
deleted the
20240216_stasadev_warning_banner_for_latest_docs
branch
The Issue
Alternative
How This PR Solves The Issue
Adds a warning banner.
Resources used in making this:
!syntax are set to null on mkdocs.yml readthedocs/readthedocs.org#8529Fixes mkdocs warnings on build.
Manual Testing Instructions
See https://ddev--5855.org.readthedocs.build/en/5855/
Automated Testing Overview
Related Issue Link(s)
Release/Deployment Notes
Alternative
As an alternative we could use this https://docs.readthedocs.io/en/stable/versions.html#version-warning
But it appears over and over again when you navigate the latest docs, so I decided not to use it (disabled it here https://beta.readthedocs.org/dashboard/ddev/addons/edit/).