Add draft release notes for 5.0 beta 1.

Review Request #12374 — Created June 15, 2022 and submitted

david
Review Board
release-5.0.x
reviewboard

This adds the release notes draft covering everything that we're
shipping in beta 1.

Built HTML and checked the output.

Summary
Add draft release notes for 5.0 beta 1.
Description From Last Updated

Two small changes to add: Extensions that failed to load had the wrong text for reloading extensions. Fix problems that …

chipx86chipx86

I have one more thing that needs to go in (/r/12437), which will need to be included in here. (That …

chipx86chipx86

Let's reference the doc: :doc:`4.0.7`

chipx86chipx86

pip3

chipx86chipx86

I don't think we need this now that this is all on https.

chipx86chipx86

http -> https in these.

chipx86chipx86

Also: oauth2_provider_accesstoken oauth2_provider_application oauth2_provider_grant oauth2_provider_idtoken oauth2_provider_refreshtoken reviewboard_oauth_application

chipx86chipx86

Let's be explicit about the beta status of each.

chipx86chipx86

"or higher" isn't quite right, since there's explicit ranges that are supported.

chipx86chipx86

We can use :pypi: here.

chipx86chipx86

Only one blank line needed between parent and child sections with no content.

chipx86chipx86

Let's move "Review Board now ..." to its own paragraph so it's less buried.

chipx86chipx86

Let's link to these. We should probably draft integration pages on https://www.reviewboard.org/integrations/ for each by release. Helps with references and …

chipx86chipx86

Two blank lines before reference definition blocks.

chipx86chipx86

No need for the trailing period in the section header.

chipx86chipx86

Let's switch these to pip3.

chipx86chipx86

We should probably tell people where to go to find this.

chipx86chipx86

Typo: Pyments -> Pygments

maubinmaubin

We can say that this is the start, and that we have further improvements coming in beta 2.

chipx86chipx86

This needs to be double backticks in ReST. The table name is scmtools_tool though.

chipx86chipx86

Same here.

chipx86chipx86

Should be Title Case.

chipx86chipx86

Should be Title Case.

chipx86chipx86

Let's put these in alphabetical order.

chipx86chipx86

So I wasn't going to make this a beta, but now I'm wondering if we should... And if we should, …

chipx86chipx86
david
maubin
  1. 
      
  2. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Typo: Pyments -> Pygments

  3. 
      
chipx86
  1. 
      
  2. Two small changes to add:

    • Extensions that failed to load had the wrong text for reloading extensions.
    • Fix problems that could occur with setting up an environment for running brz for Breezy (more likely to affect unit tests, but still).
  3. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     

    Let's reference the doc:

    :doc:`4.0.7`
    
  4. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
  5. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    I don't think we need this now that this is all on https.

  6. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     

    http -> https in these.

  7. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Also:

    • oauth2_provider_accesstoken
    • oauth2_provider_application
    • oauth2_provider_grant
    • oauth2_provider_idtoken
    • oauth2_provider_refreshtoken
    • reviewboard_oauth_application
  8. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

    Let's be explicit about the beta status of each.

  9. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     
     
     

    "or higher" isn't quite right, since there's explicit ranges that are supported.

  10. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    We can use :pypi: here.

  11. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     
     

    Only one blank line needed between parent and child sections with no content.

  12. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     

    Let's move "Review Board now ..." to its own paragraph so it's less buried.

  13. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Let's link to these.

    We should probably draft integration pages on https://www.reviewboard.org/integrations/ for each by release. Helps with references and SEO. Wanna put a task in Asana for this?

  14. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     

    Two blank lines before reference definition blocks.

  15. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    No need for the trailing period in the section header.

  16. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     
     

    Let's switch these to pip3.

  17. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     
     
     

    We should probably tell people where to go to find this.

  18. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     
     
     

    We can say that this is the start, and that we have further improvements coming in beta 2.

  19. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    This needs to be double backticks in ReST.

    The table name is scmtools_tool though.

  20. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Same here.

  21. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Should be Title Case.

  22. docs/releasenotes/5.0-beta-1.rst (Diff revision 2)
     
     

    Should be Title Case.

  23. 
      
david
chipx86
  1. 
      
  2. I have one more thing that needs to go in (/r/12437), which will need to be included in here.

    (That change targets 5.0 beta 1 for now, and will be backported to 4.0.8 after.)

  3. docs/releasenotes/5.0-beta-1.rst (Diff revision 3)
     
     
     
     
     
     
     
     

    Let's put these in alphabetical order.

  4. docs/releasenotes/5.0-beta-1.rst (Diff revision 3)
     
     

    So I wasn't going to make this a beta, but now I'm wondering if we should...

    And if we should, we'll need this in the pip instructions above.

    1. No need to change your plans, unless you actually expect more changes. I'll just revert this one.

  5. 
      
david
david
david
chipx86
  1. Ship It!
  2. 
      
david
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-5.0.x (4a29886)
Loading...