Commit graph

9 commits

Author SHA1 Message Date
Ben Kochie
570bfba80e
Add CI test for man page updates (#3729)
Run make -f Makefile.doc in CircleCI to test that man pages are updated
in PRs.

Signed-off-by: Ben Kochie <superq@gmail.com>
2020-03-26 10:00:46 +01:00
Miek Gieben
d4d019d749
docs: Makefile.release and Makefile.doc (#2926)
* add metrics for reload
* documented release process better
* run: Makefile.doc all to push reload doc to man-pages

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-06-26 11:18:03 +01:00
Miek Gieben
b780f49ccf
manpages: chop off first header (#2764)
each readme starts with the plugin's name as a header, this needs to be
chopped off to provide a good manual page.

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 14:09:05 +01:00
Miek Gieben
f8aa208cc0
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the
dependency on 'ronn' and just uses mmark (Go program).

Re-hookup Makefile.doc to generate the correct header mmark needs to
see and regenate them all.

Spot checking a few pages suggest they look good and actually better
than rendered with ronn, esp. lists in lists.

Fixes #2757

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
Miek Gieben
6f865a9de7
Run make -f Makefile.doc (#1875)
Fix typo corendns -> coredns in coredns.1
2018-06-13 11:02:14 +01:00
Miek Gieben
ed02f5f2a2 release improvements (#1439)
Last release I forgot steps, put them in Makefile.release. Generating
the manual files will be skipped if 'ronn' can't be found.
2018-01-26 08:57:08 -08:00
Miek Gieben
da230cd1fa
manpages: regen and really add corefile.5 (#1377) 2018-01-11 09:46:40 +00:00
Miek Gieben
a8e268e33b
doc: add corefile(5) manual page (#1351) 2018-01-06 15:53:33 +00:00
Miek Gieben
58221f55db
Manual pages (#1346)
* Add manual pages

Generate manual pages from the README and extend README with Name and
Description sections.

The generation requires 'ronn' which may not be available. Just check in
all generated manual pages.
2018-01-04 12:53:07 +00:00