Skip to content

Commit def0a53

Browse files
Explain how man pages are generated
Per discussion with @lukebakken.
1 parent f8f231e commit def0a53

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,20 @@ This directory contains [CLI tool](https://rabbitmq.com/cli.html) man page sourc
88
* A [systemd unit file example](./rabbitmq-server.service.example)
99

1010
Please [see rabbitmq.com](https://rabbitmq.com/documentation.html) for documentation guides.
11+
12+
## man Pages
13+
14+
### Source Files
15+
16+
This directory contains man pages that are are converted to HTML using `mandoc`:
17+
18+
gmake web-manpages
19+
20+
The result is then copied to the [website repository](https://github.com/rabbitmq/rabbitmq-website/tree/live/site/man)
21+
22+
### Contributions
23+
24+
Since deployed man pages are generated, it is important to keep them in sync with the source.
25+
Accepting community contributions — which will always come as website pull requests —
26+
is fine but the person who merges them is responsible for backporting all changes
27+
to the source pages in this repo.

0 commit comments

Comments
 (0)