Fedora SELinux FAQ

[Karsten Wade]

These last two weeks I've been working on the SELinux pieces of the
Fedora Core 2 test2 release notes.  The current incarnation is available
at:

http://people.redhat.com/kwade/selinux/selinux-faq/selinux-faq-en/
http://people.redhat.com/kwade/selinux/selinux-faq/selinux-faq-en.xml

As described below, this content will start to be released Real Soon
Now(TM), and I am interested in your input.  Consider content quality
(clarity, ease of use, clear to non-native English readers), ability to
translate well, and of course the XML.  In addition, I want to add this
to CVS soonest, therefore I'll need Tammy's input.

Also, I just noticed that the XSL does not create a question ToC, as it
does in the DSSSL Tammy wrote for the Red Hat docs.  Is a bugzilla
report against the fedora.xsl a good way to make a feature request such
as this?  I'm not feeling clued enough to tackle it myself, yet.

If you want the whole story for the SELinux FAQ, here's a picture of the
plans and challenges:

The Plan ::

The SELinux release notes are in a FAQ.  Ed Bailey will take the
<sect1> from me, confirm it will work within the release notes
limitations, and insert that into the release notes XML.

Following release, we will fork the SELinux FAQ into a standalone FAQ. 
This will be kept for the short term in a very easy to read and write
format, such as a plain text file.  Fedora SELinux developers will be
writing to this FAQ often, to help handle bug reports and questions
following the test2 release.

After the FAQ has settled into a new shape, I will take it from the
developers, massage it back into DocBook XML, and move it to the
fedora-docs module in CVS permanently.  I'd like to create the module
in CVS right now mainly to put my work under source control, and to make
it easy for me to add in the updates after I get the FAQ back.

All the details haven't been worked out yet in terms of where the
interim FAQ will live, and where the permanent FAQ will be accessible
via URL.

The Challenges ::

I'm doing the FAQ using a <qandaset>.  The downside is the need for
keeping the XML simple for the release notes.  The release notes need to
be viewable in Anaconda using /usr/lib/anaconda/htmlbuffer.py, which
currently is limited in its ability to handle nested lists and tables. 
The FAQ portion is built using a table, but it breaks reasonably
gracefully.

For a snapshot to be used in the release notes, I may do some magic to
make them ready for the release notes.  Ed suggested a <variablelist>
setup, which is a fairly good method.

I'm keeping the main source in the more useful <qandaset> because the
canonical source will be the Fedora Core SELinux FAQ
(fedora-docs/selinux-faq), so will take full advantage of DocBook.  I'll
have to do any number of manual exports from that for various purposes,
but I think the extra work is worth having a canonical FAQ.

- Karsten
-- 
Karsten Wade
this is not the .signature you are looking for
http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115  5F1B D992 0E06 AD0E 0C41