Support #20769
closedRelease Arvados 2.7.0
Updated by Peter Amstutz over 1 year ago
- Target version changed from Development 2023-08-16 to Development 2023-08-30
Updated by Peter Amstutz over 1 year ago
- Target version changed from Development 2023-08-30 to Development 2023-09-13 sprint
Updated by Peter Amstutz over 1 year ago
Updated by Peter Amstutz about 1 year ago
- Target version changed from Development 2023-09-13 sprint to Development 2023-09-27 sprint
Updated by Peter Amstutz about 1 year ago
Updated by Peter Amstutz about 1 year ago
Thank you for the draft release notes, I know it takes a lot of work to pull together.
A couple of style/voice/tone suggestions for the future (this is intended to be constructive criticism):
In general, people don't care what we did, they care about the ways that the software has changed, and more specifically, the benefits resulting from the changes in the release.
For example, some notes are phrased as "We have done X to improve Y".
We have optimized S3 paging in keep-web to improve performance when it lists directories with more than 1,000 items. #20798
This buries the benefit, which is "improved performance".
I like to put the benefit in the front:
Improved performance of paging in the S3 API of keep-web when listing directories with more than 1,000 items. #20726
Fixed a bug in Workbench 2 where breadcrumbs did not render when parent project information was not available from the left-hand navigation menu. [#19991](https://dev.arvados.org/issues/19991)
Admittedly this is in a section called "Bug fixes and enhancements" but you have six lines in a row that all start with "Fixed a bug..."
I like to lead with the new (correct) behavior instead of describing the broken behavior and saying it was "fixed".
Breadcrumbs now correctly render even when the parent project is not visible in the left-hand navigation menu. [#19991](https://dev.arvados.org/issues/19991)
Updated by Peter Amstutz about 1 year ago
release-notes-2.7.0 @ commit:70fa8da7d7d50ea73f1c0d69b4a64fe4f41e40fe
back to you
Updated by Brett Smith about 1 year ago
Peter Amstutz wrote in #note-9:
A couple of style/voice/tone suggestions for the future (this is intended to be constructive criticism):
If we want stuff like release notes and similar documentation to have a consistent tone and structure regardless of who the individual author is, typically the way organizations manage that is by having a house style guide, basically the equivalent of coding guidelines for prose. Should we go ahead and start a page on the wiki with these points? It doesn't have to start comprehensive, we can add to it as we think of things.
In general, people don't care what we did, they care about the ways that the software has changed, and more specifically, the benefits resulting from the changes in the release.
For example, some notes are phrased as "We have done X to improve Y".
We have optimized S3 paging in keep-web to improve performance when it lists directories with more than 1,000 items. #20798
This buries the benefit, which is "improved performance".
I like to put the benefit in the front:
Improved performance of paging in the S3 API of keep-web when listing directories with more than 1,000 items. #20726
So I agree the fact that "we" made the change is not the important part, and I'm fine making sure the benefit comes as early as possible. But my concern about this example is it's not a complete sentence: there's no subject. I think the passive voice leads to some awkward construction in more complicated notes, and starts sounding robotic over the course of the whole document. Any objection to "We improved performance of paging in the S3 API…"?
Updated by Peter Amstutz about 1 year ago
Brett Smith wrote in #note-11:
Improved performance of paging in the S3 API of keep-web when listing directories with more than 1,000 items. #20726
So I agree the fact that "we" made the change is not the important part, and I'm fine making sure the benefit comes as early as possible. But my concern about this example is it's not a complete sentence: there's no subject. I think the passive voice leads to some awkward construction in more complicated notes, and starts sounding robotic over the course of the whole document. Any objection to "We improved performance of paging in the S3 API…"?
So, this is still passive but I think it's a complete sentence:
The performance of keep-web paging with the S3 API is improved when listing directories with more than 1,000 items. #20726
My goal with the sentence construction is to help someone who is skimming quickly to identify changes they are interested in. While we don't want to make the sentences awkward (if it reduces comprehensibility, that's clearly bad) but sounding robotic is a feature not a bug.
(also there's a choice between "is improved", "has improved" or "was improved" and the reason I prefer present tense is because it is describing the present state of the software as compared to the previous state).
Updated by Peter Amstutz about 1 year ago
2.7.0~rc5-1
arvados|7d974e3dc14efa8c05f1a02fa6ee7be37ee2b8a6
arvados-workbench2|6f8dcb2b13f3058db656908fb26b09e23b527f08
build-and-publish-rc-packages: #202
workbench2-build-release-candidate-package: #131
docker-jobs-image-release: #62
Edit for packer singularity build fix: arvados|1cc3a7c037077e3d64fda794e239c0096b3f033c
packer-build-compute-image: #237
https://workbench2.pirca.arvadosapi.com/projects/pirca-j7d0g-3yslv3eoq94x1uy
Updated by Peter Amstutz about 1 year ago
Live logs isn't working, browser network tab says "blocked", I think this might be CORS related?
Updated by Peter Amstutz about 1 year ago
2.7.0-1
arvados|101971b92790b8461ac4c3387014fe70cb7787e5
arvados-workbench2|6f8dcb2b13f3058db656908fb26b09e23b527f08
build-and-publish-rc-packages: #203
workbench2-build-release-candidate-package: #132
docker-jobs-image-release: #63
build-publish-packages-testing-rocky8: #3
build-publish-packages-python-ruby: #78
build-package-r: #26
build-java-sdk: #45
publish-packages-to-stable-repo: #268 (.deb)
publish-packages-to-stable-repo: #274 (.rpm)
Updated by Peter Amstutz about 1 year ago
Updated by Peter Amstutz about 1 year ago
- Status changed from New to In Progress
Updated by Peter Amstutz about 1 year ago
- Status changed from In Progress to Resolved