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

[EUI+] [Spike] New docs versioning #7517

Closed
tkajtoch opened this issue Feb 7, 2024 · 2 comments
Closed

[EUI+] [Spike] New docs versioning #7517

tkajtoch opened this issue Feb 7, 2024 · 2 comments

Comments

@tkajtoch
Copy link
Member

tkajtoch commented Feb 7, 2024

Summary

We need to research the best way to add docs versioning to the new documentation site based on docusaurus. The new website will host documentation for multiple libraries versioned independently and general documentation that should always be up-to-date no matter what library version is selected.

Acceptance Criteria

  • There should be a document written documenting how the new versioning should be implemented and how we should store the older versions alongside the latest one
  • The document should include performance details for the chosen solution
@tkajtoch tkajtoch self-assigned this Feb 7, 2024
Copy link

github-actions bot commented Aug 5, 2024

👋 Hi there - this issue hasn't had any activity in 6 months. If the EUI team has not explicitly expressed that this is something on our roadmap, it's unlikely that we'll pick this issue up. We would sincerely appreciate a PR/community contribution if this is something that matters to you! If not, and there is no further activity on this issue for another 6 months (i.e. it's stale for over a year), the issue will be auto-closed.

@tkajtoch
Copy link
Member Author

We've solved it by reusing some of the logic we already created for the old documentation website.

To summarize, we have a versions.json file that keeps track of all published @elastic/eui versions. This file gets automatically updated by our release CI script. We then read it in the VersionSwitcher component and render the list in site header.

It's a straightforward solution that works because our docs website builds are static and stored in separate (and isolated) directories - public releases follow the v<SEMVER> format and PR previews the pr_<PR_ID> format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant