Skip to content

Add link to 'Stable' doc version in the Warning Alert on top #2101

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ulgens
Copy link
Member

@ulgens ulgens commented Jun 17, 2025

Resolves #2094

CleanShot 2025-06-17 at 16 23 53@2x

I copied the link from "Installation guide" link on the sidebar, please let me know if we prefer a different target for the link.

CleanShot 2025-06-17 at 16 28 53@2x

I'm open to suggestions about wording and styling.

@AyushPatiTripathi
Copy link

@ulgens

Thanks for pushing this PR! Since the main logic is in place and you're open to someone continuing the work, I'd love to take it forward and handle the remaining styling updates.

@ulgens
Copy link
Member Author

ulgens commented Jun 18, 2025

@SomeAB @sabderemane Do you have any recommendations for styling? I think the default styling for this link looks a bit weird, but I'm not sure what would be the correct way.

@SaptakS
Copy link
Contributor

SaptakS commented Jun 25, 2025

  • Styling: I would not even make it a separate color. I would probably leave it the same color with underline. That is a good enough styling for inline links.
  • Wording: I would word the sentence something like "Please check the latest version.", with the "latest version" anchor linked. "here" is usually not a good word to link.

@SomeAB
Copy link

SomeAB commented Jun 30, 2025

@ulgens Please feel free to ping me on discord or here. I'm more active on discord. Sorry for the delay in reply

A. Regarding the wording: I would personally recommend: "Please click here for the stable version"

Rationale: saying 'stable' instead of 'latest' is more inline with the previous sentence, which points at the depreciation of the doc version currently being viewed. Implicitly, we are recommending the latest LTS (link should point to LTS version given its long term support)

Two ways of highlighting: 'here' or here

B. Regarding Color: I agree with SaptakS here, that making it as the same color (dark) is preferable.

Rationale: Given the Django website uses an unusual combo of peach-pink with leaf-green, introducing new colors would just stick out badly. The highlight is suppose to be just a small nudge .. just enough to tell that it is clickable


Preview of two versions:

This document is for an insecure version of Django that is no longer supported. Please click 'here' for the stable version.

This document is for an insecure version of Django that is no longer supported. Please click here for the stable version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add link to 'Stable' doc version in the Warning Alert on top
4 participants