Forum: CFEngine Help Subject: Documenting policy Author: neilhwatson Link to topic: https://cfengine.com/forum/read.php?3,26480,26480#msg-26480
Greetings, Let's discuss a dirty word: documentation. We all try to document our code but, few of us do it well or consistently. To this end I've been thinking about how to document my next batch policy files. I see several options. Standard '#' comments in the policy. These are quick and dirty. They are simple to write but perhaps no so simple to use. Policies to create documentation would involve variables and reports promises to output what it needed. The immediate con I see to this is that reports do not offer much in the way of formatting. Further this could make bundles much larger. Separate text files are also an option. These take more time to maintain but can be more detailed. Combining some thoughts above we can also look at using Cfengine template editing. I worry that this could fragment the subject, with some parts in the policy and others in the template files. What are others doing these days to document policies as the grow in volume and complexity? _______________________________________________ Help-cfengine mailing list Help-cfengine@cfengine.org https://cfengine.org/mailman/listinfo/help-cfengine
