Confluence Site SetupPage edited by Bob Harner
Comment:
Minor worsmithing
Changes (1)
Full ContentThis document describes our web site setup: what is where and how it works. OverviewMost of the web site and documentation (with the notable exception of the Javadoc API pages) are kept in Confluence. Since the Confluence instance at https://cwiki.apache.org/confluence/ isn't capable of handling a lot of incoming requests, all wiki spaces are statically exported. The SiteExporter program is responsible for that. Once a page in Confluence changes, that page gets re-exported automatically. How SiteExporter worksFor more details see the SiteExporter README. SiteExporter is a command-line Java program that is run hourly (currently at 20 minutes after the hour) from Apache's BuildBot. It makes a web service call to Confluence (to its RSS feed, actually) to get a list of pages that have changed since the last run, and the HTML-formatted export of those pages. For each, it post-processes the file (described below). Finally, SiteExporter commits all changed HTML files into Tapestry's part of the Apache Subversion repository, which (nearly instantly) makes it available to the public at http://tapestry.apache.org, and commit emails are sent to Tapestry's "commits" mailing list. Attachments (to Confluence pages) are exported in roughly the same way. The time between saving a change in Confluence and seeing the result on the public site is at most 1 hour, depending on when you do it. If you save a change at 19 minutes after the hour you'll see the change in about a minute. If you publish it at 21 minutes after the hour then you'll have to wait almost an hour. Post-processing HTML PagesHTML pages exported from Confluence are post-processed in several ways before being committed to SVN. Here are just a few of the things going on:
Manual InterventionYou can cause the whole site to be republished by deleting the main.pageCache file (above) in the subversion repo. This is usually only needed after changing the template. Changing SiteExporter itselfCurrently the SiteExporter source code is an unmodified copy of a program of the same name written by Dan Kulp for the Apache CXF project and also used by Camel, Geronimo, and Struts (and possibly others). It can be customized, but proceed with caution, because any customizations will make it harder to pull in future changes from the original CXF SiteExporter code. The CXF SiteExporter is likely to change as Confluence versions change. To pick up changes to the original CXF SiteExporter code, just compare the Tapestry source code with the CXF source code. Wiki Formatting Guidelines
Website structureThe Index page includes the Banner and Key Features pages as well as the blog posts. Most other pages are just plain pages and may or may not include other parts. In addition the Navigation, Small Banner and Footer pages exist. Our SiteExporter template (described above) glues everything together. It adds the contents of the Navigation and Footer pages in the appropriate places and on all pages except the Index page. It also adds the contents of the Small Banner page as well as the breadcrumbs navigation.
Updating the templateYou must be a Tapestry committer or otherwise have write access to the subversion repository (see link above). To edit the template:
Stop watching space
|
Change email notification preferences
View Online
|
View Changes
|
- [CONF] Apache Tapestry > Confluence Site Setup Bob Harner (Confluence)
- [CONF] Apache Tapestry > Confluence Site S... Bob Harner (Confluence)