Draft Review Board 2.5 release notes.
Review Request #7677 — Created Oct. 5, 2015 and submitted
This adds a draft of the release notes for the 2.5 final release. This merges
all of the beta/RC release notes together, and includes all changes pushed
since RC1. Currently this has the text content. I'm working on adding
screenshots next.
Built HTML and looked at the output.
| Description | From | Last Updated |
|---|---|---|
|
Let's add, "or your database will become corrupt." |
 chipx86
|
|
|
Also user pages. The listing of the pages (which is being referred to as features, but should probably be "pages") … |
chipx86
|
|
|
I know this was here before, but how about "increase the default size to allow for more room to write … |
chipx86
|
|
|
Let's expand upon this and really talk about what's offered here. Users can navigate through Review Board with a side … |
chipx86
|
|
|
Casing should match the other sections. |
chipx86
|
|
|
"is now optional" |
chipx86
|
|
|
I know this was here before, but for the final release notes, I think we can get rid of the … |
chipx86
|
|
|
Let's say "Improvements to the Review Dialog" |
chipx86
|
|
|
"and modern versions ..." |
chipx86
|
|
|
Let's use this opportunity to do some advertisement for Splat here. Something like: "In upcoming releases, we'll be adding support … |
chipx86
|
|
|
Let's reword part of this: "Updating a review request with a new diff through the Review Board UI has become … |
chipx86
|
|
|
How about "Double-clicking anywhere on a line ..." Also, we should break this into a summary and a separate paragraph … |
chipx86
|
|
|
"now show", and missing a period. |
chipx86
|
|
|
Selling this more, let's end with, ".. rather than the raw Markdown, showing how your comment will look when published." |
chipx86
|
|
|
What do you think about naming this "Live HD Thumbnails"? "HD" for the Retina stuff, "Live" for the scroll-on-hover. |
chipx86
|
|
|
Let's put a paragraph break right before this sentence, to improve skimming of the feature addition. |
chipx86
|
|
|
How about, "... without having to delete the old attachment before uploading the new one." |
chipx86
|
|
|
We no longer have the down arrow. Now you simply hover over the attachment and click Update. |
chipx86
|
|
|
What do you think about shortening to "Diffs for Image Attachments" and, later, "Diffs for Text Attachments"? |
chipx86
|
|
|
Let's say, in another paragraph: "Working with text-based diffs is very similar to using the diff viewer. You can leave … |
chipx86
|
|
|
Let's get rid of "Regions". |
chipx86
|
|
|
Here, too. |
chipx86
|
|
|
"... or want to cover a different area of your image." |
chipx86
|
|
|
Missing period. How about, "See all reviews by a user at a glance." |
chipx86
|
|
|
"Smarter" ? Missing period. |
chipx86
|
|
|
Missing period. |
chipx86
|
|
|
This is worth mentioning in its own section, as I'm sure many users have wanted this, particularly if coming from … |
chipx86
|
|
|
How about, "The New Review Request page now shows all branches and commits for repositories hosted on Bitbucket. Clicking a … |
chipx86
|
|
|
We're not consistent here with the bug reference location. FWIW, we've been putting the bug number on the summary line … |
chipx86
|
|
|
Let's get rid of "now," because we used that in the sentence above. |
chipx86
|
|
|
Let's remove "also," since we said that just before this sentence, and it's not necessary here. |
chipx86
|
|
|
Let's link to the docs for the templating language. We should probably also link to our own docs on this … |
chipx86
|
|
|
We should be consistent in capitalization of "webhook". |
chipx86
|
|
|
We can probably remove the second "widget." |
chipx86
|
|
|
Let's add a little to this, saying "When configured, all new file attachments will be uploaded to Swift instead of … |
chipx86
|
|
|
Missing period. |
chipx86
|
|
|
Let's add on, "This will also help reduce database upgrade times in the future". |
chipx86
|
|
|
After this, let's add: "Newly-uploaded diffs will be stored in the new format, and visiting existing diffs will automatically convert … |
chipx86
|
|
|
"... stored diffs to the new format." |
chipx86
|
|
|
We might want a paragraph before the feature bullet point that just says something like: "This release contains numerous usablity … |
chipx86
|
|
|
Let's have a paragraph detailing that this is for the new revisioned file attachments (with a link to that section). |
chipx86
|
|
|
Let's add something like "See Web Hooks [with link] for more information on this new feature." |
chipx86
|
|
|
We shouldn't have the bullet point here, or we shouldn't add the section header. How about a "New Hooks" section … |
chipx86
|
|
|
Can we have both the bugs wrapped to the next line? |
chipx86
|
|
|
Worth saying in the next paragraph that this was working for submitted review requests but not discarded ones. |
chipx86
|
|
|
Remove "(in-development)" |
chipx86
|
|
|
This should be in Title Case, while you're here. |
chipx86
|
|
|
This should go before the header. |
chipx86
|
|
|
Should go before the section header. |
chipx86
|
|
|
No need for "File Attachment" here, since the context will be clear. |
chipx86
|
|
|
Should go above the section title. |
chipx86
|
|
|
Should go above the section title. |
chipx86
|
-
Tool: Pyflakes Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/2.5.rst docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png AUTHORS Tool: PEP8 Style Checker Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/2.5.rst docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png AUTHORS
Change Summary:
Add more images.
Diff: |
Revision 3 (+740 -1)
|
|---|
-
Tool: Pyflakes Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png Tool: PEP8 Style Checker Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png
-
Thanks for taking this on! :D
Got some suggestions to help reword bits taken from earlier release notes, now that this will probably be more carefully read by more users. Aiming to better advertise the benefits of more of the features.
Most of these suggestions are pretty small.
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Also user pages.
The listing of the pages (which is being referred to as features, but should probably be "pages") kind of feels.. I don't know, terse? Something. It's the capitalization and "New Review Request" specifically.
How about:
- The dashboard
- Review requests and reviews
- The diff viewer
- The New Review Request page
-
docs/releasenotes/2.5.rst (Diff revision 3) I know this was here before, but how about "increase the default size to allow for more room to write comments"?
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's expand upon this and really talk about what's offered here.
Users can navigate through Review Board with a side menu, activated by tapping the hamburger menu.
Through the mobile UI, you can participate in discussions on existing reviews while out and about.
The diff viewer, review dialog, and attachment review experiences ar not yet mobile-friendly. We'll be unveiling updates in the future that will make it easy to review code and attachments from your phone or tablet.
-
-
-
docs/releasenotes/2.5.rst (Diff revision 3) I know this was here before, but for the final release notes, I think we can get rid of the first part of this sentence.
-
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's use this opportunity to do some advertisement for Splat here. Something like:
"In upcoming releases, we'll be adding support for additional bug trackers, such as Splat, our new friendly bug tracker service currently in development."
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's reword part of this:
"Updating a review request with a new diff through the Review Board UI has become a lot easier. The Update Diff dialog has been redesigned to mirror the abilities of the New Review Request page.
To upload a new diff, you can either drag-and-drop it onto the dialog, or browse your file system. The diff will be automatically checked, showing any errors or requesting additional information (such as a parent diff or Subversion base path) if needed.
-
docs/releasenotes/2.5.rst (Diff revision 3) How about "Double-clicking anywhere on a line ..."
Also, we should break this into a summary and a separate paragraph describing the feature, like we have elsewhere.
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Selling this more, let's end with, ".. rather than the raw Markdown, showing how your comment will look when published."
-
docs/releasenotes/2.5.rst (Diff revision 3) What do you think about naming this "Live HD Thumbnails"? "HD" for the Retina stuff, "Live" for the scroll-on-hover.
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's put a paragraph break right before this sentence, to improve skimming of the feature addition.
-
docs/releasenotes/2.5.rst (Diff revision 3) How about, "... without having to delete the old attachment before uploading the new one."
-
docs/releasenotes/2.5.rst (Diff revision 3) We no longer have the down arrow. Now you simply hover over the attachment and click Update.
-
docs/releasenotes/2.5.rst (Diff revision 3) What do you think about shortening to "Diffs for Image Attachments" and, later, "Diffs for Text Attachments"?
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's say, in another paragraph:
"Working with text-based diffs is very similar to using the diff viewer. You can leave comments across multiple lines, see indentation-only changes or moved blocks of lines, and more."
-
-
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Missing period.
How about, "See all reviews by a user at a glance."
-
-
-
docs/releasenotes/2.5.rst (Diff revision 3) This is worth mentioning in its own section, as I'm sure many users have wanted this, particularly if coming from GitHub.
-
docs/releasenotes/2.5.rst (Diff revision 3) How about, "The New Review Request page now shows all branches and commits for repositories hosted on Bitbucket. Clicking a commit will post it for review, making it easy to review changes made prior to using Review Board or to review changes sitting on another branch."
We should also link Bitbucket.
-
docs/releasenotes/2.5.rst (Diff revision 3) We're not consistent here with the bug reference location.
FWIW, we've been putting the bug number on the summary line for bullet points in all previous release notes.
Also, the summary took me a couple tries to read. How about, "The display name for a group is now shown on the group page."
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's get rid of "now," because we used that in the sentence above.
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's remove "also," since we said that just before this sentence, and it's not necessary here.
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's link to the docs for the templating language.
We should probably also link to our own docs on this further down.
-
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's add a little to this, saying "When configured, all new file attachments will be uploaded to Swift instead of on the Review Board server. This helps when scaling Review Board out to multiple servers, and reduces load on the Review Board server."
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's add on, "This will also help reduce database upgrade times in the future".
-
docs/releasenotes/2.5.rst (Diff revision 3) After this, let's add:
"Newly-uploaded diffs will be stored in the new format, and visiting existing diffs will automatically convert them to the new format as well."
-
-
docs/releasenotes/2.5.rst (Diff revision 3) We might want a paragraph before the feature bullet point that just says something like:
"This release contains numerous usablity improvements for both desktop and mobile devices as part of the new visual redesign. See Design Update above."
With "Design Update" linking.
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's have a paragraph detailing that this is for the new revisioned file attachments (with a link to that section).
-
docs/releasenotes/2.5.rst (Diff revision 3) Let's add something like "See Web Hooks [with link] for more information on this new feature."
-
docs/releasenotes/2.5.rst (Diff revision 3) We shouldn't have the bullet point here, or we shouldn't add the section header.
How about a "New Hooks" section (for AdminWidgetHook, WebAPICapabilitiesHook, and the e-mail hooks) and an "Extension Web APIs" (or something) section?
-
-
docs/releasenotes/2.5.rst (Diff revision 3) Worth saying in the next paragraph that this was working for submitted review requests but not discarded ones.
-
Diff: |
Revision 4 (+798 -3)
|
|---|
-
Tool: Pyflakes Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png docs/manual/admin/configuration/webhooks.rst Tool: PEP8 Style Checker Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png docs/manual/admin/configuration/webhooks.rst
-
-
docs/manual/admin/configuration/webhooks.rst (Diff revision 4) This should be in Title Case, while you're here.
-
-
-
docs/releasenotes/2.5.rst (Diff revision 4) No need for "File Attachment" here, since the context will be clear.
-
-
Commit: |
|
||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Diff: |
Revision 5 (+799 -4)
|
-
Tool: Pyflakes Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png docs/manual/admin/configuration/webhooks.rst Tool: PEP8 Style Checker Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/_static/images/2.5/2.5-image-diffs.png docs/releasenotes/_static/images/2.5/2.5-review-request-details@2x.png docs/releasenotes/_static/images/2.5/2.5-review-request-details.png docs/releasenotes/_static/images/2.5/2.5-file-attachments@2x.png docs/releasenotes/_static/images/2.5/2.5-file-attachments.png docs/releasenotes/index.rst docs/releasenotes/_static/images/2.5/2.5-expand-context.gif docs/releasenotes/2.5.rst AUTHORS docs/releasenotes/_static/images/2.5/2.5-image-diffs@2x.png docs/manual/admin/configuration/webhooks.rst
Tool: Pyflakes Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/index.rst docs/releasenotes/2.5.rst AUTHORS Tool: PEP8 Style Checker Processed Files: docs/releasenotes/conf.py Ignored Files: docs/releasenotes/index.rst docs/releasenotes/2.5.rst AUTHORS