3 Commits

Author SHA1 Message Date
6deb1bc2ae Manpage syntax proposal
I looked at the man pages and found that while they are consistent in their basic concept, many things concerning formatting are not.
For example, it is not consistent that options are behind an H4 header.
The biggest criticism, however, is how commands and options are handled when referencing them in a text.
There is no clear structure between the man pages regarding this. Sometimes backticks are used and sometimes they are written in italic.
Also, the formatting regarding the appearance of the commands is not consistent either.
I would like to propose a uniform formatting and, if accepted, apply it to all man pages.
Uniformity is very important to me and it should be clear to the user when reading several man pages what exactly their content and references are about.

Signed-off-by: Alexander Richter <67486332+Procyhon@users.noreply.github.com>
2021-05-27 22:42:50 +02:00
b4bbc5210b [CI:DOCS] Add titles to remote docs (windows)
Previously the podman-remote windows docs had no HTML titles

This gives them the same titles as the equivalent Sphinx HTML pages

Signed-off-by: Rob Cowsill <42620235+rcowsill@users.noreply.github.com>
2021-04-29 22:18:13 +01:00
09f2c01ded [CI:DOCS] Add local html build info to docs/README.md
Rename Readme.md to README.md in the docs directory.   Add
the local build process per @Luap99 in #9856 for the man pages
to preview any changes that are made.

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
2021-03-30 18:45:40 -04:00