podman/docs/source
Ed Santiago d7f134d687 Refactor common man page options, phase 2
Followup to #15174. These are the options that are easy(ish)
to review: those that have only drifted slightly, and need
only minor tweaks to bring back to sanity. For the most part,
I went with the text in podman-run because that was cleaned up
in #5192 way back in 2020. These diffs primarily consist of
using '**' (star star) instead of backticks, plus other
formatting and punctuation changes.

This PR also adds a README in the options dir, and a new
convention: <<container text...|pod text...>> which tries
to do the right thing based on whether the man page name
includes "-pod-" or not. Since that's kind of hairy code,
I've also added a test suite for it.

Finally, since this is impossible to review by normal means,
I'm temporarily committing hack/markdown-preprocess-review,
a script that will diff option-by-option. I will remove it
once we finish this cleanup, but be advised that there are
still 130+ options left to examine, and some of those are
going to be really hard to reunite.

Review script usage: simply run it (you need to have 'diffuse'
installed). It isn't exactly obvious, but it shouldn't take more
than a minute to figure out. The rightmost column (zzz-chosen.md)
is the "winner", the actual content that will be used henceforth.
You really want an ultrawide screen here.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-08-09 06:33:17 -06:00
..
_static Show API doc for several versions 2022-02-09 18:17:52 +01:00
markdown Refactor common man page options, phase 2 2022-08-09 06:33:17 -06:00
Commands.rst Add "podman kube play" cmd 2022-07-13 15:27:03 +01:00
Introduction.rst [CI:DOCS] Update first line in intro page 2021-05-14 17:08:35 -04:00
Reference.rst Add 4.1 branch to API documentation 2022-05-06 15:05:03 +02:00
Search.rst [CI:DOCS] Docs revamp. 2020-05-21 17:16:10 -04:00
Tutorials.rst [CI:DOCS] Tutorials.rst: add socket activation 2022-07-15 17:36:33 +02:00
conf.py readthedocs(sphinx): run the markdown preprocessor 2022-08-04 11:46:54 +02:00
includes.rst [CI:DOCS] Fix GitHub URL to Podman logo 2021-07-21 11:22:01 -04:00
index.rst [CI:DOCS]update state of restful service 2021-01-26 09:12:07 -06:00
volume.rst volumes: Add volume import to allow importing contents on tar into volume 2021-08-26 14:14:14 +05:30