This is a first cut, there is room for improvement, please let me know
what you think.
Because of the size of the changes, I considered attaching the resulting
web page -- would that be appropriate in future?
Happy New Year!
Gabriela
[[[
Addition of section describing procedure for obtaining the source for the
Subversion web site
Add three new files creating one extra page on web site accessible at
/docs/community-guide/web.html.
* publish/docs/community-guide/web.html
(New page): Provide the top-level html page for the new page.
* publish/docs/community-guide/web.toc.html
(New page): Provide table-of-contents for new page.
* publish/docs/community-guide/web.part.html
(New page): Provide body text for new page
(Introduction): Provide brief overview of structure of web pages on
subversion site.
(web_sources): Provide instructions for accessing web sources via
https or svn.
(web_mirror): Provide instructions for creating mirror of Subversion
site with Apache.
(web_validation): Provide instructions for validating changes.
(web_patch_creation): Describe format of commit log message for
web changes.
* publish/docs/community-guide/releasing.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/issues.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/guide-nav.html
(topmenu): Add SSI variable pointing to web.html.
* publish/docs/community-guide/community-guide.html
(site-content): Add SSI variable pointing to web.html.
(Table of Contents): Add link to web.toc.html.
* publish/docs/community-guide/conventions.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/index.html
(Table of Contents): Add link to web.html.
* publish/docs/community-guide/l10n.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/mailing-lists.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/general.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/roles.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/debugging.html
(site-content): Add SSI variable pointing to web.html.
* publish/docs/community-guide/building.html
(site-content): Add SSI variable pointing to web.html.
]]]
Index: publish/docs/community-guide/releasing.html
===================================================================
--- publish/docs/community-guide/releasing.html (revision 1427049)
+++ publish/docs/community-guide/releasing.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="releasing.part.html" -->
Index: publish/docs/community-guide/issues.html
===================================================================
--- publish/docs/community-guide/issues.html (revision 1427049)
+++ publish/docs/community-guide/issues.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="issues.part.html" -->
Index: publish/docs/community-guide/web.html
===================================================================
--- publish/docs/community-guide/web.html (revision 0)
+++ publish/docs/community-guide/web.html (revision 0)
@@ -0,0 +1,34 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+<title>Apache Subversion - Community Guide - Making Changes to the Web Site</title>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<style type="text/css">
+ @import url("/style/site.css");
+</style>
+</head>
+
+<body>
+<!--#include virtual="/site-banner.html" -->
+<!--#include virtual="/site-nav.html" -->
+<div id="site-content">
+<!--#include virtual="/site-notice.html" -->
+
+<!--#set var="GUIDE_BUILDING_PAGE" value="building.html" -->
+<!--#set var="GUIDE_CONVENTIONS_PAGE" value="conventions.html" -->
+<!--#set var="GUIDE_DEBUGGING_PAGE" value="debugging.html" -->
+<!--#set var="GUIDE_GENERAL_PAGE" value="general.html" -->
+<!--#set var="GUIDE_ISSUES_PAGE" value="issues.html" -->
+<!--#set var="GUIDE_L10N_PAGE" value="l10n.html" -->
+<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
+<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
+<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_CHANGES_PAGE" value="web.html" -->
+
+<!--#include virtual="guide-nav.html" -->
+<!--#include virtual="web.part.html" -->
+
+</div> <!-- #site-content -->
+</body>
+</html>
Property changes on: publish/docs/community-guide/web.html
___________________________________________________________________
Added: svn:executable
+ *
Index: publish/docs/community-guide/guide-nav.html
===================================================================
--- publish/docs/community-guide/guide-nav.html (revision 1427049)
+++ publish/docs/community-guide/guide-nav.html (working copy)
@@ -8,6 +8,7 @@
<li><a href="/docs/community-guide/conventions.html">Coding and Commit Conventions</a></li>
<li><a href="/docs/community-guide/building.html">Building and Testing</a></li>
<li><a href="/docs/community-guide/debugging.html">Debugging Subversion</a></li>
+<li><a href="/docs/community-guide/web.html">Web Site Changes</a></li>
<li><a href="/docs/community-guide/mailing-lists.html">Mailing Lists</a></li>
<li><a href="/docs/community-guide/issues.html">Bugs/Issues</a></li>
<li><a href="/docs/community-guide/releasing.html">Making Subversion Releases</a></li>
Index: publish/docs/community-guide/community-guide.html
===================================================================
--- publish/docs/community-guide/community-guide.html (revision 1427049)
+++ publish/docs/community-guide/community-guide.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="" -->
<!--#set var="GUIDE_ROLES_PAGE" value="" -->
+<!--#set var="GUIDE_WEB_PAGE" value="" -->
<h1>Subversion Community Guide (aka "HACKING")</h1>
@@ -53,6 +54,9 @@ first.</p>
<li><a href="#debugging">Debugging Subversion</a>
<!--#include virtual="debugging.toc.html"-->
</li>
+<li><a href="#web-site-changes">Web Site Changes</a>
+<!--#include virtual="web.toc.html"-->
+</li>
<li><a href="#mailing-lists">Mailing Lists</a>
<!--#include virtual="mailing-lists.toc.html"-->
</li>
@@ -73,6 +77,7 @@ first.</p>
<!--#include virtual="roles.part.html"-->
<!--#include virtual="conventions.part.html"-->
<!--#include virtual="building.part.html"-->
+<!--#include virtual="web.part.html"-->
<!--#include virtual="debugging.part.html"-->
<!--#include virtual="mailing-lists.part.html"-->
<!--#include virtual="issues.part.html"-->
Index: publish/docs/community-guide/web.toc.html
===================================================================
--- publish/docs/community-guide/web.toc.html (revision 0)
+++ publish/docs/community-guide/web.toc.html (revision 0)
@@ -0,0 +1,18 @@
+<!--#if expr='"$DOCUMENT_NAME" = "web.html" || "$DOCUMENT_NAME" = "community-guide.html"' -->
+<ul>
+ <li><a href="#web_intro">Introduction</a></li>
+ <li><a href="#web_sources">Obtaining the web site source</a></li>
+ <li><a href="#web_mirror">Setting up a mirror for testing</a></li>
+ <li><a href="#web_validation">Validating your changes</a></li>
+ <li><a href="#web_patch_creation">Creating a patch</a></li>
+</ul>
+<!--#else -->
+<ul>
+ <li><a href="web.html#web_intro">Introduction</a></li>
+ <li><a href="web.html#web_sources">Obtaining the web site source</a></li>
+ <li><a href="web.html#web_mirror">Setting up a mirror for testing</a></li>
+ <li><a href="web.html#web_validation">Validating your changes</a></li>
+ <li><a href="web.html#web_patch_creation">Creating a patch</a></li>
+</ul>
+<!--#endif -->
+
Property changes on: publish/docs/community-guide/web.toc.html
___________________________________________________________________
Added: svn:executable
+ *
Index: publish/docs/community-guide/conventions.html
===================================================================
--- publish/docs/community-guide/conventions.html (revision 1427049)
+++ publish/docs/community-guide/conventions.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="conventions.part.html" -->
Index: publish/docs/community-guide/index.html
===================================================================
--- publish/docs/community-guide/index.html (revision 1427049)
+++ publish/docs/community-guide/index.html (working copy)
@@ -44,6 +44,9 @@ first.</p>
<li><a href="debugging.html">Debugging Subversion</a>
<!--#include virtual="debugging.toc.html"-->
</li>
+<li><a href="web.html">Web Site Changes</a>
+<!--#include virtual="web.toc.html"-->
+</li>
<li><a href="mailing-lists.html">Mailing Lists</a>
<!--#include virtual="mailing-lists.toc.html"-->
</li>
Index: publish/docs/community-guide/l10n.html
===================================================================
--- publish/docs/community-guide/l10n.html (revision 1427049)
+++ publish/docs/community-guide/l10n.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="l10n.part.html" -->
Index: publish/docs/community-guide/mailing-lists.html
===================================================================
--- publish/docs/community-guide/mailing-lists.html (revision 1427049)
+++ publish/docs/community-guide/mailing-lists.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="mailing-lists.part.html" -->
Index: publish/docs/community-guide/general.html
===================================================================
--- publish/docs/community-guide/general.html (revision 1427049)
+++ publish/docs/community-guide/general.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="general.part.html" -->
Index: publish/docs/community-guide/web.part.html
===================================================================
--- publish/docs/community-guide/web.part.html (revision 0)
+++ publish/docs/community-guide/web.part.html (revision 0)
@@ -0,0 +1,175 @@
+<div class="h1" id="web-site-changes">
+<h1>Web Site Changes
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_PAGE" -->#web-site-changes"
+ title="Link to this section">¶</a>
+</h1></div> <!-- web-site-changes -->
+
+<!--#include virtual="web.toc.html" -->
+
+<div class="h2" id="web_intro">
+<h2>Introduction
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_CHANGES_PAGE" -->#web_intro"
+ title="Link to this section">¶ </a>
+</h2>
+
+<p>The Subversion project welcomes improvements to the web site. However,
+ the process is not as simple as clicking "Save As" in a browser, editing
+ and mailing the change. For one thing, many pages are actually composed
+ of three or more files. Because of this, we recommend obtaining a copy
+ of the sources and checking your changes on a testing mirror.</p>
+
+<p>Read on for details on how this is done.</p>
+
+</div> <!-- web_intro -->
+
+<div class="h2" id="web_sources">
+<h2>Obtaining the web site sources
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_CHANGES_PAGE" -->#web_sources"
+ title="Link to this section">¶ </a>
+</h2>
+
+<p>The source to the website is available from a Subversion repository.
+ To browse the sources, go to
+ <a href="https://svn.apache.org/repos/asf/subversion/site/";>
+ https://svn.apache.org/repos/asf/subversion/site/</a>
+ <br />To download a copy to the location used for the rest of this page,
+ use the following commands:
+</p>
+<pre>
+ mkdir /var/www2
+ cd /var/www2
+ svn co https://svn.apache.org/repos/asf/subversion/site/ site</pre>
+
+<p>If you download to another location, you will need to adjust paths
+ in your web server configuration to point there.</p>
+
+<br />
+</div> <!-- web_sources -->
+
+<div class="h2" id="web_mirror">
+<h2>Setting up a mirror for testing
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_CHANGES_PAGE" -->#web_mirror"
+ title="Link to this section">¶</a>
+</h2>
+
+<p>The Subversion web site uses Server Side Includes to assemble pages
+ within the web server. This means that to validate any changes you
+ might wish to make, you need view the relevant pages through a web
+ browser connected to a server. While this may be trivial to many
+ readers, the following list is provided for the rest of humanity.</p>
+
+<p>The following steps should provide an Apache virtualhost faithfully
+ rendering a local copy of the Subversion web site on a Unix-type
+ system. This is likely to be located under
+ <tt>/etc/apache2, /etc/httpd</tt>
+ or a similiar directory, depending on your system.</p>
+
+<ol>
+ <li>Obtain the web site sources as described in the section above.</li>
+
+ <li>Check your Apache server includes <tt>mod_include.so</tt></li>
+
+ <li>Configure an Apache server to use the <tt>site/publish</tt>
+ directory within the working copy mentioned above as DocumentRoot
+ for either the main server or a VirtualHost.</li>
+
+ <li>Enable Server Side Includes for the relevant DocumentRoot. The
+ relevant Apache directive is:
+ <pre> Options +Include
+ </pre></li>
+
+ <li>Turn on SSI parsing for html files for the relevant DocumentRoot.
+ The relevant Apache directive is:
+ <pre> XBitHack on
+ </pre></li>
+
+ <li>Turn on the execute bit for the relevant files. This should be
+ the case in the working copy, but is worth checking. For this guide,
+ the command would be:
+ <pre>
+ chmod 775 /var/www2/site/publish/community-guide/*
+ </pre></li>
+</ol>
+
+<p>Putting it all together, an example VirtualHost configuration is:</p>
+
+<pre><VirtualHost *:80>
+ ServerAdmin webmaster@localhost
+
+ DocumentRoot /var/www2/site/publish
+ <Directory />
+ Options FollowSymLinks +Includes
+ AllowOverride None
+ XBitHack on
+ </Directory>
+ <Directory /var/wwww2/site/publish/>
+ Options Indexes FollowSymLinks MultiViews +Includes
+ AllowOverride None
+ Order allow,deny
+ allow from all
+ XBitHack on
+ </Directory>
+
+ ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
+ <Directory "/usr/lib/cgi-bin">
+ AllowOverride None
+ Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
+ Order allow,deny
+ Allow from all
+ </Directory>
+
+ ErrorLog ${APACHE_LOG_DIR}/error.log
+
+ # Possible values include: debug, info, notice, warn, error, crit,
+ # alert, emerg.
+ LogLevel debug
+
+ CustomLog ${APACHE_LOG_DIR}/access.log combined
+</VirtualHost>
+</pre>
+
+<p>Note: this was modified from an Ubuntu example.</p>
+
+<p>After restarting or reloading the server, you should see a copy of the
+ Subversion home page. For validation of your setup, the relative path
+ <tt>/docs/community-guide/web.html</tt> on your server should show this
+ section.</p>
+
+</div> <!-- web_mirror -->
+
+<div class="h2" id="web_validation">
+<h2>Validating your changes
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_CHANGES_PAGE" -->#web_validation"
+ title="Link to this section">¶</a>
+</h2>
+
+<p>We require that all patches for the web site have been validated in
+ prior to submission.</p>
+
+<p>Please use the <a href="http://validator.w3.org/";>W3C validator service</a>
+ on your changes prior to submission.</p>
+
+</div> <!-- web_validation -->
+
+<div class="h2" id="web_patch_creation">
+<h2>Creating a patch
+ <a class="sectionlink"
+ href="<!--#echo var="GUIDE_WEB_CHANGES_PAGE" -->#web_patch_creation"
+ title="Link to this section">¶</a>
+</h2>
+
+<p>For a full discussion of the Subversion patch requirements, please
+ follow the project
+ <a href="general.html#patches">general patch guidelines</a>
+ and
+ <a href="conventions.html#log-messages">log message guidelines</a>.</p>
+
+<p>For web site changes, log messages should refer to html anchor tags
+ instead of functions.</p>
+
+</div> <!-- web_patch_creation -->
Property changes on: publish/docs/community-guide/web.part.html
___________________________________________________________________
Added: svn:executable
+ *
Index: publish/docs/community-guide/roles.html
===================================================================
--- publish/docs/community-guide/roles.html (revision 1427049)
+++ publish/docs/community-guide/roles.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="roles.part.html" -->
Index: publish/docs/community-guide/debugging.html
===================================================================
--- publish/docs/community-guide/debugging.html (revision 1427049)
+++ publish/docs/community-guide/debugging.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="web.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="debugging.part.html" -->
Index: publish/docs/community-guide/building.html
===================================================================
--- publish/docs/community-guide/building.html (revision 1427049)
+++ publish/docs/community-guide/building.html (working copy)
@@ -24,6 +24,7 @@
<!--#set var="GUIDE_MAILINGLISTS_PAGE" value="mailing-lists.html" -->
<!--#set var="GUIDE_RELEASING_PAGE" value="releasing.html" -->
<!--#set var="GUIDE_ROLES_PAGE" value="roles.html" -->
+<!--#set var="GUIDE_WEB_PAGE" value="building.html" -->
<!--#include virtual="guide-nav.html" -->
<!--#include virtual="building.part.html" -->
