diff options
| author | Zhanna Tsitkov <tsitkova@mit.edu> | 2013-01-31 11:39:44 -0500 |
|---|---|---|
| committer | Zhanna Tsitkov <tsitkova@mit.edu> | 2013-01-31 11:54:17 -0500 |
| commit | fedba8d99e616de74129b64f619990150eb334bb (patch) | |
| tree | 290d55da3e4f1ca2b12e0221e721d9bdad5995fd | |
| parent | 8924d0d333248e7ea1073affdf48eaafc1909d97 (diff) | |
| download | krb5-fedba8d99e616de74129b64f619990150eb334bb.tar.gz krb5-fedba8d99e616de74129b64f619990150eb334bb.tar.xz krb5-fedba8d99e616de74129b64f619990150eb334bb.zip | |
New section: Contributing to Kerb documentation
| -rw-r--r-- | doc/about.rst | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/doc/about.rst b/doc/about.rst index d36acdb7bf..904f612bf3 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -1,5 +1,18 @@ -The Kerberos Documentation Set -============================== +Contributing to the MIT Kerberos Documentation +============================================== + +We are looking for documentation writers and editors who could contribute +towards improving the MIT KC documentation content. If you are an experienced +Kerberos developer and/or administrator, please consider sharing your knowledge +and experience with the Kerberos Community. You can suggest your own topic or +write about any of the topics listed +`here <http://k5wiki.kerberos.org/wiki/Projects/Documentation_Tasks>`__. + +If you have any questions, comments, or suggestions on the existing documents, +please send your feedback via email to krb5-bugs@mit.edu. The HTML version of +this documentation has a "FEEDBACK" link to the krb5-bugs@mit.edu email +address with a pre-constructed subject line. + Background ---------- @@ -8,8 +21,8 @@ Starting with release 1.11, the Kerberos documentation set is unified in a central form. Man pages, HTML documentation, and PDF documents are compiled from reStructuredText sources, and the application developer documentation incorporates Doxygen markup from the source -tree. This project was undertaken along the outline described at -http://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation . +tree. This project was undertaken along the outline described +`here <http://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation>`__. Previous versions of Kerberos 5 attempted to maintain separate documentation in the texinfo format, with separate groff manual pages. Having the API @@ -20,13 +33,3 @@ easier to use and maintain, reStructuredText-based documents should provide an improved experience for the user. Consolidating all the documentation formats into a single source document makes the documentation set easier to maintain. - -Feedback and Comments ---------------------- - -At the moment, comments should be sent via email to -krb5-bugs@mit.edu. - -The HTML version of this documentation has a "FEEDBACK" link -(at the bottom of every page) to the krb5-bugs@mit.edu email address -with a pre-constructed subject line. |