stackabletech / documentation-ui

Mozilla Public License 2.0
1 stars 0 forks source link

feat: banner to warn users when they look at documentation for an outdated platform version #36

Closed fhennig closed 8 months ago

fhennig commented 1 year ago

To prevent users from accidentally looking at documentation that might be outdated, we should add a banner or info box somewhere on the page that indicates that the version is not the latest.

This might also help with SEO, as every old page will link to the new page, giving the new/stable pages more weight.

Others do it as well:

Which versions are outdated?

We should display such a banner on versions that are 'end of life' which are all versions that are more than 12 months old.

It would be good to manually set an eol flag in the antora.yml in each branch and display the banner based on that.

For example like this:

asciidoc:
  attributes:
    # Whether this version is already end of life. 
    # If true, a banner will be displayed informing the user.
    end-of-life: true
    # to make attributes accessible to the UI template, they need to
    # be prefixed with "page-"
    page-end-of-life: "{end-of-life}"

Acceptance criteria

fhennig commented 1 year ago

Open questions: