• 
      

    Add docs on the Document Review settings page.

    Review Request #15073 — Created May 22, 2026 and submitted

    Information

    Review Board
    release-8.x

    Reviewers

    This adds a small docs page covering the new Document Review settings
    page in the admin UI sidebar. It briefly discusses the feature and
    broker URL settings, and includes information on the broker status, with
    a screenshot.

    It's the first page to include an admonition stating that this is a
    feature in Review Board Plus and Enterprise. We'll want to standardize
    on language and appearance for these notices going forward.

    Built the docs (along with a temporary intersphinx rule pointing to
    Power Pack, which is in the User Roles change). Tested that links worked.

    Tested the screenshots.

    Checked for spelling issues.

    Summary ID
    Add docs on the Document Review settings page.
    This adds a small docs page covering the new Document Review settings page in the admin UI sidebar. It briefly discusses the feature and broker URL settings, and includes information on the broker status, with a screenshot. It's the first page to include an admonition stating that this is a feature in Review Board Plus and Enterprise. We'll want to standardize on language and appearance for these notices going forward.
    6d325c43c3b45da0ca8a82ae1d646f63fcb65e3b
    Description From Last Updated

    Given that we know we want to have this be standard, can we put it into a file in docs/manual/_shared/ …

    david david

    Can we add a _... label for this, in case we want to link to it later?

    david david

    We don't currently have powerpack in our intersphinx config.

    david david

    Can we add a _... label for this, in case we want to link to it later?

    david david
    maubin
    1. Ship It!
    2. 
        
    david
    1. 
        
    2. docs/manual/admin/configuration/doc-review-settings.rst (Diff revision 1)
       
       
       
       
       
       
      Show all issues

      Given that we know we want to have this be standard, can we put it into a file in docs/manual/_shared/ and use .. include::?

      We probably should also not have a period on the admonition title to match other ones in the manual.

      Even better would be a small extension that we could use like .. rb-feature-availability:: plus, enterprise in order to have flexibility for when we have features that are enterprise-only, but that's more work. Perhaps an include for now with a comment in there about generalizing it?

      1. I'm going to be tackling this, but not in this change. I have a thing I'm working toward for this, but it'll be post-release.

        Fixing the period.

    3. Show all issues

      Can we add a _... label for this, in case we want to link to it later?

    4. Show all issues

      We don't currently have powerpack in our intersphinx config.

      1. That's part of Michelle's User Roles change. I didn't want to duplicate it.

    5. Show all issues

      Can we add a _... label for this, in case we want to link to it later?

    6. 
        
    chipx86
    david
    1. Ship It!
    2. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-8.x (361c158)