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 support for versioned content #49

Open
bmorelli25 opened this issue Nov 11, 2024 · 0 comments
Open

Add support for versioned content #49

bmorelli25 opened this issue Nov 11, 2024 · 0 comments

Comments

@bmorelli25
Copy link
Member

Summary

While we're not yet sure what our versioning scheme will look like in 9.0, we know that we're going to need to support versioning in some capacity.

Important

See this internal Google Doc for up-to-date information.

To be determined

  • Everything, really
  • How many versioning schemes we need to support
  • How deployment types play into versioning
  • And more! (see google doc)

Potential Requirements

This list comes from a previous versioning requirement doc. Do not take this as fact.

  • We will likely need to support multiple version schemes, for example, the Elastic Stack versioning scheme and other secondary versioning schemes, like for APM agents, integrations, and more.
  • It should be obvious when a user is viewing documentation for the current version.
  • It should be obvious when a user is viewing documentation for a previous version.
  • It should be easy for users to navigate between versions—even if the current page that they are on does not exist in the version they are navigating too.
  • It should be possible to link between versioned content and links should be checked to ensure they work.
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

2 participants