flake8
-
docs/manual/_ext/rbwebsite_refs.py (Diff revision 1) Show all issues
Review Request #13001 — Created May 1, 2023 and updated
Information | |
---|---|
chipx86 | |
Review Board | |
release-5.0.x | |
Reviewers | |
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 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 | |
---|---|
Description | From | Last Updated |
---|---|---|
expected 2 blank lines, found 1 Column: 1 Error code: E302 |
![]() |
|
I realize these are alphabetical, but I think it would make more sense for resolve-check to be last. |
|
|
Is it worth clarifying here that periodic/scheduled indexing is only required if on-the-fly indexing is turned off? |
|
|
Typo "output" -> "outputted" |
![]() |
|
Wouldn't the option be -m 10 for 10 minutes? And -a 1 is 1 hour? |
![]() |
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.
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?
Commits: |
|
|||||||||
---|---|---|---|---|---|---|---|---|---|---|
Diff: |
Revision 2 (+1532 -136) |
docs/manual/admin/sites/management-commands.rst (Diff revision 2) |
---|
Wouldn't the option be
-m 10
for 10 minutes? And-a 1
is 1 hour?