You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Gabriela Gibson <ga...@gmail.com> on 2012/12/31 23:17:14 UTC
[PATCH] Procedure for making web page changes
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
Re: [PATCH] Procedure for making web page changes
Posted by Ben Reser <be...@reser.org>.
On Tue, Feb 19, 2013 at 5:06 AM, Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> I see. The interesting part is that I asked about
> AddOutputFilter INCLUDES .html
> because httpd.conf has it enabled for us specifically. I Also tested by
> hand and confirmed that /www/subversion.apache.org/index2.html has SSI
> directives parsed even if it lacks a +x bit. So it seems we should
> migrate to AddOutputFilter --- both in your patch and in the live
> site's .htaccess,*.html files. Do you agree?
The XBitHack doesn't do anything on Windows so I'd think for the
purposes of this guide explicitly enabling INCLUDES seems better.
Also if Daniel is saying that our site is using an explicit INCLUDES
we should use that in our directions since it'll make the local test
setup match the server better and hopefully avoid mistakes such as not
expecting values to be parsed by the server just because we forgot to
set the execute bit on a file.
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Wed, Feb 20, 2013 at 21:03:58 +0000:
> On 20/02/13 18:54, Daniel Shahaf wrote:
>> Gabriela Gibson wrote on Wed, Feb 20, 2013 at 16:22:36 +0000:
>>> +<p>Putting it all together, an example VirtualHost configuration is:</p>
>>> +
>>> +<pre><VirtualHost *:8080>
>>> + ServerAdmin webmaster@localhost
>>
>> Consider putting this example in a separate *.conf file, to make it
>> easier to reuse?
>
> I've left it on for now, but I'm wondering if you find it too spammy
> this way or it's just the convenience of the *.conf file? We can do
> both, but indeed, there is a lot to be said for brevity.
>
It's not about spammy, it's about convenience for people who use it, as
I tried to demonstrate in the 'diff' invocation I gave:
>> 'diff -u ~/projects/svn/site/**/svnsite.conf /etc/apache2/svnsite.conf'
Doing both would cause redundancy... unless you use an SSI include to
inline the .conf snippet file into the HTML ?
>>> +<p>then upload the resulting file to a HTML validatory, for
>>
>> "validatory"?
>>
> Yes :) It's an unusual but technically correct term. I've left it in
> for now, because one thing about documentation is that it's a little
> boring to read, and interesting wording helps people remember things
> easier.
>
See below.
>> +1 to commit. (Everything else can be addressed post-commit if you
>> disagree with the review.) Thanks or the patch!
>>
>
> To sum up:
>
> 1) .htaccess and permission changes will go into a separate patch.
>
> 2) With view to a further patch, the term 'Validatory' is still being
> discussed,
You're being generous here. You said "validatory" was right and I won't
argue with a native British speaker about such matters.
> and we need to decide is the conf stays on the page and/or is
> moved to it's own file, linked from this spot.
>
You wrote the patch, so whatever you decide. (My review comment around
that was a suggestion, not a requirement.) Please commit.
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Daniel Shahaf wrote on Wed, Feb 20, 2013 at 20:54:31 +0200:
> Gabriela Gibson wrote on Wed, Feb 20, 2013 at 16:22:36 +0000:
> > +++ publish/.htaccess (working copy)
> > @@ -1,7 +1,6 @@
> > # duplicated in httpd.conf in r795618
> > Options +Includes
> >
> > -XBitHack On
> > RedirectMatch ^/buildbot(.*) http://ci.apache.org/waterfall?\
> > \&show=bb-openbsd\
> > \&show=svn-slik-w2k3-x64-local\
>
> You might want to commit this part separately? It isn't as much related
> to the other changes as something we found while working on them.
Forgot to add: once you commit that, we might as well drop the
"svn:executable" property from all *.html files.
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 20/02/13 18:54, Daniel Shahaf wrote:
> Gabriela Gibson wrote on Wed, Feb 20, 2013 at 16:22:36 +0000:
>> On 20/02/13 15:28, Gabriela Gibson wrote:
>> +++ publish/.htaccess (working copy)
>> @@ -1,7 +1,6 @@
>> # duplicated in httpd.conf in r795618
>> Options +Includes
>>
>> -XBitHack On
>> RedirectMatch ^/buildbot(.*) http://ci.apache.org/waterfall?\
>> \&show=bb-openbsd\
>> \&show=svn-slik-w2k3-x64-local\
>
> You might want to commit this part separately? It isn't as much related
> to the other changes as something we found while working on them.
True. Removed and queued.
>> +++ publish/docs/community-guide/community-guide.html (working copy)
>> @@ -73,6 +77,7 @@ first.</p>
> You seem to have added "web" before "debugging" here, while it's after
> "debugging" everywhere else.
Oops. Thanks, and well spotted!
>
>> +++ publish/docs/community-guide/web.part.html (revision 0)
>
> A couple of minor comments about this file:
>
>> +<p>Putting it all together, an example VirtualHost configuration is:</p>
>> +
>> +<pre><VirtualHost *:8080>
>> + ServerAdmin webmaster@localhost
>
> Consider putting this example in a separate *.conf file, to make it
> easier to reuse?
I've left it on for now, but I'm wondering if you find it too spammy
this way or it's just the convenience of the *.conf file? We can do
both, but indeed, there is a lot to be said for brevity.
>
> 'diff -u ~/projects/svn/site/**/svnsite.conf /etc/apache2/svnsite.conf'
>
>> +<p>then upload the resulting file to a HTML validatory, for
>
> "validatory"?
>
Yes :) It's an unusual but technically correct term. I've left it in
for now, because one thing about documentation is that it's a little
boring to read, and interesting wording helps people remember things
easier.
>>
>> Addition of section to Community Guide describing procedure for
>
> Use the imperative: "Add a section"
>
Fixed.
> You didn't include README in the patch.
Oops. Fixed. Forgot to 'svn add'.
> Bottom line: once the points about README and .htaccess are addressed,
Done.
> +1 to commit. (Everything else can be addressed post-commit if you
> disagree with the review.) Thanks or the patch!
>
To sum up:
1) .htaccess and permission changes will go into a separate patch.
2) With view to a further patch, the term 'Validatory' is still being
discussed, and we need to decide is the conf stays on the page and/or is
moved to it's own file, linked from this spot.
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Wed, Feb 20, 2013 at 16:22:36 +0000:
> On 20/02/13 15:28, Gabriela Gibson wrote:
>> On 20/02/13 07:24, Daniel Shahaf wrote:
>>> <Directory /x1/www/subversion.apache.org>
>>
>> Thank you :)
>>
>> The patch and log are attached.
> Sorry, I'm just hooked on phonics at the moment (and the virus I'm still
> wrestling is probably innocent), a correction is attached.
> I added the log file again and also updated the number just so it's
> all neat.
Excellent.
> +++ publish/.htaccess (working copy)
> @@ -1,7 +1,6 @@
> # duplicated in httpd.conf in r795618
> Options +Includes
>
> -XBitHack On
> RedirectMatch ^/buildbot(.*) http://ci.apache.org/waterfall?\
> \&show=bb-openbsd\
> \&show=svn-slik-w2k3-x64-local\
You might want to commit this part separately? It isn't as much related
to the other changes as something we found while working on them.
> +++ publish/docs/community-guide/community-guide.html (working copy)
> @@ -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"-->
You seem to have added "web" before "debugging" here, while it's after
"debugging" everywhere else.
> +++ publish/docs/community-guide/web.part.html (revision 0)
A couple of minor comments about this file:
> +<p>Putting it all together, an example VirtualHost configuration is:</p>
> +
> +<pre><VirtualHost *:8080>
> + ServerAdmin webmaster@localhost
Consider putting this example in a separate *.conf file, to make it
easier to reuse?
'diff -u ~/projects/svn/site/**/svnsite.conf /etc/apache2/svnsite.conf'
> +<p>then upload the resulting file to a HTML validatory, for
"validatory"?
> +<p> list the names of files modified in the patch in the log message,
> + relative to the <code>site/</code> directory and list anchors of
> + sections added or modified like this:
> + <pre>
> + * docs/community-guide/some_page.html
> + (section-name): fixed issue xyz
I usually write '(#section-name)', but a quick log inspection suggests
I'm in a minority in that.
> [[[
>
> Addition of section to Community Guide describing procedure for
Use the imperative: "Add a section"
> obtaining the source for the Subversion web site. Addition of
> navigation links to new page within community guide.
>
> Add three html files creating one extra page on web site accessible at
> /docs/community-guide/web.html. Also add README in top level directory
> providing link to new web page.
>
> * 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.
>
> * README
> (New file): Provide link to new /docs/community-guide/web.html page.
You didn't include README in the patch.
Bottom line: once the points about README and .htaccess are addressed,
+1 to commit. (Everything else can be addressed post-commit if you
disagree with the review.) Thanks or the patch!
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 20/02/13 15:28, Gabriela Gibson wrote:
> On 20/02/13 07:24, Daniel Shahaf wrote:
>> <Directory /x1/www/subversion.apache.org>
>
> Thank you :)
>
> The patch and log are attached.
Sorry, I'm just hooked on phonics at the moment (and the virus I'm still
wrestling is probably innocent), a correction is attached. I added the
log file again and also updated the number just so it's all neat.
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 20/02/13 07:24, Daniel Shahaf wrote:
> <Directory /x1/www/subversion.apache.org>
Thank you :)
The patch and log are attached.
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Tue, Feb 19, 2013 at 22:37:35 +0000:
> On 19/02/13 13:06, Daniel Shahaf wrote:
>> I see. The interesting part is that I asked about
>> AddOutputFilter INCLUDES .html
>> because httpd.conf has it enabled for us specifically. I Also tested by
>> hand and confirmed that /www/subversion.apache.org/index2.html has SSI
>> directives parsed even if it lacks a +x bit. So it seems we should
>> migrate to AddOutputFilter --- both in your patch and in the live
>> site's .htaccess,*.html files. Do you agree?
>
> Ben's point about windows seems conclusive to me.
>
> However, I'm struggling on my 2.4 server with my updated instructions.
>
> Please could you include the relevant sections from the Subversion site
> configuration because they are running 2.4.3?
<Directory /x1/www/subversion.apache.org>
Options +Includes
AddOutputFilter INCLUDES .html
</Directory>
I don't see any other relevant settings in the vhost config, but people
with access (infra and members) can review the settings here:
https://svn.apache.org/repos/infra/infrastructure/trunk/httpd-conf/www.apache.org/vhosts/zzzothers.conf
https://svn.apache.org/repos/infra/infrastructure/trunk/httpd-conf/www.apache.org/httpd.conf
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 19/02/13 13:06, Daniel Shahaf wrote:
> I see. The interesting part is that I asked about
> AddOutputFilter INCLUDES .html
> because httpd.conf has it enabled for us specifically. I Also tested by
> hand and confirmed that /www/subversion.apache.org/index2.html has SSI
> directives parsed even if it lacks a +x bit. So it seems we should
> migrate to AddOutputFilter --- both in your patch and in the live
> site's .htaccess,*.html files. Do you agree?
Ben's point about windows seems conclusive to me.
However, I'm struggling on my 2.4 server with my updated instructions.
Please could you include the relevant sections from the Subversion site
configuration because they are running 2.4.3?
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Sun, Jan 20, 2013 at 11:57:13 +0000:
> On 20/01/13 05:17, Daniel Shahaf wrote:
>> Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
>>> On 03/01/13 04:34, Daniel Shahaf wrote:
>>>>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>>>>> + relevant Apache directive is:
>>>>> + <pre> Options +Include
>>>>
>>>> What about:
>>>>
>>>> AddOutputFilter INCLUDES .html
>>>>
>>> Do we actually need this? I've not put it in since I was only
>>> documenting the steps I used.
>>
>> Isn't it required to enable SSI?
>
> My tests seem to suggest that the xbithack is sufficient.
>
> It appears to be an either-or decision, the method I've used allows to
> publish by setting the execute bit, the other way simply publishes all
> docs in that dir that have the matching extension, see:
>
> http://httpd.apache.org/docs/2.2/howto/ssi.html#configuring
I see. The interesting part is that I asked about
AddOutputFilter INCLUDES .html
because httpd.conf has it enabled for us specifically. I Also tested by
hand and confirmed that /www/subversion.apache.org/index2.html has SSI
directives parsed even if it lacks a +x bit. So it seems we should
migrate to AddOutputFilter --- both in your patch and in the live
site's .htaccess,*.html files. Do you agree?
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
(this is a test, I hope this does not make it's own, new thread!)
On 1/20/13, Gabriela Gibson <ga...@gmail.com> wrote:
> On 20/01/13 05:17, Daniel Shahaf wrote:
>> Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
>>> On 03/01/13 04:34, Daniel Shahaf wrote:
>>>>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>>>>> + relevant Apache directive is:
>>>>> + <pre> Options +Include
>>>>
>>>> What about:
>>>>
>>>> AddOutputFilter INCLUDES .html
>>>>
>>> Do we actually need this? I've not put it in since I was only
>>> documenting the steps I used.
>>
>> Isn't it required to enable SSI?
>
> My tests seem to suggest that the xbithack is sufficient.
>
> It appears to be an either-or decision, the method I've used allows to
> publish by setting the execute bit, the other way simply publishes all
> docs in that dir that have the matching extension, see:
>
> http://httpd.apache.org/docs/2.2/howto/ssi.html#configuring
>
This is the email that we stopped at :)
Gabriela
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 20/01/13 05:17, Daniel Shahaf wrote:
> Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
>> On 03/01/13 04:34, Daniel Shahaf wrote:
>>>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>>>> + relevant Apache directive is:
>>>> + <pre> Options +Include
>>>
>>> What about:
>>>
>>> AddOutputFilter INCLUDES .html
>>>
>> Do we actually need this? I've not put it in since I was only
>> documenting the steps I used.
>
> Isn't it required to enable SSI?
My tests seem to suggest that the xbithack is sufficient.
It appears to be an either-or decision, the method I've used allows to
publish by setting the execute bit, the other way simply publishes all
docs in that dir that have the matching extension, see:
http://httpd.apache.org/docs/2.2/howto/ssi.html#configuring
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Tue, Feb 19, 2013 at 12:35:16 +0000:
> Sorry for the reply mess, I wish I could reply to my last post to the
> thread, but I can't -- as Brane informs me, Google is discarding my
> emails, so I have to see about another email account that isn't as
> 'helpful' :)
>
I won't disagree :-) But if you need to get a list email, you can grab
it from the list archives --- either from gmane or from the mbox files
on apache.org. There are links on /mailing-lists.html
> Gabriela
Re: [PATCH] Procedure for making web page changes
Posted by Branko Čibej <br...@wandisco.com>.
On 19.02.2013 13:35, Gabriela Gibson wrote:
> On 20/01/13 05:17, Daniel Shahaf wrote:
>> Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
>>> On 03/01/13 04:34, Daniel Shahaf wrote:
>>>>> + <li>Enable Server Side Includes for the relevant DocumentRoot.
>>>>> The
>>>>> + relevant Apache directive is:
>>>>> + <pre> Options +Include
>>>>
>>>> What about:
>>>>
>>>> AddOutputFilter INCLUDES .html
>>>>
>>> Do we actually need this? I've not put it in since I was only
>>> documenting the steps I used.
>>
>> Isn't it required to enable SSI? Do you get the sidebar, etc rendered
>> or do you get the SSI directives in the HTML delivered to the browser?
>>
>> Thanks for the other fixes; I'll review the patch later (have breakfast
>> and meetings).
>>
> Hi Daniel,
>
> this fell between the cracks, please see the email from me in the
> thread that answers this post of yours.
>
> Sorry for the reply mess, I wish I could reply to my last post to the
> thread, but I can't -- as Brane informs me, Google is discarding my
> emails, so I have to see about another email account that isn't as
> 'helpful' :)
Ahem, I did not say "disdarding". They're still in your Sent folder, and
you can reply to them from there just fine.
-- Brane
--
Branko Čibej
Director of Subversion | WANdisco | www.wandisco.com
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 20/01/13 05:17, Daniel Shahaf wrote:
> Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
>> On 03/01/13 04:34, Daniel Shahaf wrote:
>>>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>>>> + relevant Apache directive is:
>>>> + <pre> Options +Include
>>>
>>> What about:
>>>
>>> AddOutputFilter INCLUDES .html
>>>
>> Do we actually need this? I've not put it in since I was only
>> documenting the steps I used.
>
> Isn't it required to enable SSI? Do you get the sidebar, etc rendered
> or do you get the SSI directives in the HTML delivered to the browser?
>
> Thanks for the other fixes; I'll review the patch later (have breakfast
> and meetings).
>
Hi Daniel,
this fell between the cracks, please see the email from me in the thread
that answers this post of yours.
Sorry for the reply mess, I wish I could reply to my last post to the
thread, but I can't -- as Brane informs me, Google is discarding my
emails, so I have to see about another email account that isn't as
'helpful' :)
Gabriela
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Gabriela Gibson wrote on Sun, Jan 20, 2013 at 00:15:46 +0000:
> On 03/01/13 04:34, Daniel Shahaf wrote:
>>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>>> + relevant Apache directive is:
>>> + <pre> Options +Include
>>
>> What about:
>>
>> AddOutputFilter INCLUDES .html
>>
> Do we actually need this? I've not put it in since I was only
> documenting the steps I used.
Isn't it required to enable SSI? Do you get the sidebar, etc rendered
or do you get the SSI directives in the HTML delivered to the browser?
Thanks for the other fixes; I'll review the patch later (have breakfast
and meetings).
Re: [PATCH] Procedure for making web page changes
Posted by Gabriela Gibson <ga...@gmail.com>.
On 03/01/13 04:34, Daniel Shahaf wrote:
>
> 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?
>
Done.
<snip>
>> + <li>Check your Apache server includes <tt>mod_include.so</tt></li>
>> +
>
> Is this for httpd 2.2, 2.4, or both?
>
Tested for 2.2 and 2.4. The text now mentions this.
<snip>
>> + <li>Enable Server Side Includes for the relevant DocumentRoot. The
>> + relevant Apache directive is:
>> + <pre> Options +Include
>
> What about:
>
> AddOutputFilter INCLUDES .html
>
Do we actually need this? I've not put it in since I was only
documenting the steps I used.
>> + </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 .
>
Thank you. Text changed to do this.
>> + </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.
>
Thank you -- done.
>
> wwww2 ?
>
I chose that as the directory for the first cut. It has been changed to
"/home/user/projects/svn/site" in this cut.
>> + ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
>
> Why? Our site doesn't use CGI.
>
Removed.
>> +<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'.)
>
I've reworded this section to reflect this.
>> +<p>For a full discussion of the Subversion patch requirements, please
>> + follow the project
>> + <a href="general.html#patches">general patch guidelines</a>
>
> Should this use GUIDE_GENERAL_PAGE and GUIDE_CONVENTIONS_PAGE ?
>
Done.
I've included all your points due to the delay in my responding.
Re: [PATCH] Procedure for making web page changes
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
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
> + <a href="general.html#patches">general patch guidelines</a>
Should this use GUIDE_GENERAL_PAGE and GUIDE_CONVENTIONS_PAGE ?
> + 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 -->
Thanks much for the patch,
Daniel