jefft 2003/08/07 07:18:10
Added: src/documentation/content/xdocs updating_docs.xml
Log:
A short page to answer the question "how do I update the docs?"
Revision Changes Path
1.1
incubator-site/src/documentation/content/xdocs/updating_docs.xml
Index: updating_docs.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"document-v11.dtd">
<document>
<header>
<title>Updating the documentation</title>
</header>
<body>
<section>
<title>Updating the documentation</title>
<p>The process for submitting new documentation or modifying an
existing page is as follows</p>
<section>
<title>Download Forrest</title>
<p>Download <link href="http://xml.apache.org/forrest/";>Apache
Forrest</link>, or obtain it from CVS:</p>
<source>
export CVSROOT=:pserver:[EMAIL PROTECTED]:/home/cvspublic
cvs login
<em>press enter</em>
cvs checkout xml-forrest
cd xml-forrest
./build.sh
export PATH=`pwd`/build/dist/shbat/bin:$PATH
</source>
</section>
<section>
<title>Download incubator-site</title>
<p>Download the <code>incubator-site</code> CVS module.
Continuing from the previous example:</p>
<source>
cd ..
cvs checkout incubator-site
</source>
</section>
<section>
<title>Make your changes</title>
<p>Edit the XML docs in
<code>incubator-site/src/documentation/content/xdocs/</code>. If you are not
familiar
with DTDs, the syntax is best learned <link
href="http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/documentation/content/xdocs/document-v11.xml?rev=HEAD&content-type=text/xml";>by
example</link>. If you add a new page or change a page's name,
update <code>book.xml</code>, from which the
menu is generated. More details can be found <link
href="http://xml.apache.org/forrest/your-project.html";>in
Forrest's documentation</link>.</p>
</section>
<section>
<title>Render the site</title>
<p>In the <code>incubator-site/</code> directory, type 'forrest' to
render the HTML and PDF files in
<code>build/site</code>. Forrest validates the XML, so will catch
any syntax errors.</p>
</section>
<section>
<title>Submit or commit the change</title>
<p>If the site built without errors, you can now make a patch with
the command <code>cvs diff -u >
incubator-site.diff</code> in the <code>incubator-site/</code>
directory, and submit it to the <link
href="index.html#MailingLists">mailing list</link>, with
'<code>[PATCH]</code>' in the email subject.
Incubator committers can just commit the contents of
<code>build/site</code> (after checking it is okay!).</p>
</section>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
