Rearrange RBTools documentation a bit.

Review Request #14348 — Created Feb. 14, 2025 and updated — Latest diff uploaded

Information

RBTools
master

Reviewers

This change rearranges the RBTools documentation to try to simplify some
things:

  • Moved info about .reviewboardrc files to the main "configuration"
    page, and clarified where different files are loaded from and in what
    priority order.

  • Updated repo configuration page to emphasize why a .reviewboardrc file
    is a good idea and moved the alternative methods up next to that so
    it's clear what they're for.

  • Moved the ENABLE_PROXY documentation from repository config to user
    config.
  • Split the docs about aliases out into its own page.
  • On the main index page, simplified the "Getting Started" section to be
    install, configure, use.
  • Moved links for authentication and TFS into the "Common RBTools
    workflows" section.

Built docs and checked the results.

Diff Revision 1

This is not the most recent revision of the diff. The latest diff is revision 2. See what's changed.

orig
1
2

Commits

First Last Summary ID Author
Rearrange RBTools documentation a bit.
This change rearranges the RBTools documentation to try to simplify some things: - Moved info about .reviewboardrc files to the main "configuration" page, and clarified where different files are loaded from and in what priority order. - Updated repo configuration page to emphasize why a .reviewboardrc file is a good idea and moved the alternative methods up next to that so it's clear what they're for. - Moved the `ENABLE_PROXY` documentation from repository config to user config. - Split the docs about aliases out into its own page. - On the main index page, simplified the "Getting Started" section to be install, configure, use. - Moved links for authentication and TFS into the "Common RBTools workflows" section. Testing Done: Built docs and checked the results.
ad6dbc5ba05b5b36aec29e681f5c75e141833bfe David Trowbridge
docs/rbtools/rbt/configuration/authentication.rst
docs/rbtools/index.rst
docs/rbtools/rbt/configuration/aliases.rst
docs/rbtools/rbt/configuration/index.rst
docs/rbtools/rbt/configuration/repositories.rst
docs/rbtools/rbt/configuration/users.rst
Loading...