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 links to 8.5 release notes #3785

Merged
merged 4 commits into from
May 15, 2024
Merged

Add links to 8.5 release notes #3785

merged 4 commits into from
May 15, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented May 9, 2024

Description

Improves the release notes MVP. Related to https://github.com/camunda/developer-experience/issues/304.

  • Commented links to epic PRs (some epics are very difficult to trace back to the docs PR, making the potential to automate this in the future very difficult)
  • Where possible, found significant documentation update to link to
  • Some epics have no documentation updates and do not have links to docs
  • Some epics are relatively straightforward UI updates and were not easy to link, so no link was provided
  • Some epics have a lot of conceptual or architecture changes, and linking to a single source didn't make sense. Instead, no links were provided.

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 9, 2024
@akeller akeller self-assigned this May 9, 2024
@akeller akeller requested a review from MaxTru May 10, 2024 15:21
@akeller
Copy link
Member Author

akeller commented May 10, 2024

@MaxTru this is still in draft, but I'm not able to find links to all the documentation PRs easily and in some cases, the changes were really small and only warranted a one-liner change that's not easily linked.

WDYT about this as a good final iteration for 8.5 release notes? I'd like to shift my focus to improving the PDP hygiene to make getting this information into the PR easier and even automated.

@akeller akeller marked this pull request as ready for review May 14, 2024 18:58
@akeller
Copy link
Member Author

akeller commented May 14, 2024

@christinaausley given CamundaCon this week, I'll follow up with @MaxTru separately on my comment, but I think this is a huge improvement as-is.

@akeller akeller merged commit f81a343 into main May 15, 2024
10 checks passed
@akeller akeller deleted the add-links-to-release-notes branch May 15, 2024 15:04
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