]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
New section: Contributing to Kerb documentation
authorZhanna Tsitkov <tsitkova@mit.edu>
Thu, 31 Jan 2013 16:39:44 +0000 (11:39 -0500)
committerZhanna Tsitkov <tsitkova@mit.edu>
Thu, 31 Jan 2013 16:54:17 +0000 (11:54 -0500)
doc/about.rst

index d36acdb7bfc53552221e0ad8c0b7171fb4dfcd15..904f612bf34bc05500f3d9b714c25d5585442593 100644 (file)
@@ -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.