Documentation Project - The Apache HTTP Server Project

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <link href="/css/apsite.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> <meta name="author" content="Documentation Group" /><meta name="email" content="docs@httpd.apache.org" /> <title>Documentation Project - The Apache HTTP Server Project</title> <style> .headerlink { visibility: hidden; } h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink, li:hover > .headerlink { visibility: visible } </style> </head> <body> <div id="page-header"> <p class="menu"> </p> <p class="apache"> </p> <a href="/"> <img alt="" width="800" height="72" src="/images/httpd_logo_wide_new.png" /> </a> <a class="badge" href="https://www.apache.org/foundation/contributing.html"> <img src="https://www.apache.org/images/SupportApache-small.png"> </a> </div> <div id="apmenu"> <script type="text/javascript" src="https://www.apachecon.com/event-images/snippet.js"></script> <p style="margin-top: -10px;">  <a class="acevent" data-format="wide" data-mode="light" data-width="160"></a> </p> <h1 id="essentials">Essentials<a class="headerlink" href="#essentials" title="Permanent link">¶</a></h1> <ul> <li><a href="/download.cgi">Download!</a></li> <li><a href="/ABOUT_APACHE.html">About</a></li> <li><a href="https://www.apache.org/licenses/">License</a></li> <li><a href="https://wiki.apache.org/httpd/FAQ">FAQ</a></li> <li><a href="/security_report.html">Security Reports</a></li> </ul> <h1 id="source-repositories">Source Repositories<a class="headerlink" href="#source-repositories" title="Permanent link">¶</a></h1> <ul> <li><a href="/dev/devnotes.html">General Information</a></li> <li><a href="https://svn.apache.org/viewvc/httpd/httpd/trunk/">Trunk</a></li> <li><a href="https://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/">2.4</a></li> </ul> <h1 id="documentation"><a href="/docs/">Documentation</a><a class="headerlink" href="#documentation" title="Permanent link">¶</a></h1> <ul> <li><a href="/docs/2.4/">Version 2.4</a></li> <li><a href="/docs/trunk/">Trunk (dev)</a></li> <li><a href="https://wiki.apache.org/httpd/">Wiki</a></li> </ul> <h1 id="get-involved"><a href="/contribute/">Get Involved</a><a class="headerlink" href="#get-involved" title="Permanent link">¶</a></h1> <ul> <li><a href="/lists.html">Mailing Lists</a></li> <li><a href="/bug_report.html">Bug Reports</a></li> <li><a href="/dev/">Developer Info</a></li> <li><a href="/support.html">User Support</a></li> </ul> <h1 id="subprojects">Subprojects<a class="headerlink" href="#subprojects" title="Permanent link">¶</a></h1> <ul> <li><a href="/docs-project/">Docs</a></li> <li><a href="/test/">Test</a></li> <li><a href="/test/flood/">Flood</a></li> <li><a href="/apreq/">libapreq</a></li> <li><a href="/modules">Modules</a></li> <li><a href="/mod_fcgid/">mod_fcgid</a></li> <li><a href="/mod_ftp/">mod_ftp</a></li> </ul> <h1 id="related-projects">Related Projects<a class="headerlink" href="#related-projects" title="Permanent link">¶</a></h1> <ul> <li><a href="https://trafficserver.apache.org/">Apache Traffic Server</a></li> <li><a href="https://trafficcontrol.apache.org/">Apache Traffic Control</a></li> <li><a href="https://tomcat.apache.org/">Tomcat</a></li> <li><a href="https://apr.apache.org/">APR</a></li> <li><a href="https://perl.apache.org/">mod_perl</a></li> </ul> <h1 id="miscellaneous"><a href="/info/">Miscellaneous</a><a class="headerlink" href="#miscellaneous" title="Permanent link">¶</a></h1> <ul> <li><a href="/contributors/">Contributors</a></li> <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li> <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> </ul> </div>  <div id="apcontents"> <h1 id="documentation-project">Documentation Project<a class="headerlink" href="#documentation-project" title="Permalink">¶</a></h1> <p>The documentation of the Apache HTTP Server is a collaborative effort, made possible by the participation of the entire HTTP Server community. We'd love to have your help too.</p> <ul> <li> <p><a href="#report">I want to report a problem</a></p> </li> <li> <p><a href="#suggestion">I'd like to make a suggestion</a></p> </li> <li> <p><a href="#svn">I know how to use svn and want to checkout the latest manual</a></p> </li> <li> <p><a href="#build">I'd like to build the manual from local source</a></p> </li> <li> <p><a href="#ml">I'd like to join the docs team mailing list</a></p> </li> <li> <p><a href="#translate">I want to help translate the documentation</a></p> </li> <li> <p><a href="#docs">Actually, I was just looking for the docs</a></p> </li> </ul> <h1 id="report">Reporting a problem<a class="headerlink" href="#report" title="Permalink">¶</a></h1> <p>The best way to report a problem with the documentation is to make a comment on the docs page in question, or to <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation">open a ticket</a>. Select 'Documentation' as the component. Have a look at the <a href="http://s.apache.org/httpd-doc-bugs">list of open documentation bugs</a> to see if it's already covered. We try to keep that list very short.</p> <h1 id="suggestion">Making a suggestion<a class="headerlink" href="#suggestion" title="Permalink">¶</a></h1> <p>If you have a suggestion of something that we could do better, or even want to write a new or replacement document, there are a number of ways to go about it.</p> <p>The best way is probably to <a href="#ml">join the mailing list</a> and strike up a conversation. We always love to have new people on the project.</p> <p>Or, you can <a href="#report">open a ticket</a> , as discussed above. We are very interested in your suggestions, and any way that you think we can improve the documentation. We look forward to hearing from you.</p> <p>The 2.2, 2.4 and trunk documentation also have a comment feature, where you can quickly add a comment about the documentation. To access this, click the "Comments" link on a page or simply scroll down to the bottom.</p> <h1 id="svn">SVN information<a class="headerlink" href="#svn" title="Permalink">¶</a></h1> <p>Our documentation is kept in svn, along with the source code, and the actual changes are all made there. If you intend to be a long-term contributor to the documentation, the best thing to do is to get an svn checkout and submit patches. We've got a <a href="svn.html">document that gives you all of the necessary details</a>.</p> <h1 id="build">Building the docs<a class="headerlink" href="#build" title="Permalink">¶</a></h1> <p>Once you have a checkout from SVN, you need to also check out the docs-build directory and run the relevant build scripts to produce all of the relevant transformations. Please see <a href="docsformat.html">docs build</a> for more information.</p> <h1 id="ml">The docs mailing list<a class="headerlink" href="#ml" title="Permalink">¶</a></h1> <p>The discussion surrounding the documentation project happens on the <code>docs@httpd.apache.org</code> mailing list. To subscribe to this mailing list, send email to <a href="mailto:docs-subscribe@httpd.apache.org">docs-subscribe@httpd.apache.org</a> and follow the instructions in the response you receive.</p> <p>The archives of this mailing list may be found at <a href="https://lists.apache.org/list.html?docs@httpd.apache.org">lists.apache.org</a> , if you want to have a preview of how we do things, and who the main characters are.</p> <h1 id="translate">Translations<a class="headerlink" href="#translate" title="Permalink">¶</a></h1> <p>The documentation is available in several different languages. Some of these translations are out of date, and some important languages are missing. If you are fluent in a non-English language, and would like to provide a translation of all or part of the documentation, there's <a href="translations.html">another document</a> about how to get started on that. Before you get started, please <a href="#ml">join the mailing list</a> , introduce yourself, and let us know what you're working on. In that way, other translators can coordinate with you in this effort.</p> <h1 id="docs">Where are the docs?<a class="headerlink" href="#docs" title="Permalink">¶</a></h1> <p>Documentation is available for several different versions of the server:</p> <p>Online Documentation: <a href="../docs/2.0/">Version 2.0</a> | <a href="../docs/2.2/">Version 2.2</a> | <a href="../docs/2.4/">Version 2.4</a> | <a href="../docs/trunk/">Version 2.5 (Development branch)</a> | <a href="http://wiki.apache.org/httpd/">Wiki</a></p> <p>Downloadable documentation in Microsoft Help (CHM) format is available from our <a href="http://www.apache.org/dyn/mirrors/mirrors.cgi/httpd/docs/">distribution mirrors</a>.</p> <h1 id="participants">Participants<a class="headerlink" href="#participants" title="Permalink">¶</a></h1> <p>The Apache HTTP Server documentation is the product of the work of many, many people. We've listed them <a href="contributors.html">over here</a>.</p>  <div id="footer"> <p>Copyright © 1997-2024 The Apache Software Foundation.<br /> Apache HTTP Server, Apache, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> </div> </div> </body> </html>

CINXE.COM

Documentation Project - The Apache HTTP Server Project