PacketFence - BTS - PacketFence
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0001043PacketFencedocpublic2010-08-04 10:572015-02-13 15:26
Reporterobilodeau 
Assigned Toobilodeau 
PrioritynormalSeverityminorReproducibilityN/A
StatusclosedResolutionopen 
PlatformOSOS Version
Product Version 
Target VersionFixed in Version 
fixed in git revision
fixed in mtn revision
Summary0001043: no documentation for configuration files outside of pf.conf / pf.conf.defaults
DescriptionFind a way to provide documentation for these that match the features of the documentation.conf approach which are:

- parsable and outputable by the CLI
- parsable and outputable by the Web interface
Steps To Reproduce
Additional Information
TagsNo tags attached.
Relationships
related to 0001230closed  networks.conf merged into pf.conf 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2010-08-04 10:57obilodeauNew Issue
2010-08-04 10:57obilodeauStatusnew => assigned
2010-08-04 10:57obilodeauAssigned To => obilodeau
2010-11-09 13:35obilodeauNote Added: 0001756
2010-11-19 14:25obilodeauTarget Version1.10.0 => 2.0.0
2011-01-18 09:47obilodeauTarget Version2.0.0 => 2.1.0
2011-03-03 15:15obilodeauTarget Version2.1.0 => +1
2011-03-03 15:18obilodeauTarget Version+1 => +2
2011-06-30 09:56obilodeauNote Added: 0002098
2011-06-30 09:58obilodeauRelationship addedrelated to 0001230
2011-09-07 17:24obilodeauRelationship addedrelated to 0000929
2011-09-07 17:25obilodeauNote Added: 0002185
2011-10-14 16:30obilodeauRelationship deletedrelated to 0000929
2015-02-13 15:26lmunroNote Added: 0003728
2015-02-13 15:26lmunroStatusassigned => closed

Notes
(0001756)
obilodeau   
2010-11-09 13:35   
something like reStructuredText could do the job?
http://docutils.sourceforge.net/rst.html [^]

We magically build it from the source (inside documentation files themselves) to html when packaging and for plain text, the reST is in there already.

One thing to make sure: if we put it on top of the file, editing the file with the web admin doesn't destroy the reST comments.
(0002098)
obilodeau   
2011-06-30 09:56   
docbook generating both man pages (man pf.conf, man networks.conf, etc.) and web pages included in the Web admin would be the best solution now that we have started to take the docbook path.
(0002185)
obilodeau   
2011-09-07 17:25   
affected files:
- switches.conf
- networks.conf
- violations.conf
(0003728)
lmunro   
2015-02-13 15:26   
Old issues.
Most are not relevant to PF 4 and up.

Let's reopen the ones that matter when we move to github.