search

microsoft / win32-app-isolation

Tools and documentation for Win32 app isolation
MIT License
1.27k stars 33 forks source link

Update and rename RELEASE_NOTES.md to release_notes.md #10

Closed ddsilva-msft closed 1 year ago

tiangao-ms commented 1 year ago

I think the file name should be release-notes.md, to match our existing docs.

If we do want a release note file, then we should put all the release notes in the file, instead of directing users to the release pages - they could've done that without the release note, and that's normally the first step.

Having public preview as the section title feels a bit weird as well. And coming soon section should not be part of the release note - that's not release :).

I would suggest something like

# Release Notes

This file contains summary of each release for [Win32 app isolation tools](#win32-app-isolation-tools) and related [Windows updates](#windows)(please rephrase this as you like, basically we put a small description here about the content).

## Win32 app isolation tools

### v0.1.0

All the changes for v0.1.0

## Windows

### Windows build 25357 (2023-05-04)

Related os changes

When we have new releases, we can add to the corresponding section:

## Win32 app isolation tools

### v0.1.1

New changes to the tools

### v0.1.0

All the changes for v0.1.0
tiangao-ms commented 1 year ago

My comments above shows a great example why we should break lines in md files :)

ddsilva-msft commented 1 year ago

I think the file name should be release-notes.md, to match our existing docs.

If we do want a release note file, then we should put all the release notes in the file, instead of directing users to the release pages - they could've done that without the release note, and that's normally the first step.

Having public preview as the section title feels a bit weird as well. And coming soon section should not be part of the release note - that's not release :).

I would suggest something like

# Release Notes

This file contains summary of each release for [Win32 app isolation tools](#win32-app-isolation-tools) and related [Windows updates](#windows)(please rephrase this as you like, basically we put a small description here about the content).

## Win32 app isolation tools

### v0.1.0

All the changes for v0.1.0

## Windows

### Windows build 25357 (2023-05-04)

Related os changes

When we have new releases, we can add to the corresponding section:

## Win32 app isolation tools

### v0.1.1

New changes to the tools

### v0.1.0

All the changes for v0.1.0

I'll fix the name to be windows-release-notes.md. The primary purpose of this file is to provide updates on the OS features for Win32 app isolation. I don't want to duplicate the tool release notes so I'll just link to that at the end. We also want to highlight which features are currently disabled but will be enabled once the Canary flights move to active branch so Coming Soon was the best heading I had for that, but I'm open to suggestions.

tiangao-ms commented 1 year ago

Have you thought about where we should put the "coming soon" section after we have more windows updates? Normally the release notes are in reverse order - the latest changes are on the top so the users can see them faster. Do we put "coming soon" at the very bottom?

ddsilva-msft commented 1 year ago

Have you thought about where we should put the "coming soon" section after we have more windows updates? Normally the release notes are in reverse order - the latest changes are on the top so the users can see them faster. Do we put "coming soon" at the very bottom?

Coming soon should only be required when we have features that are disabled as is the case with the initial Public Preview release. Going forward, that section can be removed and we can start adding the most recent OS features to the top. The first update to will have the feature list in Coming Soon moved to the top possibly with other additions.

tiangao-ms commented 1 year ago

Coming soon should only be required when we have features that are disabled as is the case with the initial Public Preview release. Going forward, that section can be removed and we can start adding the most recent OS features to the top. The first update to will have the feature list in Coming Soon moved to the top possibly with other additions.

If we'll get rid of the "coming soon" section soon, I'm fine with where it is now.