Azure / bicep

Bicep is a declarative language for describing and deploying Azure resources
MIT License
3.26k stars 754 forks source link

Explore alternative/additional ways to share release notes #14703

Open alex-frankel opened 3 months ago

alex-frankel commented 3 months ago

Currently we share our new releases in the following formats:

@miqm brought up that these are not always the easiest to follow, so we discussed a few additional options:

Open question: can we use a copilot to assist with the drafting process?

Options:

slavizh commented 3 months ago

In favor of blog post or vscode. Also it is hard to understand where the docs for the new features land and when.

ahelland commented 3 months ago

Good release notes are always appreciated.

I appreciate the work the VS Code team puts into their release notes. Might just be me though, but the release notes directly in VS Code in a sense break my flow so I often end up dismissing them to get on with work and not revisit them. Extensions in VS Code are less intrusive so I often take a look at the changelog before restarting the extension. (Though you probably don't want a ten page changelog - it would be better to link to separate notes for that purpose.)

Release notes on a blog is something I'm more likely to read at my own leisure. I feel the blogs under devblogs.microsoft.com offer slightly better readability than the ones under techcommunity.microsoft.com. (I feel authoring blogs on Tech Community is slightly clunky too, but that's a different topic.)

The bigger job with release notes is to bringing the right mix of content - bug fixes are ok to just link to a GitHub issue. Experimental features might not require "official docs" but should have a decent explanation attached and proper new features should have links to proper docs. It's easy to create a rabbit hole index where the release notes just point to GH issues and discussions that are hard to sort out. And I totally get that this is easy to say for me since I'm not responsible for implementing it :)

DV-W-vanSchaijk commented 5 days ago

I like to have the release notes in vs code, like: Image

Don't know how it's linked, but if it's possible to link this tab to a release note feed it will be great.