[CI:DOCS] cross-reference .rst files #7291
Conversation
For each podman*.md file with a subcommand table (podman, podman-container, etc), assert that the subcommand list is sorted. Change is bigger than it should be, because it switches from nice clean local per-function error counting to using a nasty global. Signed-off-by: Ed Santiago <[email protected]>
There are a bunch of *.rst files in docs/source, linking sometimes
to man pages and sometimes to other .rst files. These files each
have entries of the following form:
:doc:`foo <link-to-foo>` Description of foo
...for all podman sub and sub-subcommands 'foo'.
Read all .rst files and make sure that:
- all entries in a given file are in alphabetical order
- all link-to-foo targets point to existing doc files
- every subcommand known by 'podman help' has a corresponding
doc entry in a .rst file
Signed-off-by: Ed Santiago <[email protected]>
|
This is a two-commit PR, and I encourage you to review it as such. The first commit is relatively minor: simply adds a sort-check to one of the man page tests. It's a little more complicated than desired, because I changed error status to a global. It makes sense for.... ...The second commit, which is the one that checks |
| :doc:`prune <markdown/podman-container-prune.1>` Remove all stopped containers | ||
|
|
||
| :doc:`restart <markdown/podman-restart.1>` Restart one or more containers | ||
|
|
There was a problem hiding this comment.
should line 40 and 44 be higher up? 'podman-container-*'
There was a problem hiding this comment.
I'm sorting on the subcommand name, not the link target. 'prune' < 'restart'
There was a problem hiding this comment.
(does that address your concern?)
There was a problem hiding this comment.
My bad, I was liking at the link targets there.
|
Nice work @edsantiago. I have a love/hate relationship with these kinds of checks. I hate it when I mess up and they ding me, but I love it that they ding me because things are messed up. |
|
LGTM |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: edsantiago, mheon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
|
/lgtm |
github-actions
bot
added
the
locked - please file new issue/PR
There are a bunch of *.rst files in docs/source, linking sometimes
to man pages and sometimes to other .rst files. These files each
have entries of the following form:
:doc:
foo <link-to-foo>Description of foo...for all podman sub and sub-subcommands 'foo'.
Read all .rst files and make sure that:
doc entry in a .rst file
Signed-off-by: Ed Santiago [email protected]