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