You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by rb...@apache.org on 2012/04/14 19:47:22 UTC
svn commit: r1326162 - in /httpd/site/trunk: docs/docs-project/index.html
docs/docs-project/svn.html xdocs/docs-project/index.xml
Author: rbowen
Date: Sat Apr 14 17:47:22 2012
New Revision: 1326162
URL: http://svn.apache.org/viewvc?rev=1326162&view=rev
Log:
Add a brief doc about what to check out and how to generate a patch and
what to do with it.
Added:
httpd/site/trunk/docs/docs-project/svn.html
Modified:
httpd/site/trunk/docs/docs-project/index.html
httpd/site/trunk/xdocs/docs-project/index.xml
Modified: httpd/site/trunk/docs/docs-project/index.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/docs-project/index.html?rev=1326162&r1=1326161&r2=1326162&view=diff
==============================================================================
--- httpd/site/trunk/docs/docs-project/index.html [utf-8] (original)
+++ httpd/site/trunk/docs/docs-project/index.html [utf-8] Sat Apr 14 17:47:22 2012
@@ -82,11 +82,12 @@ href="/info/">Miscellaneous</a></b></p>
format is available from our <a href="http://www.apache.org/dyn/mirrors/mirrors.cgi/httpd/docs/">distribution mirrors</a>.</p>
<p>The Documentation Project is an effort to maintain and improve the
quality of the documentation included with the Apache HTTP Server.
-Participation is open to anyone with a little time, a little knowledge
-of HTML, and hopefully a little knowledge about the Apache HTTP
-Server. No programming knowledge is required, so this is a great way
-for non-programmers to contribute to the success of Apache, and to
-have their work read by millions of Apache users.</p>
+Participation is open to anyone willing to write documentation, edit for
+spelling, grammer or readability, or translate documentation into
+another language. Some knowledge of the Apache HTTP Server is helpful,
+but not required. No programming knowledge is required, so this is a great way
+for non-programmers to contribute to the success of the Apache HTTP Server
+project, and to have their work read by millions of Apache users.</p>
<p>This is <strong>not</strong> a mailing list where users should ask
questions on how to configure Apache. The <a href="../userslist.html">Users List</a> is available for that
purpose.</p>
@@ -112,7 +113,7 @@ be improved.</li>
<li>Join #httpd on irc.freenode.net and tell us there.</li>
<li>Submit a ticket to the <a href="../bug_report.html">bug
database</a>.</li>
-<li>Check out the documentation <a href="https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/">from svn</a>,
+<li>Check out the documentation from svn (<a href="svn.html">instructions here</a>),
and send us a patch.</li>
</ul>
</p>
Added: httpd/site/trunk/docs/docs-project/svn.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/docs-project/svn.html?rev=1326162&view=auto
==============================================================================
--- httpd/site/trunk/docs/docs-project/svn.html (added)
+++ httpd/site/trunk/docs/docs-project/svn.html [utf-8] Sat Apr 14 17:47:22 2012
@@ -0,0 +1,159 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Documentation Project: Subversion - The Apache HTTP Server Project</title>
+ </head>
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+<p><a href="/"><img src="../images/httpd_logo_wide.gif" alt="The Apache HTTP Server Project" border="0"/></a></p>
+ <table border="0" width="100%" cellspacing="4">
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td valign="top" nowrap="nowrap">
+ <p><b>Essentials</b></p>
+ <menu compact="compact">
+ <li><a href="/ABOUT_APACHE.html">About</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://wiki.apache.org/httpd/FAQ">FAQ</a></li>
+ <li><a href="/security_report.html">Security<br />Reports</a></li>
+ </menu>
+ <p><b>Download!</b></p>
+ <menu compact="compact">
+ <li><a href="/download.cgi">from a mirror</a></li>
+ </menu>
+ <p><b><a
+href="/docs/">Documentation</a></b></p>
+ <menu compact="compact">
+ <li><a href="/docs/2.4/">Version 2.4</a></li>
+ <li><a href="/docs/2.2/">Version 2.2</a></li>
+ <li><a href="/docs/2.0/">Version 2.0</a></li>
+ <li><a href="/docs/trunk/">Trunk</a> (dev)</li>
+ <li><a href="http://wiki.apache.org/httpd/">Wiki</a></li>
+ </menu>
+ <p><b>Get Support</b></p>
+ <menu compact="compact">
+ <li><a href="/support.html">Support</a></li>
+ </menu>
+ <p><b>Get Involved</b></p>
+ <menu compact="compact">
+ <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>
+ </menu>
+ <p><b>Subprojects</b></p>
+ <menu compact="compact">
+ <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>
+ </menu>
+ <p><b><a
+href="/info/">Miscellaneous</a></b></p>
+ <menu compact="compact">
+ <li><a href="/contributors/">Contributors</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Sponsors</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ </menu>
+ </td>
+ <!-- RIGHT SIDE INFORMATION -->
+ <td align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr>
+ <td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <strong>Documentation Project: Subversion</strong>
+ </font>
+ </td>
+ </tr>
+ <tr><td>
+ <blockquote>
+<p>The documentation of the Apache HTTP Server is in the same Subversion
+revision control repository as the code. If you wish to work on the
+documentation, you can check out the entire source code repository, or
+just the documentation.</p>
+<p>To check out the entire repository, you'll do the following:</p>
+<example>
+svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk httpd-trunk<br />
+svn checkout https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x httpd-2.4
+</example>
+<p>By checking out both trunk and 2.4, you'll be able to submit patches
+against both the development version, and the current latest released
+version.</p>
+<p>To check out just the documentation portion of the repository, append
+'<code>/docs</code>' to the end of the checkout URLs shown above. This
+will give you a much smaller checkout, but perhaps you'll lack some of
+the resources you might need to verify your documenation changes.</p>
+ </blockquote>
+ </td></tr>
+</table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr>
+ <td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <strong>Creating a patch</strong>
+ </font>
+ </td>
+ </tr>
+ <tr><td>
+ <blockquote>
+<p>Once you have a checkout, creating a patch takes three steps.</p>
+<ol>
+<li><p>Edit the file that you wish to modify. Make the desired changes,
+and then save your changes.</p></li>
+<li><p>At the command line, type the following to create a patch
+file:</p>
+<example>
+svn diff > patch.txt
+</example>
+</li>
+<li><p>Send email to the <code>docs@httpd.apache.org</code> mailing list
+and attach <code>patch.txt</code>.</p></li>
+</ol>
+<p>If you have more than one changed file, you can supply the file name
+on the <code>svn diff</code> command line, in order to just record the
+changes in one file.</p>
+<example>
+svn diff mod_rewrite.xml > mod_rewrite_patch.txt
+</example>
+ </blockquote>
+ </td></tr>
+</table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr>
+ <td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <strong>See Also</strong>
+ </font>
+ </td>
+ </tr>
+ <tr><td>
+ <blockquote>
+<p>See also the document on <a href="docsformat.html">documentation
+format and transformation</a> for details about verifying that your
+changes are complient with our documentation format and standards.</p>
+ </blockquote>
+ </td></tr>
+</table>
+ </td>
+ </tr>
+ <!-- FOOTER -->
+ <tr><td colspan="2"><hr noshade="noshade" size="1"/></td></tr>
+ <tr><td colspan="2" align="center">
+ <font size="-1">
+ <em>Copyright © 2012 The Apache Software Foundation</em>
+ </font>
+ </td>
+ </tr>
+ <tr><td colspan="2" align="center">
+ <font size="-1">
+ <em>Apache HTTP Server, Apache, and the Apache feather logo are trademarks of The Apache Software Foundation.</em>
+ </font>
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
Modified: httpd/site/trunk/xdocs/docs-project/index.xml
URL: http://svn.apache.org/viewvc/httpd/site/trunk/xdocs/docs-project/index.xml?rev=1326162&r1=1326161&r2=1326162&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/docs-project/index.xml [utf-8] (original)
+++ httpd/site/trunk/xdocs/docs-project/index.xml [utf-8] Sat Apr 14 17:47:22 2012
@@ -20,11 +20,12 @@ format is available from our <a href="ht
<p>The Documentation Project is an effort to maintain and improve the
quality of the documentation included with the Apache HTTP Server.
-Participation is open to anyone with a little time, a little knowledge
-of HTML, and hopefully a little knowledge about the Apache HTTP
-Server. No programming knowledge is required, so this is a great way
-for non-programmers to contribute to the success of Apache, and to
-have their work read by millions of Apache users.</p>
+Participation is open to anyone willing to write documentation, edit for
+spelling, grammer or readability, or translate documentation into
+another language. Some knowledge of the Apache HTTP Server is helpful,
+but not required. No programming knowledge is required, so this is a great way
+for non-programmers to contribute to the success of the Apache HTTP Server
+project, and to have their work read by millions of Apache users.</p>
<p>This is <strong>not</strong> a mailing list where users should ask
questions on how to configure Apache. The <a
@@ -44,8 +45,8 @@ be improved.</li>
<li>Join #httpd on irc.freenode.net and tell us there.</li>
<li>Submit a ticket to the <a href="../bug_report.html">bug
database</a>.</li>
-<li>Check out the documentation <a
-href="https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/">from svn</a>,
+<li>Check out the documentation from svn (<a
+href="svn.html">instructions here</a>),
and send us a patch.</li>
</ul>
</p>