Release note improvements #222
Conversation
justinegeffen
commented
Sep 16, 2024
•
justinegeffen
commented
- Collapsed 2023 release notes
- Removed prefixes "Feature" "Added" "Improvement" etc in favor of descriptive sentences
- Removed some entries that were extraneous or vague
- Removed GH commits and ticket number references
- Rewrote some entries for clarity
- Made older sections expandable to save space (open to ideas for the summary instead of a double up on year)
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Collapsing last year's notes is a nice touch!
I left some comments regarding the entry format changes you made here, since they differ from the format we defined in Confluence and they'll also create a delta between Cloud and Enterprise changelog formats. So we'd either need to update all Enterprise changelogs to the new format, or stick to the format we were using.
| - Fix: Improve workflow launch screen look and feel | ||
| - Fix: Allow pipeline work directory to be changed during pipeline launch | ||
| - Fix: Handle special characters in prompt modal confirmation text regex | ||
| ### 24.2.0 - 2 September 2024 |
There was a problem hiding this comment.
The _cycle for each Cloud release is like a patch or minor release identifier, making each release unique. It's better to keep this than to have all releases in the major cycle have the same heading.
| ### 24.2.0 - 13 August 2024 | ||
|
|
||
| - Add global Nextflow configuration support in compute environments | ||
| - Improved flexibility for pipeline names in workspaces |
There was a problem hiding this comment.
If we change the format that we documented here, then we'll have to change the same for all versions of Enterprise. So this PR creates a disparity between the formats of Cloud and Enterprise changelogs.
There was a problem hiding this comment.
While I was editing the docs, I realized that adding those prefixes didn't apply to everything so it looked disjointed - and it's not easy to remember the order off-hand which means it makes updating the docs tiresome.
If we don't add those prefixes, we have to write more descriptive sentences to make the changelog notes more meaningful which I believe is a good approach. It also rolls into another change I'd like to implement which is to separate bugs, features, fixes into their own sections (that'll be the next PR).
I don't necessarily agree that we have to change the format for everything - it can be a change going forward. It might make more sense/be more viable in the next PR because it'll be a more obvious break from the previous format and be a clear delineation.
There was a problem hiding this comment.
I'm open to including the changes I have in mind for the next PR into this PR so we can see how it looks.
| - Bump nf-launcher:24.04.3 | ||
|
|
||
| ### 24.1.x Cloud - May 2024 | ||
| ### 24.1.x - May 2024 |
