diff options
| author | Michael Klishin <mklishin@pivotal.io> | 2018-12-07 02:05:44 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-07 02:05:44 +0300 |
| commit | def0a53d821e7c99a9b59c89e9bbcf1baf23f594 (patch) | |
| tree | c294d0c355851b1c97a854007fc46935eeaed464 | |
| parent | f8f231e9d5d2412f65f00ea0b95e5ec6ae2ba538 (diff) | |
| download | rabbitmq-server-git-def0a53d821e7c99a9b59c89e9bbcf1baf23f594.tar.gz | |
Explain how man pages are generated
Per discussion with @lukebakken.
| -rw-r--r-- | docs/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index 74bce06870..7efad23cf1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,3 +8,20 @@ This directory contains [CLI tool](https://rabbitmq.com/cli.html) man page sourc * A [systemd unit file example](./rabbitmq-server.service.example) Please [see rabbitmq.com](https://rabbitmq.com/documentation.html) for documentation guides. + +## man Pages + +### Source Files + +This directory contains man pages that are are converted to HTML using `mandoc`: + + gmake web-manpages + +The result is then copied to the [website repository](https://github.com/rabbitmq/rabbitmq-website/tree/live/site/man) + +### Contributions + +Since deployed man pages are generated, it is important to keep them in sync with the source. +Accepting community contributions — which will always come as website pull requests — +is fine but the person who merges them is responsible for backporting all changes +to the source pages in this repo. |