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 @@ + + + + + + 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 1435758) +++ publish/docs/community-guide/conventions.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/index.html =================================================================== --- publish/docs/community-guide/index.html (revision 1435758) +++ publish/docs/community-guide/index.html (working copy) @@ -44,6 +44,9 @@ first.

  • Debugging Subversion
    • +
  • Web Site Changes + +
  • Mailing Lists
    • Index: publish/docs/community-guide/issues.html =================================================================== --- publish/docs/community-guide/issues.html (revision 1435758) +++ publish/docs/community-guide/issues.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/mailing-lists.html =================================================================== --- publish/docs/community-guide/mailing-lists.html (revision 1435758) +++ publish/docs/community-guide/mailing-lists.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/general.html =================================================================== --- publish/docs/community-guide/general.html (revision 1435758) +++ publish/docs/community-guide/general.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/roles.html =================================================================== --- publish/docs/community-guide/roles.html (revision 1435758) +++ publish/docs/community-guide/roles.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/debugging.html =================================================================== --- publish/docs/community-guide/debugging.html (revision 1435758) +++ publish/docs/community-guide/debugging.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/releasing.html =================================================================== --- publish/docs/community-guide/releasing.html (revision 1435758) +++ publish/docs/community-guide/releasing.html (working copy) @@ -24,6 +24,7 @@ + Index: publish/docs/community-guide/l10n.html =================================================================== --- publish/docs/community-guide/l10n.html (revision 1435758) +++ publish/docs/community-guide/l10n.html (working copy) @@ -24,6 +24,7 @@ + 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 @@ + + + +Apache Subversion - Community Guide - Making Changes to the Web Site + + + + + + + +
    + + + + + + + + + + + + + + + + +
    + + Property changes on: publish/docs/community-guide/web.html ___________________________________________________________________ Added: svn:executable + * Index: publish/docs/community-guide/community-guide.html =================================================================== --- publish/docs/community-guide/community-guide.html (revision 1435758) +++ publish/docs/community-guide/community-guide.html (working copy) @@ -24,6 +24,7 @@ +

    Subversion Community Guide (aka "HACKING")

    @@ -53,6 +54,9 @@ first.

  • Debugging Subversion
    • +
  • Web Site Changes + +
  • Mailing Lists
    • @@ -73,6 +77,7 @@ first.

    + Index: publish/docs/community-guide/guide-nav.html =================================================================== --- publish/docs/community-guide/guide-nav.html (revision 1435758) +++ publish/docs/community-guide/guide-nav.html (working copy) @@ -8,6 +8,7 @@
  • Coding and Commit Conventions
  • Building and Testing
  • Debugging Subversion
    • +
  • Web Site Changes
  • Mailing Lists
  • Bugs/Issues
  • Making Subversion Releases
    • 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,196 @@ +
    +

    Web Site Changes + #web-site-changes" + title="Link to this section">¶ +

    + + + +
    +

    Introduction + #web_intro" + title="Link to this section">¶ +

    + +

    The Subversion project welcomes improvements to its 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 so browsers do not save + a correctly rendered copy. +

    +

    + Because of this, if you're planning to submit substantial changes, + we recommend that you obtain a copy of the sources and set up a + testing mirror to check your changes. +

    +

    + Of course, for small changes, simply inspecting the patch visually + will often be sufficient. +

    + +
    + +
    +

    Obtaining the web site sources + #web_sources" + title="Link to this section">¶ +

    + +

    The source to the website is available from a Subversion repository. + To browse the sources, go to + + https://svn.apache.org/repos/asf/subversion/site/ +

    +

    To download a copy to ~/projects/svn, which is the + location used for the rest of this page, use the following commands: +

    +
      mkdir -p ~/projects/svn
+  cd ~/projects/svn
+  svn co https://svn.apache.org/repos/asf/subversion/site/ site
    + +

    If you download to another location, you will need to adjust paths + in your web server configuration to point there.

    + +
    + +
    +

    Setting up a mirror for testing + #web_mirror" + title="Link to this section">¶ +

    + +

    The Subversion web site uses Server Side Includes (SSI) 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 installed on your + system, either + Apache 2.2 + or + Apache 2.4. + +

    + +

    The following steps should provide an Apache virtualhost + that correctly renders a local copy of the Subversion web site on + a Unix-type system. This is likely to be located under + /etc/apache2, /etc/httpd or a similiar directory, + depending on your system. These instructions have been tested on + Apache 2.2 and Apache 2.4.

    + +
      +
    1. Obtain the web site sources as described in the section above. +
      For the purpose of the following discussion, we will assume + that these are in the directory /home/user/projects/svn/site
      2. + +
    2. Configure an Apache server to use the site/publish + directory within the working copy mentioned above as DocumentRoot + for either the main server or a VirtualHost.
      3. + +
    3. Check your Apache server includes mod_include.so
      4. + +
    4. Enable Server Side Includes for the relevant DocumentRoot. The + relevant Apache directive is: + 
      Options +Include
+
      5. + +
    5. Turn on SSI parsing for html files for the relevant DocumentRoot. + The relevant Apache directive is: + 
      XBitHack on
+
      6. + +
    6. 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: +
      chmod 755 -R /home/user/projects/svn/site/publish/docs/community-guide
      +
      7. +
    + +

    Putting it all together, an example VirtualHost configuration is:

    + +
    <VirtualHost *:8080>
+        ServerAdmin webmaster@localhost
+
+        DocumentRoot /home/user/projects/svn/site/publish
+        <Directory />
+                Options FollowSymLinks
+		## The subversion site uses the .htaccess file to 
+                ## enable "Includes" and XBitHack
+                AllowOverride All
+        </Directory>
+        <Directory /home/user/projects/svn/site/publish/>
+                Options Indexes FollowSymLinks MultiViews
+                AllowOverride All
+                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>
+
    + +

    After restarting or reloading the server, you should see a copy of + the Subversion community guide Web Changes page if you use + the following link: + + #web_mirror"> +

    http://127.0.0.1:8080/docs/community-guide/#web_mirror
    +

    + +
    + +
    +

    Validating your changes + #web_validation" + title="Link to this section">¶ +

    + +

    Please validate all patches which make substantial changes to the + web site.

    + +

    If you have set up a mirror of the website as advised on this page, +use the command line to fetch a correctly rendered copy of the page +you've changed with +

    wget http://127.0.0.1:8080/docs/community-guide/YOUR_CHANGED_PAGE.html
+
    +

    +

    then upload the resulting file to a HTML validatory, for +example, W3C validator service. + +

    + +
    +

    Creating a patch and a log message + #web_patch_creation" + title="Link to this section">¶ +

    + +

    + When writing log messages for patches regarding the project's web pages, eg: +

    +
    http://subversion.apache.org/docs/community-guide/some_page.html#section-name
+
    +

    list the names of files modified in the patch in the log message, + relative to the site/ directory and list anchors of + sections added or modified like this: + 

    + * docs/community-guide/some_page.html
+   (section-name): fixed issue xyz
+
    +

    For a full discussion of the Subversion patch requirements, please + follow the project + #patches">general patch guidelines + and + #log-messages">log message guidelines.

    +
    Property changes on: publish/docs/community-guide/web.part.html ___________________________________________________________________ Added: svn:executable + * Index: publish/docs/community-guide/building.html =================================================================== --- publish/docs/community-guide/building.html (revision 1435758) +++ publish/docs/community-guide/building.html (working copy) @@ -24,6 +24,7 @@ + Index: README =================================================================== --- README (revision 0) +++ README (revision 0) @@ -0,0 +1,10 @@ + The Subversion Web Site + ======================= + +(Note: this file is not visible on the Subversion site) + +This tree contains the Subversion web site. The DocumentRoot is pointed +at the publish/ directory. + +A discussion on how to set up a local mirror of the Subversion site is +available at http://subversion.apache.org/docs/community-guide/web.html \ No newline at end of file