djangoproject.com icon indicating copy to clipboard operation
djangoproject.com copied to clipboard

Docs for old supported versions should indicate that a newer version is available

Open rolandcrosby opened this issue 3 years ago • 6 comments

I ended up on the Django 2.2 version of the "Writing your first app" tutorial via web search, and didn't realize I was looking at outdated docs until I noticed the URL a few pages in. I realize that 2.2 is still getting extended support, but regardless this probably isn't the version of the tutorial that most people want, and the design of the page gives no indication that you're not looking at the latest version. Completely unsupported docs like those for 1.8 have a helpful banner at the top of the page indicating that the version isn't supported. I'm not saying a big scary red banner is necessary for old versions that are still supported, but some indication that there are newer versions would be nice.

This is a problem that a lot of projects face and solve in different ways - some examples below.

Examples of how other projects deal with this
  • Postgres has a prominent version switcher at the top of every docs page indicating what versions are supported, plus a warning when you're looking at an unsupported version:

Postgres docs version switcher

  • Docs sites that use Read The Docs have a nice little "there is a newer version available" note at the top of outdated pages: Requests outdated version indicator

standard RTD newer version indicator (csvkit)

  • CockroachDB provides an explicit warning on docs for old versions to indicate when they will stop being supported: CockroachDB support warning

rolandcrosby avatar Nov 15 '21 14:11 rolandcrosby

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 04 '22 12:10 stale[bot]

This is not stale. This is to be implemented.

CuriousLearner avatar Oct 04 '22 12:10 CuriousLearner

Hi @pauloxnet can I work on this issue? I think it's good to introduce me to the Django project 😊

EliphazBouye avatar Nov 29 '22 08:11 EliphazBouye

In the documentation I already see banners for unsupported versions and for the development version, I'm not sure if you want to show warnings for supported Django versions as well, for example 3.2 LTS could legitimately be used with the intend to update only when the next LTS release comes out, so it might be annoying for users to see warnings in this case.

I'd like to read other people's comments on this issue as well before implementing anything without a thought.

pauloxnet avatar Nov 29 '22 14:11 pauloxnet

Okay, I see. So I will wait :)

EliphazBouye avatar Nov 30 '22 08:11 EliphazBouye

I think we should implement this because I have faced this issue myself many times, it can be a closable warning and a subtle one as to not irritate the users. Or we can have a Don't show this again button as well.

VaarunSinha avatar Feb 13 '24 10:02 VaarunSinha