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