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

feat(releaseNotes): provide more detailed notes #3800

Closed
wants to merge 2 commits into from

Conversation

MaxTru
Copy link
Contributor

@MaxTru MaxTru commented May 14, 2024

Hi @akeller ,

with this PR I am suggesting some pragmatic improvements to the release notes pages. I thought about the following:

  • Grouping: I used the buttons to indicate which components are affected by an enhancement. Maybe another tool than "buttons" are more effective to do that (the current buttons impact the heading anchor, which doesn't make sense). I think some sort of grouping is important given we have more an more features for a release.
  • Release Dates: This is IMO a key info.
  • Links to full changelog: This allows technically interested users to find out more.

Can you please drive this further?

Description

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/).

* Grouping
* Release Dates
* Links to full changelog
@MaxTru MaxTru requested a review from akeller May 14, 2024 13:31
Copy link
Contributor

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/reference/release-notes/860.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label May 14, 2024
@akeller
Copy link
Member

akeller commented May 14, 2024

@MaxTru, quick comment - We have release dates available on the Announcements page. Do you expect them in both places?

Similar question, the release blog and release notes (or what I start to refer to as the changelog) are on the Update guide. Do you expect them in both places?

I'll use this as the next iteration after #3785.

@MaxTru
Copy link
Contributor Author

MaxTru commented May 14, 2024

@MaxTru, quick comment - We have release dates available on the Announcements page. Do you expect them in both places?

I think it makes sense to have them in both places, yes.

On-top, I think we should deep-link from the announcements page, to release notes page.

Similar question, the release blog and release notes (or what I start to refer to as the changelog) are on the Update guide. Do you expect them in both places?

Why do we link the changelog from the update guide? I think linking them from release notes would make more sense, doesn't it? Same for link to blog post.

@akeller
Copy link
Member

akeller commented May 14, 2024

Why do we link the changelog from the update guide? I think linking them from release notes would make more sense, doesn't it? Same for link to blog post.

No reason, just history. Update guide came first. 🙂

Will take it from here in iterations and add to https://github.com/camunda/developer-experience/issues/304.

@akeller akeller added the hold This issue is parked, do not merge. label May 14, 2024
@akeller akeller self-assigned this May 14, 2024
@akeller
Copy link
Member

akeller commented May 30, 2024

Closing this will create a new issue, specifically around the groupings.

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 hold This issue is parked, do not merge.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants