Generating Event Tree Documentation
Last modified by John on 2020/10/27 20:10
Introduction
The "hcron doc" tool makes it easy to generate documentation from event definitions. This means that event definitions and documentation do not need to be managed separately. The tool also generates indexes which makes looking things up, identifying uses, cross-referencing easy.
Sample Events
/hello/bill → /hello/template (symlink).
/hello/joan → /hello/template (symlink).
/hello/template:
description=Hello message template.
contact=bigboss@abc.xyz
url=http://www.abc.xyz/hello
label=example,hello
as_user=
host=
command=
notify_email=littleguy@abc.xyz
notify_subject=Hello to you from $HCRON_EVENT_NAME
notify_message=
when_year=2019
when_month=*
when_day=*
when_hour=*
when_minute=*
when_dow=*
next_event=
failover_event=/failover/notify
template_name=template
contact=bigboss@abc.xyz
url=http://www.abc.xyz/hello
label=example,hello
as_user=
host=
command=
notify_email=littleguy@abc.xyz
notify_subject=Hello to you from $HCRON_EVENT_NAME
notify_message=
when_year=2019
when_month=*
when_day=*
when_hour=*
when_minute=*
when_dow=*
next_event=
failover_event=/failover/notify
template_name=template
/failover/notify:
description=Failover notification
contact=admin@abc.xyz
url=
label=failover,admin
as_user=
host=
command=
notify_email=admin@abc.xyz
notify_subject=Reporting failure $HCRON_EVENT_CHAIN
notify_message=
when_month=
when_day=
when_hour=
when_minute=
when_dow=
next_event=
failover_event=
template_name=notify
contact=admin@abc.xyz
url=
label=failover,admin
as_user=
host=
command=
notify_email=admin@abc.xyz
notify_subject=Reporting failure $HCRON_EVENT_CHAIN
notify_message=
when_month=
when_day=
when_hour=
when_minute=
when_dow=
next_event=
failover_event=
template_name=notify
Generated Documentation
Command:
hcron doc --show-source -c /etc/hcron/hcron.conf ~/.hcron/hcrondoctest/events
Notes:
- Links added for: email addresses, URLs, event references.
- The "back" button does not work properly in Confluence, but does in a regular HTML page.