[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: community guide redux

From: Julian Foad <julian.foad_at_wandisco.com>
Date: Thu, 04 Feb 2010 09:59:11 +0000

Justin Erenkrantz wrote:
> http://subversion.apache.org/docs/community-guide/general.html
> http://subversion.apache.org/docs/community-guide/index-onepage.html
> (Outside of, well, this post, it's not hooked up to the rest of the
> site - IOW, the old index.html is still in place. So, I'm going with
> C-T-R for now.)
> I took a shot at reworking the community guide and splitting it up
> into something manageable across pages while also retaining a one-page
> view for those who like that sorta thing. It splits each section up
> into three files:
> <section>.html - Mostly synthesized page
> <section>.toc.html - Pointer to all # tags
> <section>.part.html - Actual content lives here
> If this looks good, we can then replace the current index.html and
> figure out best to link to it from the "main" site.
> Bring on yer flamethrowers... -- justin


Looks good.

Comments on the per-section pages:

- Nav-menu needs to look significantly different from the main site nav
menu, and/or be integrated with it. It needs at least to say "*Community
Guide*" at the top of it, otherwise it looks like it's the nav menu of
the whole site.

- The pages need a page title saying "Community Guide" (or "Subversion
Community Guide") at the top of the main pane (above the section title
"General"/"Community Roles"/etc).

- Links to other sections will need to be updated to point to the new
section file. Currently they try to link to the same file.

- Would be nice to have "Next page" and "Previous page" links at the
very end of the page, for those reading through. (But that's an
enhancement that can come later.)

Comments on the all-in-one page:

- Apply the same style to it. (Take care that logically corresponding
heading levels match up.)


- Julian
Received on 2010-02-04 10:59:50 CET

This is an archived mail posted to the Subversion Dev mailing list.