doc/about.rst

   1 Contributing to the MIT Kerberos Documentation
   2 ==============================================
   3
   4 We are looking for documentation writers and editors who could contribute
   5 towards improving the MIT KC documentation content.  If you are an experienced
   6 Kerberos developer and/or administrator, please consider sharing your knowledge
   7 and experience with the Kerberos Community.  You can suggest your own topic or
   8 write about any of the topics listed
   9 `here <https://k5wiki.kerberos.org/wiki/Projects/Documentation_Tasks>`__.
  10
  11 If you have any questions, comments, or suggestions on the existing documents,
  12 please send your feedback via email to krb5-bugs@mit.edu. The HTML version of
  13 this documentation has a "FEEDBACK" link to the krb5-bugs@mit.edu email
  14 address with a pre-constructed subject line.
  15
  16
  17 Background
  18 ----------
  19
  20 Starting with release 1.11, the Kerberos documentation set is
  21 unified in a central form.  Man pages, HTML documentation, and PDF
  22 documents are compiled from reStructuredText sources, and the application
  23 developer documentation incorporates Doxygen markup from the source
  24 tree.  This project was undertaken along the outline described
  25 `here <https://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation>`__.
  26
  27 Previous versions of Kerberos 5 attempted to maintain separate documentation
  28 in the texinfo format, with separate groff manual pages.  Having the API
  29 documentation disjoint from the source code implementing that API
  30 resulted in the documentation becoming stale, and over time the documentation
  31 ceased to match reality.  With a fresh start and a source format that is
  32 easier to use and maintain, reStructuredText-based documents should provide
  33 an improved experience for the user.  Consolidating all the documentation
  34 formats into a single source document makes the documentation set easier
  35 to maintain.