[DOCS] Add docs versioning comment action #132257
Closed
+78
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a friendly automated reminder on PRs that modify documentation files to help enforce our cumulative documentation guidelines.
.md
files in thedocs/
directoryapplies_to
tagging requirementsAs we've transitioned to cumulative documentation where all 9.x versions share a single page, contributors need clear guidance on properly tagging version-specific content rather than replacing information for older versions.
Uses
github-script
to:.md
file changes indocs/
directoryPreview
The comment will look like this when rendered:
ℹ️ Important: Docs version tagging
👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.
We use
applies_to
tags to mark version-specific features and changes.Expand for a quick overview
When to use
applies_to
tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g.
preview
,ga
) in a specific version✅ When availability differs across deployments and environments
What NOT to do:
❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an
applies_to
tag❌ Don't forget that
applies_to
tags can be used at the page, section, and inline level🤔 Need help?