doc/html/about.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>Contributing to the MIT Kerberos Documentation &mdash; MIT Kerberos Documentation</title>
  10
  11     <link rel="stylesheet" href="_static/agogo.css" type="text/css" />
  12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  13     <link rel="stylesheet" href="_static/kerb.css" type="text/css" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    './',
  18         VERSION:     '1.15.1',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  24     <script type="text/javascript" src="_static/jquery.js"></script>
  25     <script type="text/javascript" src="_static/underscore.js"></script>
  26     <script type="text/javascript" src="_static/doctools.js"></script>
  27     <link rel="author" title="About these documents" href="#" />
  28     <link rel="copyright" title="Copyright" href="copyright.html" />
  29     <link rel="top" title="MIT Kerberos Documentation" href="index.html" />
  30     <link rel="next" title="Resources" href="resources.html" />
  31     <link rel="prev" title="How to build this documentation from the source" href="build_this.html" />
  32   </head>
  33   <body>
  34     <div class="header-wrapper">
  35         <div class="header">
  36
  37
  38             <h1><a href="index.html">MIT Kerberos Documentation</a></h1>
  39
  40             <div class="rel">
  41
  42         <a href="index.html" title="Full Table of Contents"
  43             accesskey="C">Contents</a> |
  44         <a href="build_this.html" title="How to build this documentation from the source"
  45             accesskey="P">previous</a> |
  46         <a href="resources.html" title="Resources"
  47             accesskey="N">next</a> |
  48         <a href="genindex.html" title="General Index"
  49             accesskey="I">index</a> |
  50         <a href="search.html" title="Enter search criteria"
  51             accesskey="S">Search</a> |
  52     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Contributing to the MIT Kerberos Documentation">feedback</a>
  53             </div>
  54         </div>
  55     </div>
  56
  57     <div class="content-wrapper">
  58       <div class="content">
  59         <div class="document">
  60
  61       <div class="documentwrapper">
  62         <div class="bodywrapper">
  63           <div class="body">
  64
  65   <div class="section" id="contributing-to-the-mit-kerberos-documentation">
  66 <h1>Contributing to the MIT Kerberos Documentation<a class="headerlink" href="#contributing-to-the-mit-kerberos-documentation" title="Permalink to this headline">¶</a></h1>
  67 <p>We are looking for documentation writers and editors who could contribute
  68 towards improving the MIT KC documentation content.  If you are an experienced
  69 Kerberos developer and/or administrator, please consider sharing your knowledge
  70 and experience with the Kerberos Community.  You can suggest your own topic or
  71 write about any of the topics listed
  72 <a class="reference external" href="http://k5wiki.kerberos.org/wiki/Projects/Documentation_Tasks">here</a>.</p>
  73 <p>If you have any questions, comments, or suggestions on the existing documents,
  74 please send your feedback via email to <a class="reference external" href="mailto:krb5-bugs&#37;&#52;&#48;mit&#46;edu">krb5-bugs<span>&#64;</span>mit<span>&#46;</span>edu</a>. The HTML version of
  75 this documentation has a &#8220;FEEDBACK&#8221; link to the <a class="reference external" href="mailto:krb5-bugs&#37;&#52;&#48;mit&#46;edu">krb5-bugs<span>&#64;</span>mit<span>&#46;</span>edu</a> email
  76 address with a pre-constructed subject line.</p>
  77 <div class="section" id="background">
  78 <h2>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h2>
  79 <p>Starting with release 1.11, the Kerberos documentation set is
  80 unified in a central form.  Man pages, HTML documentation, and PDF
  81 documents are compiled from reStructuredText sources, and the application
  82 developer documentation incorporates Doxygen markup from the source
  83 tree.  This project was undertaken along the outline described
  84 <a class="reference external" href="http://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation">here</a>.</p>
  85 <p>Previous versions of Kerberos 5 attempted to maintain separate documentation
  86 in the texinfo format, with separate groff manual pages.  Having the API
  87 documentation disjoint from the source code implementing that API
  88 resulted in the documentation becoming stale, and over time the documentation
  89 ceased to match reality.  With a fresh start and a source format that is
  90 easier to use and maintain, reStructuredText-based documents should provide
  91 an improved experience for the user.  Consolidating all the documentation
  92 formats into a single source document makes the documentation set easier
  93 to maintain.</p>
  94 </div>
  95 </div>
  96
  97
  98           </div>
  99         </div>
 100       </div>
 101         </div>
 102         <div class="sidebar">
 103     <h2>On this page</h2>
 104     <ul>
 105 <li><a class="reference internal" href="#">Contributing to the MIT Kerberos Documentation</a><ul>
 106 <li><a class="reference internal" href="#background">Background</a></li>
 107 </ul>
 108 </li>
 109 </ul>
 110
 111     <br/>
 112     <h2>Table of contents</h2>
 113     <ul class="current">
 114 <li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li>
 115 <li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li>
 116 <li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li>
 119 <li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li>
 120 <li class="toctree-l1"><a class="reference internal" href="formats/index.html">Protocols and file formats</a></li>
 121 <li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="build_this.html">How to build this documentation from the source</a></li>
 123 <li class="toctree-l1 current"><a class="current reference internal" href="">Contributing to the MIT Kerberos Documentation</a><ul class="simple">
 124 </ul>
 125 </li>
 126 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
 127 </ul>
 128
 129     <br/>
 130     <h4><a href="index.html">Full Table of Contents</a></h4>
 131     <h4>Search</h4>
 132     <form class="search" action="search.html" method="get">
 133       <input type="text" name="q" size="18" />
 134       <input type="submit" value="Go" />
 135       <input type="hidden" name="check_keywords" value="yes" />
 136       <input type="hidden" name="area" value="default" />
 137     </form>
 138         </div>
 139         <div class="clearer"></div>
 140       </div>
 141     </div>
 142
 143     <div class="footer-wrapper">
 144         <div class="footer" >
 145             <div class="right" ><i>Release: 1.15.1</i><br />
 146                 &copy; <a href="copyright.html">Copyright</a> 1985-2017, MIT.
 147             </div>
 148             <div class="left">
 149
 150         <a href="index.html" title="Full Table of Contents"
 151             >Contents</a> |
 152         <a href="build_this.html" title="How to build this documentation from the source"
 153             >previous</a> |
 154         <a href="resources.html" title="Resources"
 155             >next</a> |
 156         <a href="genindex.html" title="General Index"
 157             >index</a> |
 158         <a href="search.html" title="Enter search criteria"
 159             >Search</a> |
 160     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Contributing to the MIT Kerberos Documentation">feedback</a>
 161             </div>
 162         </div>
 163     </div>
 164
 165   </body>
 166 </html>