Re: [PATCH] code file names linkified in general.html of the Hacking Gttuide

[Gabriela Gibson <ga...@gmail.com>]

On 19/12/12 12:59, Stefan Sperling wrote:
> Here it looks like we'll end up closing <li> twice. Was that on purpose?

Oops :( -- Firefox saved a mangled original I worked on and when I 
looked at the messy patch this produced, I decided to get a fresh copy 
and to 'buff it out' by copying the changes manually from the broken 
copy and thus I introduced this error.

Most of this would not have happened if I had svn protection here I 
guess -- would it be worthwhile to add the html part of the project to 
the revision tree?

Network access isn't always a givens and the guide is a key document, 
it'll be nice to have in the /doc dir.

As an aside, Lynx also saves a a bad copy.  I didn't expect that -- 10 
years ago this all worked just fine! :o)

> I haven't checked all other tags for similar errors, not enough time.
> It might be a good idea to run an XHTML validator on the modified file.
>

It might be useful to add the info of how to submit web pages patches to 
the the 'log messages' section of the guide 
(http://subversion.apache.org/docs/community-guide/conventions.html#log-messages) 
for example:

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

http://subversion.apache.org/docs/communityguide/somepage.html#section-name

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

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

Please validate the new hmtl file with a XHTML validator and check all 
the links before submitting the patch.

(Optional: Please use wget to download an uncorrupted original to modify 
instead of a copy saved by your browser.)
]]]

David Shahaf wrote:

 > I'd say link to APR 1.5.x, which is the current release in the 1.x
 > series: 
http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/include> /apr_pools.h

If it generates a continuous liability maybe this part is best left 
untouched, or perhaps preserved in a static file?

Re: [PATCH] code file names linkified in general.html of the Hacking Gttuide

[Daniel Shahaf <d....@daniel.shahaf.name>]

Gabriela Gibson wrote on Thu, Dec 20, 2012 at 21:05:39 +0000:
> (Optional: Please use wget to download an uncorrupted original to modify  
> instead of a copy saved by your browser.)

Just note that we use SSI (server-side includes) to include the
top and left navigation bars on each page, so the served pages are not
identical to those in svn.  This of course doesn't affect the common
case (since the unidiff will apply with offset $(wc -l site-nav.html)),
but since you write this advice you should be aware of the issue.

> ]]]
>
> David Shahaf wrote:
>
> > I'd say link to APR 1.5.x, which is the current release in the 1.x
> > series:  

This quote is by Stefan Sperling.

Re: [PATCH] code file names linkified in general.html of the Hacking Gttuide

[Stefan Sperling <st...@elego.de>]

On Thu, Dec 20, 2012 at 09:05:39PM +0000, Gabriela Gibson wrote:
> Most of this would not have happened if I had svn protection here I
> guess -- would it be worthwhile to add the html part of the project
> to the revision tree?

It is in the repository at https://svn.apache.org/repos/asf/subversion/site
Whenever we make a commit there the change show up on the web site.

So to submit changes to the site, just send patch generated from a
working copy checked out from the above URL.

> Network access isn't always a givens and the guide is a key
> document, it'll be nice to have in the /doc dir.

The community guide is within the above URL as well :)
See publish/docs/community-guide/

> As an aside, Lynx also saves a a bad copy.  I didn't expect that --
> 10 years ago this all worked just fine! :o)

Hah!

> >I haven't checked all other tags for similar errors, not enough time.
> >It might be a good idea to run an XHTML validator on the modified file.
> >
> 
> It might be useful to add the info of how to submit web pages
> patches to the the 'log messages' section of the guide (http://subversion.apache.org/docs/community-guide/conventions.html#log-messages)
> for example:
> 
> [[[
> When writing log messages for patches regarding the project's web pages, eg:
> 
> http://subversion.apache.org/docs/communityguide/somepage.html#section-name
> 
> list the names of files modified in the patch in the log message,
> relative to site/publication and list anchors of sections added or
> modified like this:
> 
> * docs/community-guide/some_page.html
>   (section-name): fixed issue xyz
> 
> Please validate the new hmtl file with a XHTML validator and check
> all the links before submitting the patch.
> 
> (Optional: Please use wget to download an uncorrupted original to
> modify instead of a copy saved by your browser.)
> ]]]

I agree, it would be useful to mention this in the community guide.
Could you send a patch to the website that makes this change,
based on a working copy of https://svn.apache.org/repos/asf/subversion/site ?
That would be great. Thanks!