Project

General

Profile

Actions

Support #20769

closed

Release Arvados 2.7.0

Added by Peter Amstutz 10 months ago. Updated 8 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
-
Category:
-
Due date:
Story points:
-
Release relationship:
Auto

Subtasks 27 (0 open27 closed)

Task #20770: 1. Prepare X.Y-staging branchResolvedPeter Amstutz09/18/2023Actions
Task #20771: 2. Update the "Upgrading Arvados and Release notes" doc page (main and release branch), update provision.sh, formula and arvbox to point to releaseResolved09/18/2023Actions
Task #20772: 3. Ensure that the entire automated testing pipeline is passing on JenkinsResolvedPeter Amstutz09/18/2023Actions
Task #20773: 4. Review release branchResolved09/18/2023Actions
Task #20774: 5. Draft release notes and publish them to www-devResolvedBrett Smith09/18/2023Actions
Task #20775: 6. Review release notesResolvedPeter Amstutz09/18/2023Actions
Task #20776: 7. Create next redmine releaseResolved09/18/2023Actions
Task #20777: 8. Build RC packagesResolved09/20/2023Actions
Task #20778: 9. Build RC arvados/jobs imageResolved09/20/2023Actions
Task #20779: 10. Ensure installer tests are passingResolved09/20/2023Actions
Task #20780: 11. Build compute image & deploy RC packages to playgroundResolved09/20/2023Actions
Task #20781: 12. Run bam-to-vcf demo pipelineResolved09/20/2023Actions
Task #20782: 13. Manual testingResolved09/21/2023Actions
Task #20783: 14. Approve RC for releaseResolved09/21/2023Actions
Task #20784: 15. Build final release packagesResolved09/21/2023Actions
Task #20785: 16. Publish stable arvados/jobs Docker imageResolved09/21/2023Actions
Task #20786: 17. Push packages to stableResolved09/21/2023Actions
Task #20787: 18. Publish Python and Ruby packagesResolved09/21/2023Actions
Task #20788: 19. Publish Java packageResolved09/21/2023Actions
Task #20789: 20. Publish R packageResolved09/21/2023Actions
Task #20790: 21. Publish arvados/arvbox-demo imageResolvedPeter Amstutz09/21/2023Actions
Task #20791: 22. Tag commits, fast-forward X.Y-release branch to match X.Y-stagingResolved09/21/2023Actions
Task #20792: 23. Ensure doc.arvados.org is up to dateResolved09/21/2023Actions
Task #20793: 24. Merge release notes (step 6) from "develop" to "main" on arvados.orgResolved09/21/2023Actions
Task #20794: 25. Send out release announcementsResolvedBrett Smith09/21/2023Actions
Task #20795: 26. Major releases only: Copy "run-tests" jobs in jenkinsResolved09/22/2023Actions
Task #20796: 27. Add the release to zenodo.orgResolved09/22/2023Actions
Actions #1

Updated by Peter Amstutz 10 months ago

  • Release set to 66
Actions #2

Updated by Peter Amstutz 9 months ago

  • Target version changed from Development 2023-08-16 to Development 2023-08-30
Actions #3

Updated by Peter Amstutz 9 months ago

  • Target version changed from Development 2023-08-30 to Development 2023-09-13 sprint
Actions #7

Updated by Peter Amstutz 8 months ago

  • Target version changed from Development 2023-09-13 sprint to Development 2023-09-27 sprint
Actions #9

Updated by Peter Amstutz 8 months 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)

Actions #10

Updated by Peter Amstutz 8 months ago

release-notes-2.7.0 @ commit:70fa8da7d7d50ea73f1c0d69b4a64fe4f41e40fe

back to you

Actions #11

Updated by Brett Smith 8 months 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…"?

Actions #12

Updated by Peter Amstutz 8 months 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).

Actions #14

Updated by Peter Amstutz 8 months ago

Live logs isn't working, browser network tab says "blocked", I think this might be CORS related?

Actions #17

Updated by Peter Amstutz 8 months ago

  • Status changed from New to In Progress
Actions #18

Updated by Peter Amstutz 8 months ago

  • Tracker changed from Bug to Support
Actions #20

Updated by Peter Amstutz 8 months ago

  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF