[Initiative]: Release Notes Best Practices

[angellk]

Name

Release Notes Best Practices

Short description

Release Notes Best Practices

Responsible group

TAG Operational Resilience

Does the initiative belong to a subproject?

Yes

Subproject name

No response

Primary contact

N/A

Additional contacts

n/a

Initiative description

What are the best practices for Release Notes?
Adopters review release notes in order to determine whether to move to a new release. If the release notes do not give thorough information, adopters are unable to make an informed decision to move to a new release.

Deliverable(s) or exit criteria

Document describing the best practices for a release document.

Tracking document for meeting and progress

n/a

[abhay1999]

Hi, I’d like to work on this initiative by drafting a "Release Notes Best Practices" document for CNCF projects. My plan is to survey existing release notes from several CNCF projects, propose a recommended structure (sections like breaking changes, upgrade steps, security fixes, known issues, etc.), and then open a PR with a Markdown guide for review by TAG Operational Resilience and the TOC. Please let me know if there is a preferred location in this repo (or another) where the document should live, otherwise I will create a draft in the docs section of this repository.

[krol3]

Hi, I’d like to work on this initiative by drafting a "Release Notes Best Practices" document for CNCF projects. My plan is to survey existing release notes from several CNCF projects, propose a recommended structure (sections like breaking changes, upgrade steps, security fixes, known issues, etc.), and then open a PR with a Markdown guide for review by TAG Operational Resilience and the TOC. Please let me know if there is a preferred location in this repo (or another) where the document should live, otherwise I will create a draft in the docs section of this repository.

Hi @abhay1999 , please join to our Monthly TAG Operational Resilience to discuss more how to start and work in this initiative

[abhay1999]

Thanks @krol3! I'll join the next Monthly TAG Operational Resilience meeting. Could you share the meeting link or calendar invite?