Add draft release notes for RBTools 3.0.

Review Request #12134 — Created March 10, 2022 and submitted

Information

RBTools
master

Reviewers

This change adds release notes for the new features and improvements
that will ship as RBTools 3.0.

Built HTML and checked output.

Summary ID
Add draft release notes for RBTools 3.0.
This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.
a8de8227369ca750663d6535c2f2a0d995723d1b
Description From Last Updated

Some missing changes: More detail on the repository architectural changes and command changes (3fbea5f, 37728c4, a98f021, 53b7208, 35275e6) for people …

chipx86chipx86

Things look good for the most part, but the "Other Improvements" section feels a bit disorganized. Some entries are new …

chipx86chipx86

Typo: "Fetaures" -> "Features"

chipx86chipx86

We should specify the minimum version of Review Board required for this (I recommend we just say 4.0.6, given the …

chipx86chipx86

Rather than "a new backend," let's say "new repository support" Also, rather than the "... more powerful", maybe we could …

chipx86chipx86

"new new" support! :)

chipx86chipx86

The backticks aren't needed in the definitions.

chipx86chipx86

Let's sell this better. Can we talk about the capabilities this provides?

chipx86chipx86

We don't document any of these right now, do we? We should probably have tasks for that.

chipx86chipx86

Missing a period.

chipx86chipx86

Mind double-checking that they're all in AUTHORS?

chipx86chipx86
chipx86
  1. 
      
  2. Show all issues

    Some missing changes:

    • More detail on the repository architectural changes and command changes (3fbea5f, 37728c4, a98f021, 53b7208, 35275e6) for people building on top of RBTools.

    • Deprecation of TREES (7c0b6b0)

    (The following are in release-2.0.x, but aren't released.)

    • Fixes to the default User-Agent value sent in API requests (5558459 — Lukasz Kawczynski)
    • Custom commands and aliases now show up in --help (b9e4c9b — Matthew Blythe)
    • Fixes for excluded/included files affecting full Git diffs (97d6a9a — Andrej Radovi?)
  3. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
    Show all issues

    Typo: "Fetaures" -> "Features"

  4. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
     
     
     
     
     
     
     
     
     
     
    Show all issues

    We should specify the minimum version of Review Board required for this (I recommend we just say 4.0.6, given the new diff functionality was added in 4.0.5 and things fixed up in 4.0.6).

    1. That seems more appropriate for the Power Pack release notes. This is RBTools.

  5. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
    Show all issues

    Rather than "a new backend," let's say "new repository support"

    Also, rather than the "... more powerful", maybe we could say something like:

    "... HCL VersionVault and IBM ClearCase, built in cooperation with HCL. This replaces the old community-driven ClearCase implementation in Review Board, offering better compatibility, official support, and modern functionality. It includes ..."

  6. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
     
     
    Show all issues

    The backticks aren't needed in the definitions.

  7. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
     
     
     
     
    Show all issues

    Let's sell this better. Can we talk about the capabilities this provides?

  8. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
     
     
     
    Show all issues

    We don't document any of these right now, do we? We should probably have tasks for that.

  9. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
    Show all issues

    Missing a period.

  10. docs/releasenotes/3.0.rst (Diff revision 1)
     
     
     
     
     
     
     
     
    Show all issues

    Mind double-checking that they're all in AUTHORS?

  11. 
      
david
chipx86
  1. 
      
  2. Show all issues

    Things look good for the most part, but the "Other Improvements" section feels a bit disorganized. Some entries are new features, some deprecations, some bug fixes. I think we can clean this up by just moving the bug fixes into a "Bug Fixes" section, like other release notes have.

  3. docs/releasenotes/3.0.rst (Diff revisions 1 - 2)
     
     
    Show all issues

    "new new" support! :)

  4. 
      
david
chipx86
  1. Ship It!
  2. 
      
david
Review request changed
Status:
Completed
Change Summary:
Pushed to release-3.x (656f0c1)