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

Introduce changelog (vs. release notes) #3790

Merged
merged 3 commits into from
May 13, 2024
Merged

Conversation

akeller
Copy link
Member

@akeller akeller commented May 10, 2024

Description

While working on improving our release notes, our main "release notes" page still reflects language and links used previously, which are more aligned with changelogs. This PR introduces the concept on a changelog for users who want a lower level of granularity - commits, PRs, and changelog level details.

This keeps both within the release notes topic, but separates them with the proper context.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added the component:docs Documentation improvements, including new or updated content label May 10, 2024
@akeller akeller self-assigned this May 10, 2024
Copy link
Contributor

github-actions bot commented May 10, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@akeller akeller marked this pull request as ready for review May 13, 2024 15:35
@akeller akeller merged commit 30ea161 into main May 13, 2024
9 checks passed
@akeller akeller deleted the release-notes-changelogs branch May 13, 2024 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants