Rework the documentation on management commands.
Review Request #13001 — Created May 1, 2023 and submitted
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 inrb-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
andinvalidate-api-tokens
, have been
added to the mangerb-site manage --help
output.
Built the docs. Checked for build errors, spelling errors, and bad
links. Viewed them in the new docs UI.
Summary | ID |
---|---|
76cd62723214038dbcf0320e079a18684729c1a7 |
Description | From | Last Updated |
---|---|---|
expected 2 blank lines, found 1 Column: 1 Error code: E302 |
reviewbot | |
I realize these are alphabetical, but I think it would make more sense for resolve-check to be last. |
david | |
Is it worth clarifying here that periodic/scheduled indexing is only required if on-the-fly indexing is turned off? |
david | |
Typo "output" -> "outputted" |
maubin | |
Wouldn't the option be -m 10 for 10 minutes? And -a 1 is 1 hour? |
maubin |
- 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 ID 79283ee5bfb14b94b8e1e37c12ab2814b88de8da d101808c16875e93dd4ddfe4c20e9f61cb0fb19e