aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-05-26 21:17:08 +0200
committerAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-05-27 22:42:50 +0200
commit6deb1bc2aea34320fd0b463257332cfa06475aa1 (patch)
tree30ded36e5daa08d31db18c627bda3f1553645f4e /CONTRIBUTING.md
parent8f71881a63b5b5422efe523d10d360650ecf9c67 (diff)
downloadpodman-6deb1bc2aea34320fd0b463257332cfa06475aa1.tar.gz
podman-6deb1bc2aea34320fd0b463257332cfa06475aa1.tar.bz2
podman-6deb1bc2aea34320fd0b463257332cfa06475aa1.zip
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>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cb8bce9ed..cbe0fcfab 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -126,6 +126,10 @@ Well, you can now create your own branch, apply changes on it, and then submitti
For further reading about branching [you can read this document](https://herve.beraud.io/containers/linux/podman/isolate/environment/2019/02/06/how-to-hack-on-podman.html).
+## Documentation
+
+Make sure to update the documentation if needed. You can find the man pages under `docs/source/markdown`. The syntax for the formatting of all man pages can be found [here](docs/MANPAGE_SYNTAX.md).
+
## Submitting Pull Requests
No Pull Request (PR) is too small! Typos, additional comments in the code,