Rework the documentation on management commands.

Review Request #13001 — Created May 1, 2023 and updated

chipx86
Review Board
release-5.0.x
reviewboard

Our documentation on management commands was very limited, listing only
a few commands and in no specific order.

This change completely reworks the documentation to list all common
commands we display in rb-site manage --help. They go over basic
usage and options, show warnings for the more dangerous commands, and
provide links to useful reference docs.

Each set of commands are listed in a dedicated section, providing
organization.

There's a new rb-management-command directive and role, which will
make it easier to link to the necessary docs without using :ref:.

Two commands, find-large-diffs and invalidate-api-tokens, have been
added to the mange rb-site manage --help output.

Built the docs. Checked for build errors, spelling errors, and bad
links. Viewed them in the new docs UI.

Summary
Rework the documentation on management commands.
Description From Last Updated

expected 2 blank lines, found 1 Column: 1 Error code: E302

reviewbotreviewbot

I realize these are alphabetical, but I think it would make more sense for resolve-check to be last.

daviddavid

Is it worth clarifying here that periodic/scheduled indexing is only required if on-the-fly indexing is turned off?

daviddavid

Typo "output" -> "outputted"

maubinmaubin

Wouldn't the option be -m 10 for 10 minutes? And -a 1 is 1 hour?

maubinmaubin
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

david
  1. 
      
  2. docs/manual/admin/sites/management-commands.rst (Diff revision 1)
     
     
     
     
     
     

    I realize these are alphabetical, but I think it would make more sense for resolve-check to be last.

  3. docs/manual/admin/sites/management-commands.rst (Diff revision 1)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

    Is it worth clarifying here that periodic/scheduled indexing is only required if on-the-fly indexing is turned off?

  4. 
      
chipx86
Review request changed

Change Summary:

  • Updated ordering of some items in the siteconfig section's summary to make more logical sense.
  • Added a note about not needing periodic updates if on-the-fly indexing is enabled for search.

Commits:

Summary
-
Rework the documentation on management commands.
+
Rework the documentation on management commands.

Diff:

Revision 2 (+1532 -136)

Show changes

Checks run (2 succeeded)

flake8 passed.
JSHint passed.
david
  1. Ship It!
  2. 
      
maubin
  1. 
      
  2. Typo "output" -> "outputted"

  3. Wouldn't the option be -m 10 for 10 minutes? And -a 1 is 1 hour?

  4. 
      
Loading...