summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorArnaud Cogoluègnes <acogoluegnes@gmail.com>2018-12-11 17:09:37 +0100
committerArnaud Cogoluègnes <acogoluegnes@gmail.com>2018-12-11 17:09:37 +0100
commit8317600c5f65b42149827849f5c5fcaf766a5512 (patch)
treeaae47583893eb28a9054f5f280128d48da0d158d /docs/README.md
parenteb3bb7ebb7a6491a09843165c64f6f6ac6bc5dea (diff)
parentc80289849404a153f141ff96208abcd9c65f0153 (diff)
downloadrabbitmq-server-git-8317600c5f65b42149827849f5c5fcaf766a5512.tar.gz
Merge branch 'master' into rabbitmq-server-1743-exclusive-consumer
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md17
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.