Re: Introducing docs/ directory
On 11/7/13, 9:28 PM, Eric H. Christensen wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
On Thu, Nov 07, 2013 at 05:27:42PM -0500, Shawn Wells wrote:
> The need for documentation has increased as the project matures and
> gained popularity. To this end a "User Guide" and a "Developers
> Guide" has taken shape. The initial code dump (original patch was
> ~4MB, hence not posting to list first!):
> https://git.fedorahosted.org/cgit/scap-security-guide.git/tree/docs
This is great news. I'll take a read through this soon.
It appears (based on the website) that this is DocBook XML (and Publican for the
renderer). I'm fluent in DocBook XML so if anyone needs anything added but
doesn't feel comfortable writing it please shoot it my way for markup.
Spot on
for both points. Based upon a recommendation from Gary some time
ago, I went ahead and purchased a copy of Oxygen XML Editor... best.
thing. ever. Native editing of DocBook. Any tips/tools you use for
editing DocBook would be most welcome.
On the content side, converting the Workbook to DocBook has been on the
to do list for at least 6 months. I really don't know how much effort
that'd be... here are copies of the content:
ODT @
http://people.redhat.com/swells/2013-03-25%20SCAP%20Workshop%20-%20Course...
PDF @
http://blog-shawndwells.rhcloud.com/wp-content/uploads/2013/07/SCAP-Works...
How much work do you think that'd be? I tried OpenOffice's ODT->DocBook
conversion.... absolutely no luck.
Are we going to start using a ticketing system of some kind to track
additions (to docs and/or the rules) or just keep things on the mailing list?
https://fedorahosted.org/scap-security-guide/newticket
https://fedorahosted.org/scap-security-guide/report/1