Home | About | Sematext search-lucene.com search-hadoop.com
 Search Hadoop and all its subprojects:

Switch to Threaded View
Flume >> mail # dev >> Re: Review Request: Intital version of the Flume web site.

Copy link to this message
Re: Review Request: Intital version of the Flume web site.

> On July 6, 2012, 6:17 a.m., Mike Percy wrote:
> > Thanks for taking this on. I have some initial suggestions / questions:
> > 1. Since the documentation will change release-to-release, we need a place to permanently archive docs for individual releases in at least HTML format (providing and option for PDF is great too). How do we do that in this case? Remember we had talked previously about continuing to include the docs inside each binary release tarball as we do now.
> > 2. There is a navigation bar (stripe) at the top that makes it look more like documentation than a web site. Plus it says Documentation there. Kinda strange. Maybe we should remove it.
> > 3. Is there any way we can make the colors less like http://docs.python.org/ and more like http://www.python.org/ ? :)
> > 4. Is there any way to get the links to indicate when you are on the page they point to? I find the left-hand navigation to be very awkward for a web site (when you click, it's unpredictable what will appear and disappear as you click down the LHS)
> > 5. Quick search, Previous Topic, and Next Topic don't seem to be appropriate here (unless Search can be wired to work somehow)
> >
> > Finally, how would this integrate with Apache CMS? Will it be automatically deployed via the Maven plugin? I don't see that in the pom yet.

1. In the site you will see a "Releases" tab. For each release you would modify releases/index.rst to add the link to the new release and then add a new n.n.n.rst file that contains the links to the release content. You can see samples of those in the site now.  You would then check out the production web site at https://svn.apache.org/repos/infra/websites/production/flume (this is a bit tricky as you don't necessarily want to check out the content for previous releases). You would then add the release content to the releases/content/n.n.n directory where n.n.n is the version number of the release (you will have to create the directory for each new release). You can put anything you want there and link to it from the page you added for the release.  I would recommend using the pdfs instead of the HTML files both the online release and the release tarball if that can be made to work, primarily because PDFs are a lot harder to change.  
2. That is a breadcrumb. I'm not sure what it is using to create that name but I'll dig into it and see if I can't fix it. Or remove breadcrumbs entirely.
3. We can experiment with different themes. The Sphinx web site has links to sites that are built with it and some use different themes. If you like one of those better we could try it.  I might look at a few or try to come up with one I like. However, I haven't looked at theme customization at all yet.
4. Actually, if you know how the web site is constructed the left hand nav is completely predictable.  It only shows sub-nav for the page you are on. The depth of the sub-nav is configurable.  Some other web site templating tools allow the current selection to be highlighted. I'm not sure if this one will do it or not. It may be controllable in the theme.
5. Yeah - I wondered about search. I couldn't get it to work either.  Those three items can be removed with a simple configuration change.

There are a few missing bits for the CMS integration. I will add those in the next pass.  Basically, the CMS will automatically call mvn site whenever a page within the svn area (i.e. flume/site/trunk) is committed - it uses an svn hook.

- Ralph
This is an automatically generated e-mail. To reply, visit:
On July 5, 2012, 6:56 a.m., Ralph Goers wrote:
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/5765/
> -----------------------------------------------------------
> (Updated July 5, 2012, 6:56 a.m.)