Skip to content

Conversation

@revitalbarletz
Copy link
Contributor

Add documentation PR reminder for next minor version after RC.
Fixes #25492

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Title of the PR
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Add documentation PR reminder for next minor version after RC.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz revitalbarletz requested review from a team as code owners January 5, 2026 10:22
@bunnyshell
Copy link

bunnyshell bot commented Jan 5, 2026

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

@revitalbarletz
Copy link
Contributor Author

@reggie-k can you take a look?

@revitalbarletz revitalbarletz changed the title Update release checklist with documentation PR step docs: Update release checklist with documentation PR step Jan 5, 2026
Signed-off-by: Revital Barletz <[email protected]>
Added sections for deprecated items and upgrade instructions.

Signed-off-by: Revital Barletz <[email protected]>
Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!
I think that the ISSUE_TEMPLATE is mainly for creating GitHub issues,so it would be better to put this template file in another place, like a new templates folder under docs or under docs/operator-manual.
I also think it is better to put the healthcheck section at the bottom of the page as it will mostly be the longest part of the doc.

revitalbarletz and others added 5 commits January 7, 2026 13:34
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz revitalbarletz requested review from a team as code owners January 7, 2026 11:38
Updated the documentation PR template link for the next minor version in the release checklist.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Copy link
Contributor Author

Thanks @reggie-k & @pjiang-dev , I have addressed your comments, please review again.

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.

Adding a template for the Argo CD version upgrade guide

3 participants