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 versioning to product docs #3104

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

vipulgupta2048
Copy link
Member

@vipulgupta2048 vipulgupta2048 commented Nov 15, 2024

This pull request introduces an automated script for managing documentation versions for product docs. This enables dynamic version tracking according to our set deprecation policy, providing users with the docs that need right where they need it.

Screenshot 2024-11-14 at 7 25 50 PM

How does it work

  • Fetch all semantic version tags from GitHub repositories with release dates
  • Automatically identify and label latest and deprecated versions according to deprecation policy
  • Generate version configuration files
  • Download documentation files for compatible versions

The selection algorithm is a codified version of the deprecation policy

  • Prioritizes the latest major version
  • Includes versions within one year of the latest release
  • Ensures at least 5 major versions are captured when possible
  • Automatically labels versions as "latest" or "deprecated"

@vipulgupta2048 vipulgupta2048 force-pushed the vipulgupta2048/version branch 2 times, most recently from 51d06bb to 87c20bc Compare November 15, 2024 10:09
Copy link
Contributor

flowzone-app bot commented Nov 15, 2024

Website deployed to CF Pages, 👀 preview link https://f848d21b.balenacloud-docs.pages.dev

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

Successfully merging this pull request may close these issues.

1 participant