nicolaken 2003/10/19 15:07:20 Added: site howtoparticipate.cwiki Removed: site howtopartecipate.cwiki Log: partecipate -> participate Thanks to Dion Gillard. Revision Changes Path 1.1 incubator/site/howtoparticipate.cwiki Index: howtoparticipate.cwiki =================================================================== !!!How to Participate __TODO__: Need to add all Incubator project resources here !!Mailing lists As with everything else in Apache, most of what goes on happens or is discussed on electronic mailing lists. Here are the lists associated with this project, and their purposes: [EMAIL PROTECTED] This is where general and public discussion of things about the project take place. It's also where follow-up messages sent in reply to cvs commit reports get sent (see the next list). There is a 'digest' form of this list, which collects individual messages and sends the collection when enough have accumulated or a given amount of time has passed since the last digest. Anyone may subscribe; only subscribers may post. *To subscribe, send a message to [EMAIL PROTECTED] *To subscribe to the digest, send a message to [EMAIL PROTECTED] *To unsubscribe, send a message to [EMAIL PROTECTED] [EMAIL PROTECTED] When changes are made to the code repository, the details are automatically sent to this list. Its Reply-To is set to the 'general' list, so if you reply to a cvs message that's where your reply is going to end up. Anyone may subscribe; only subscribers may post. *To subscribe, send a message to [EMAIL PROTECTED] *To unsubscribe, send a message to [EMAIL PROTECTED] [EMAIL PROTECTED] This is the list to which you should be subscribed if you want to be kept apprised of significant events or milestones in the project's activities, but don't want to track the full traffic in the 'general' list. Anyone may subscribe; all posts are moderated. *To subscribe, send a message to [EMAIL PROTECTED] *To unsubscribe, send a message to [EMAIL PROTECTED] [EMAIL PROTECTED] *This is a private list for the project management committee. It is not open to general subscription. !!Updating the site The process for submitting new documentation or modifying an existing page is as follows. !Download Forrest Download [Apache Forrest!http://xml.apache.org/forrest/], or obtain it from CVS: {{{ export CVSROOT=:pserver:[EMAIL PROTECTED]:/home/cvspublic cvs login (press enter) cvs checkout xml-forrest cd xml-forrest ./build.sh export PATH=`pwd`/build/dist/shbat/bin:$PATH}}} !Download incubator-site Download the {{incubator-site}} CVS module. Continuing from the previous example: {{{ cd .. cvs checkout incubator-site}}} !Make your changes 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 [by example|href="http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/documentation/content/xdocs/document-v11.xml?rev=HEAD&content-type=text/xml]. From the Forrest site, [here is quite a complete example of the xml format|http://xml.apache.org/forrest/document-v12.html], and [here of the wiki format|http://xml.apache.org/forrest/wiki-sample.html]. If you add a new page or change a page's name, update {{site.xml}}, from which the menu is generated. More details can be found [in Forrest's documentation|http://xml.apache.org/forrest/your-project.html]. !Render the site 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. !Submit or commit the change 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 mailing list, 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!).
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
