Skip to content

Add "Warning/Tip" to top of older Release Notes that they might have outdated infoΒ #1501

Open
@NotTheDr01ds

Description

@NotTheDr01ds

As mentioned #536, search results can surface some pretty old Release Notes that have outdated info. A couple of options:

  1. Leave it as it is

  2. Review each release note and edit to highlight outdated info

  3. Just add a warning header (yellow formatting in the theme) to the top of older (say 5 releases back and older) release notes with something like (first pass):

    These are the Release Notes for <version>. If you have arrived here via Search, please keep in mind that information here may (or may not ) be outdated. Features may have been renamed, functionality added or removed, or other changes may have been made after this Release. Please refer to the other documentation sources on this site for updated information.

I'd vote for the third, personally. Regarding 2 - I think Release Notes are a historical archive and shouldn't be changed post de defacto. It would also be a major (and continual) undertaking to review and update.

While the first option is a possibility, the point made in #536 is a fair one that I'd like to see addressed in some way.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions