Author: rgardler
Date: Sat Oct 22 05:30:12 2005
New Revision: 327656
URL: http://svn.apache.org/viewcvs?rev=327656&view=rev
Log:
add a faq on maintaining the site
Added:
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml
(with props)
Modified:
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/site.xml
Added:
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml
URL:
http://svn.apache.org/viewcvs/forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml?rev=327656&view=auto
==============================================================================
---
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml
(added)
+++
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml
Sat Oct 22 05:30:12 2005
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.2//EN"
"http://forrest.apache.org/dtd/faq-v12.dtd"; [
+<!ENTITY s '<code>site.xml</code>'>
+]>
+<faqs title="Frequently Asked Questions">
+ <part id="maintaining">
+ <title>Maintaining Apache Projects Site</title>
+ <faq id="overview">
+ <question>How is the Apache Projects site built?</question>
+ <answer>
+ <p>The Apache Projects site is built using
+ <link href="site:forrest">Apache Forrest</link> with the
+ <link href="site:forrest/projectInfo">Project Info plugin</link>. </p>
+ </answer>
+ </faq>
+ <faq id="updating">
+ <question>How is the site updated?</question>
+ <answer>
+ <p>Currently it is rebuilt every 3 hours via a cron job. The build
+ can be triggered in from any script.</p>
+ </answer>
+ </faq>
+ <faq id="errorReporting">
+ <question>What happens if there is a problem with a site
build?</question>
+ <answer>Broken links and other such problems with a site build will be
emailed
+ to nominated email addresses. In this way any problem with the site is
+ autmoatically reported.</answer>
+ </faq>
+ <faq id="addProject">
+ <question>How do we add a new project?</question>
+ <answer>Simply add an entry to a locationmap file. This describes where
all
+ the projects DOAPs are, the idea is that they can be anywhere that
Forrest
+ can access (SVN, CVS, HTTP, file system and pretty much any other
protocol.</answer>
+ </faq>
+ <faq id="maintainingLocationmap">
+ <question>Do we have to manually maintain this file?</question>
+ <answer>At present, yes. However, if we define a way of automatically
+ discovering where these DOAPs are then it can easily be
automated.</answer>
+ </faq>
+ <faq id="addProjectToIndex">
+ <question>How do we add projects to the indexes?</question>
+
+ <answer>If the index already exists, for example, the site currently has
a
+ "Java" and "All" index then you need not do anything. Any DOAP that has
+ the relevant information to make it part of the index (e.g. have "Java"
in
+ the programming languages list) will automatically be included in that
index
+ on the next site build.</answer>
+ </faq>
+ <faq id="addIndex">
+ <question>How do we add an index?</question>
+
+ <answer>
+ <p>Create an XSL that will process the full list of projects, add a
+ processing step to the projectInfo plugin in Forrest that uses this
XSL
+ and add a link to the output in the site.xml file.</p>
+
+ <p>This process can be simplified by more work on the projectInfo
plugin,
+ but for now ask for more guidance on the [EMAIL PROTECTED] list.</p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Propchange:
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/faq.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/site.xml?rev=327656&r1=327655&r2=327656&view=diff
==============================================================================
---
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/site.xml
(original)
+++
forrest/zone/test-sources/apache-projects/src/documentation/content/xdocs/site.xml
Sat Oct 22 05:30:12 2005
@@ -22,16 +22,16 @@
<about label="About" tab="home">
<index label="Index" href="index.html" description="Welcome to Apache
Projects"/>
-
- <projects label="Projects" href="projectDetails/">
- <xi:include href="cocoon://projectDetails/index.siteSnippet.xml"/>
- <xi:include
href="cocoon://projectDetails/language-Java/index.siteSnippet.xml"/>
- </projects>
+ <faq label="FAQ" href="faq.html" description="Frequently Asked Questions"/>
+ <projects label="Projects" href="projectDetails/">
+ <xi:include href="cocoon://projectDetails/index.siteSnippet.xml"/>
+ <xi:include
href="cocoon://projectDetails/language-Java/index.siteSnippet.xml"/>
+ </projects>
</about>
<external-refs>
<forrest href="http://forrest.apache.org/";>
- <linking href="docs/linking.html"/>
+ <projectInfo
href="pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/index.html"/>
</forrest>
</external-refs>
