podman/docs/source
Ed Santiago 6236be4ff9 [CI:DOCS] Add CI check for SEE ALSO in man pages
Add new CI check to confirm that links and references
in SEE ALSO sections are properly formatted and that
links are valid (at least in theory: we do no actual
URL fetching to test for 404).

The check is piggybacked into existing xref-helpmsgs-manpages
script. It could conceivably be more elegant to write a
separate tool for this purpose, but I don't wish to duplicate
the logic for finding and reading markdown files.

Script identified various problems, which I fix in this PR:

  . missing '**' (asterisks) around some references, or '**'
    in the wrong place.

  . links pointing to github.com/.../tree/ instead of /blob/
    (github redirects those automatically, but I like
    consistency)

  . a few copy-paste errors, e.g. subgid linking to subuid.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2021-11-10 09:03:40 -07:00
..
_static
markdown [CI:DOCS] Add CI check for SEE ALSO in man pages 2021-11-10 09:03:40 -07:00
Commands.rst Fix up build the docs site 2021-09-16 17:41:00 -04:00
Introduction.rst
Reference.rst
Search.rst
Tutorials.rst Replace old RESTful tutorial with updated README 2021-07-07 10:03:01 -05:00
conf.py Use a new markdown converter for sphinx 2021-09-16 21:10:13 +02:00
includes.rst [CI:DOCS] Fix GitHub URL to Podman logo 2021-07-21 11:22:01 -04:00
index.rst
volume.rst volumes: Add volume import to allow importing contents on tar into volume 2021-08-26 14:14:14 +05:30