Skip to content
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

add a header for legacy version docs that they are not for current version #1389

Closed
wasaga opened this issue May 9, 2024 · 5 comments
Closed

Comments

@wasaga
Copy link
Contributor

wasaga commented May 9, 2024

image

What's incorrect or missing

The user may not necessarily notice that these are not current docs.
We've got users citing legacy version documentation every week, even if they're just starting with pomerium.

What's the resolution?

Add a header that documentation is not for current version, and link to current.

@ZPain8464
Copy link
Contributor

ZPain8464 commented May 13, 2024

I agree this would be helpful for users, especially if they're unaware they aren't on the latest version.

We could try adding an announcement bar (see below), with text like:

"You are on the Pomerium <vX.XX> docs website. This documentation is outdated. To view the latest documentation, please go to https://pomerium.com/docs."

export default {
  themeConfig: {
    announcementBar: {
      id: 'old_version',
      content:
        'You are on the **Pomerium <vX.XX>** docs website.  This documentation is outdated. To view the latest documentation, please go to https://pomerium.com/docs.'
      backgroundColor: '#fafbfc',
      textColor: '#091E42',
      isCloseable: false,
    },
  },
};

@desimone
Copy link
Collaborator

great idea. +1

@kenjenkins
Copy link
Contributor

@desimone, do you have any context on how the older docs sites are hosted? Would we need to restore some of the Git history for the docs site deleted in pomerium/pomerium#3420 in order to make updates to v0.10 through v0.17?

@ZPain8464
Copy link
Contributor

@kenjenkins and @desimone I went ahead and started implementing this, but to Ken's point, the available branches in pomerium/documentation go back to 0-17-0. Beyond that, it's difficult to retroactively add the announcement banner.

@ssveta7ak
Copy link
Contributor

Implemented.

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

No branches or pull requests

5 participants