Gabriela Gibson wrote on Mon, Dec 31, 2012 at 22:17:14 +0000:
> 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>
> +
Thanks for the patch!
I'm a bit surprised that this wasn't already documented... also, perhaps
add a README (in publish/ or its parent) pointing to this new doc?
> +<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>
> +
Is this for httpd 2.2, 2.4, or both?
> + <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
What about:
AddOutputFilter INCLUDES .html
> + </pre></li>
> +
> + <li>Turn on SSI parsing for html files for the relevant DocumentRoot.
> + The relevant Apache directive is:
> + <pre> XBitHack on
I think it would be more correct to enable .htaccess files (and link to
ours while you're at it). The live webservers don't have XBitHack
enabled in httpd.conf, only in .htaccess .
> + </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/*
chmod -R community-guide/
to catch dotfiles and subdirs too.
Also 0775 merits a warning --- on some systems all users are in the same
primary group by default, so 775 would be halfway to world-readable.
Would 755 suffice?
> + </pre></li>
> +</ol>
> +
> + <Directory /var/wwww2/site/publish/>
wwww2 ?
> + ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
Why? Our site doesn't use CGI.
> +<p>We require that all patches for the web site have been validated in
> + prior to submission.</p>
> +
This could be discouraging to contributors. Can we relax this to say
"Don't have obvious syntax errors [I mean mismatched tags], please
validate if you can"?
Seriously, all of the stuff you're documenting is advanced. We don't
want people who want to just fix a typo think they need to install httpd
for that. (That happens to be a low bar for most devs, since we already
have local httpd installations for 'make davautocheck'.)
> +<p>For a full discussion of the Subversion patch requirements, please
> + follow the project
> + general patch guidelines
Should this use GUIDE_GENERAL_PAGE and GUIDE_CONVENTIONS_PAGE ?
> + and
> + log message guidelines.</p>
> +
> +<p>For web site changes, log messages should refer to html anchor tags
> + instead of functions.</p>
> +
> +</div> <!-- web_patch_creation -->
Thanks much for the patch,
Daniel
Received on 2013-01-03 05:35:20 CET