cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ilgro...@apache.org
Subject svn commit: r1410930 - in /cocoon/trunk/site/cocoon-main-site/src/site: site.xml xdoc/1199_1_1.xml xdoc/1256_1_1.xml xdoc/1273_1_1.xml xdoc/1276_1_1.xml xdoc/1418_1_1.xml
Date Sun, 18 Nov 2012 17:12:34 GMT
Author: ilgrosso
Date: Sun Nov 18 17:12:33 2012
New Revision: 1410930

URL: http://svn.apache.org/viewvc?rev=1410930&view=rev
Log:
[COCOON-2329] Completed and updated the information about how to contribute + replaced some
Daisy references with maven-site-plugin

Removed:
    cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1276_1_1.xml
    cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1418_1_1.xml
Modified:
    cocoon/trunk/site/cocoon-main-site/src/site/site.xml
    cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1199_1_1.xml
    cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1256_1_1.xml
    cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1273_1_1.xml

Modified: cocoon/trunk/site/cocoon-main-site/src/site/site.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/site/cocoon-main-site/src/site/site.xml?rev=1410930&r1=1410929&r2=1410930&view=diff
==============================================================================
--- cocoon/trunk/site/cocoon-main-site/src/site/site.xml (original)
+++ cocoon/trunk/site/cocoon-main-site/src/site/site.xml Sun Nov 18 17:12:33 2012
@@ -68,7 +68,6 @@
     <menu name="Getting involved">
       <item href="1273_1_1.html" name="How to contribute?"/>
       <item href="1275_1_1.html" name="Communication tools that we use"/>
-      <item href="1276_1_1.html" name="Other tools that we use"/>
       <item collapse="true" href="1199_1_1.html" name="Committer's and contributor's section">
         <item href="1199_1_1.html" name="Releasing Cocoon"/>
         <item href="798_1_1.html" name="Working with Cocoon from SVN">

Modified: cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1199_1_1.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1199_1_1.xml?rev=1410930&r1=1410929&r2=1410930&view=diff
==============================================================================
--- cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1199_1_1.xml (original)
+++ cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1199_1_1.xml Sun Nov 18 17:12:33 2012
@@ -42,13 +42,8 @@ people.apache.org, configure it at ~/.m2
 &lt;/settings&gt;</pre><div class="note"><div><strong>Note:
</strong>Point to an empty local repository. This ensures that you don't
 introduce dependencies that can only be fullfilled within your local build
 environment or after doing the release which puts all created artifacts into
-your local repository.</div></div><h3>Win32 based systems</h3><div
class="fixme"><div><strong>Fixme: </strong>TBD</div></div><section
name="Daisy" style="background:none;padding:0;"/>It's also a good idea to publish our docs
while preparing a release. The
-reason for this is that when a release is created, the information about
-versions (Javadocs, dependencies overview, etc.) exactly reflects the content of
-the released artifact.<br/>
-For that purpose configure your <tt>settings.xml</tt> as explained in
-<a href="1256_1_1.html">How to build the site locally</a> and give it a dry-run
as
-explained in this document before you do the actual release<h1>Step 2: Releasing POM
artifacts</h1><ol type="1">
+your local repository.</div></div><h3>Win32 based systems</h3><div
class="fixme"><div><strong>Fixme: </strong>TBD</div></div>
+<h1>Step 2: Releasing POM artifacts</h1><ol type="1">
 <li>refer to an already released parent in pom.xml</li>
 <li><tt>mvn -N -Dusername=[svn-user-name] -Dpassword=******** release:prepare
 -Darguments="-N"<br/>

Modified: cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1256_1_1.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1256_1_1.xml?rev=1410930&r1=1410929&r2=1410930&view=diff
==============================================================================
--- cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1256_1_1.xml (original)
+++ cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1256_1_1.xml Sun Nov 18 17:12:33 2012
@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?><!--
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
       Licensed to the Apache Software Foundation (ASF) under one
       or more contributor license agreements.  See the NOTICE file
       distributed with this work for additional information
@@ -15,46 +16,48 @@
       KIND, either express or implied.  See the License for the
       specific language governing permissions and limitations
       under the License.
-    --><document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/XDOC/2.0"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"><properties><title>Cocoon
Main Site - How to build the site locally</title><author email="cocoon-docs@apache.org">Apache
Cocoon Documentation Team</author></properties><body>
-         <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How
to build the site locally</h1><p>This page explains how to build the Cocoon 2.2
documentation site with Maven2
-and the daisy-maven-plugin.</p><p>This plugin assumes that each block has its
own collection and navigation
-document.</p><h1>Configure settings.xml</h1><p>The documents can
only be exported by a user with admin rights to the Daisy
-repository. We have created such a user <tt>daisy-export</tt>. The password for
-this user is available in a <tt>daisy-export-user-<tt>password.txt</tt>
-</tt>file in the home directory of the daisy user. If you want to use your own
-Daisy user, make sure that you have administration rights.</p><p>Open the <tt>~/.m2/setting.xml</tt>
and add the following:</p><pre>&lt;settings&gt;
-
- [...]
-
- &lt;profiles&gt;
-    &lt;profile&gt;
-       &lt;id&gt;localDocs&lt;/id&gt;
-       &lt;properties&gt;
-          &lt;docs.deploymentBaseUrl&gt;file:///cocoon-site&lt;/docs.deploymentBaseUrl&gt;
-       &lt;/properties&gt;
-     &lt;/profile&gt;
- &lt;/profiles&gt;  
-  
- &lt;servers&gt;
-    &lt;server&gt;
-       &lt;id&gt;cocoon-daisy&lt;/id&gt;
-       &lt;username&gt;daisy-export&lt;/username&gt;
-       &lt;password&gt;<strong>SECRET PASSWORD HERE</strong>&lt;/password&gt;
-    &lt;/server&gt;
- &lt;/servers&gt;
-
-&lt;/settings&gt; 
-</pre><h1>Build all modules required for the site generation</h1><pre>cd
trunk
-mvn install -P daisy</pre><h1>Build the site</h1><pre>cd trunk/site
-mvn site -o -P daisy,docs-sites
-</pre><div class="note"><div><strong>Note: </strong>You don't
have to build the complete site for every module every
-time. You can also go to a module, that is configured to provide docs, of your
-choice and build its docs only if this fits your needs.</div></div><h1>Deploy
the site locally</h1><p>Deploy the site using the "localDocs" profile.</p><pre>mvn
site:deploy -o -P daisy,docs-sites,localDocs
-</pre><p>If you want to checkin the local docs build to SVN in order to publish
them,
-make sure that the profile above (localDocs) points to a local directory which
-is a checkout of our docs from SVN
-(<a href="http://svn.apache.org/repos/asf/cocoon/site/site/">http://svn.apache.org/repos/asf/cocoon/site/site/</a>).
-<br/>
-There is a guide with additional information about <a href="1418_1_1.html">how to
-publish our docs</a>.</p></div></div>
-       </body></document>
\ No newline at end of file
+      -->
+<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+	  xmlns="http://maven.apache.org/XDOC/2.0" 
+	  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+
+  <properties>
+    <title>Cocoon Main Site - How to build the site locally</title>
+    <author email="cocoon-docs@apache.org">Apache Cocoon Documentation Team</author>
+    </properties>
+
+    <body>
+      <div id="contentBody">
+	<div id="bodyText">
+
+	  <h1 class="docTitle">How to build the site locally</h1>
+
+	  <p>This page explains how to build the Cocoon documentation site with the <a
href="http://maven.apache.org/plugins/maven-site-plugin/">maven-site-plugin</a>.</p>
+
+	  <h1>Existing site checkout</h1>
+	  <p>The live website is generated from <a href="http://maven.apache.org/doxia/references/xdoc-format.html">XDOC</a>
sources and published via <a href="http://www.apache.org/dev/cms.html#svnpubsub">Svnpubsub</a></p>
+	  <p>You can fetch a copy of the live website with
+	  <pre>svn co https://svn.apache.org/repos/asf/cocoon/site/site $LIVEWEBSITE</pre>
+	  where $LIVEWEBSITE is the directory that will contain the website.</p>
+
+	  <h1>Site sources checkout</h1>
+	  <ul>
+	    <li>For Cocoon 2.2:
+<pre>svn co https://svn.apache.org/repos/asf/cocoon/trunk/site $SITESOURCES22</pre>
+	    where $SITESOURCES22 is the root directory for 2.2 site sources.</li>
+	    <li>For Cocoon 3.0:
+<pre>svn co https://svn.apache.org/repos/asf/cocoon/cocoon3/trunk/parent $SITESOURCES30</pre>
+	    where $SITESOURCES30 is the directory for 3.0 site sources.</li>
+	  </ul>
+
+	  <h1>Building the website</h1>
+	  <ol>
+	    <li>Once you have made some modifications, cd into one of $SITESOURCES22 subdirectories
or into $SITESOURCES30 (depending on what portion of the site you would like to build) and
launch
+<pre>mvn site-deploy -Ddocs.deploymentBaseUrl=file://$LIVEWEBSITE</pre>
+	    </li>
+	    <li>Point your favorite browser to file://$LIVEWEBSITE</li>
+	  </ol>
+	</div>
+      </div>
+    </body>
+</document>

Modified: cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1273_1_1.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1273_1_1.xml?rev=1410930&r1=1410929&r2=1410930&view=diff
==============================================================================
--- cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1273_1_1.xml (original)
+++ cocoon/trunk/site/cocoon-main-site/src/site/xdoc/1273_1_1.xml Sun Nov 18 17:12:33 2012
@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="UTF-8"?><!--
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
       Licensed to the Apache Software Foundation (ASF) under one
       or more contributor license agreements.  See the NOTICE file
       distributed with this work for additional information
@@ -15,47 +16,71 @@
       KIND, either express or implied.  See the License for the
       specific language governing permissions and limitations
       under the License.
-    --><document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/XDOC/2.0"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"><properties><title>Cocoon
Main Site - How to contribute?</title><author email="cocoon-docs@apache.org">Apache
Cocoon Documentation Team</author></properties><body>
-         <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How
to contribute?</h1><h1>Code</h1><p>TBD</p><h1>General
documentation</h1><p>These instructions only work if you have an active account
in our Daisy CMS
-and got the doc editor role assigned. If you haven't, create your account at
-<a href="http://cocoon.zones.apache.org/daisy/registration">http://cocoon.zones.apache.org/daisy/registration</a>
-and ask at dev[_at_]cocoon.apache.org for editing rights.</p><div class="note"><div><strong>Note:
</strong>Doc editors are not allowed to publish a document. This can only
-be done by Apache Cocoon committers.</div></div><section name="Editing a document"
style="background:none;padding:0;"/><p>Simply follow the "Edit" link at the bottom
of a page, login in and select
-<em>Page Actions - Edit</em> from the menu.</p><section name="Adding
a document" style="background:none;padding:0;"/><p>Go to http://cocoon.zones.apache.org/daisy/,
login and select the
-documentation site where you want to add your new document. Select <em>New
-Document</em> from the menu. The recommended document type is <em>Cocoon
-document</em>.<br/>
-If you want to make your new document appear in a navigation menu, click on
-<em>Go to navigation</em> document below the navigation menu and select
-<em>Page Actions - Edit</em>.</p><section name="What happens once I've
added or edited a document?" style="background:none;padding:0;"/><p>The moment you
submit a new or changed document an email is sent to docs at
-cocoon dot apache dot org.  An entry is also added to the list on the Daisy
-<a href="NO_LINK">Cocoon Site Overview</a> page.  A Cocoon committer should
-then see the change, review it and make it live.</p><h1>Sitemap component documentation</h1><p>For
documenting sitemap components, we use a system whereby certain parts of
-the documentation are extracted automatically from the Java sources using a tool
-called sitemaptags2daisy.</p><p>If you are not a committer, make sure that you
have checked out the latest
-version of the Java source file from SVN, make your changes and create a patch
-file. Create a new patch issue in JIRA and add your diff file.</p><section name="Editing
the documentation of a sitemap component" style="background:none;padding:0;"/><p>Only
edit the content of the the Long Description part in Daisy. The short
-description and the value of the fields are automatically assigned from the Java
-sources, so if you change them in Daisy, these changes will get overwritten the
-next time the sitemaptags2daisy tool is run.</p><section name="Adding documentation
for a new sitemap component" style="background:none;padding:0;"/><p>If running the
sitemaptags2daisy tool is not an option (no time, no
-privileges, ...) then create manually a document of type "Sitemap Component". In
-the JavaClass field, enter the fully qualified name of the implementation class.
-Leave the other fields and the Short Description part empty, they will be
-assigned the next time the sitemaptags2daisy tool runs. Enter the documentation
-in the Long Description part.</p><section name="Adding javadoc tags" style="background:none;padding:0;"/><p>The
following special javadoc tags are supported (none of these are strictly
-required by the sitemaptags2daisy tool):</p><ul>
-<li>@cocoon.sitemap.component.name<br/>
-default name with which this component is declared in the sitemap</li>
-<li>@cocoon.sitemap.component.documentation.disabled<br/>
-excludes the component from the documentation</li>
-<li>@cocoon.sitemap.component.documentation<br/>
-A short (one-paragraph) description of the component. Can contain HTML markup
-(preferably only inline tags).</li>
-<li>@cocoon.sitemap.component.documentation.caching<br/>
-A comment about the caching of this component. The cacheability of the component
-is figured out automatially by its implemented interfaces, but this tag allows
-to provide a short comment on the chaching conditions. This is mapped to a field
-in Daisy, thus should not contain HTML markup.</li>
-</ul>Next to these, the @deprecated tag is also synced with the Daisy document.
-<section name="Running the sitemaptags2daisy tool" style="background:none;padding:0;"/>TODO,
see the README.txt in the sources for now.</div></div>
-       </body></document>
\ No newline at end of file
+    -->
+<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+	  xmlns="http://maven.apache.org/XDOC/2.0" 
+	  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+  <properties>
+    <title>Cocoon Main Site - How to contribute?</title>
+    <author email="cocoon-docs@apache.org">Apache Cocoon Documentation Team</author>
+  </properties>
+  <body>
+    <div id="contentBody">
+      <div id="bodyText">
+
+	<h1 class="docTitle">How to contribute?</h1>
+
+	<p>The Apache Cocoon™ project is actively seeking new contributors to work on
all aspects of the project. We need and appreciate all contributions, including documentation
help, source code development and feedback.</p>
+
+	<h2>Code</h2>
+	<ul>
+	  <li>When you have found an issue or you want to propose a new feature, post a message
to Cocoon User's list to discuss it.</li>
+	  <li>Search existing <a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa"
rel="nofollow">issues</a> to see whether someone had already encountered the same
issue.</li>
+	  <li>If this issue is never encountered before, create a JIRA issue for Cocoon <a
href="http://issues.apache.org/jira/browse/COCOON">2.1/2.2</a> or <a href="https://issues.apache.org/jira/browse/COCOON3">3.0</a>.</li>
+	  <li>Develop a test case to demonstrate the issue.</li>
+	  <li>Attach the new test to JIRA issue.</li>
+	  <li>If you have also developed a fix for the raised issue, attach a patch to it.
Here are some useful <a href="https://commons.apache.org/patches.html">guidelines</a>
about how to correctly generate a patch.</li>
+	</ul>
+
+	<h2>Documentation</h2>
+	<p>The website is managed via the <a href="http://maven.apache.org/plugins/maven-site-plugin/">maven-site-plugin</a>,
hence contributing site content is very close to contributing source code: create a new issue
on JIRA and attach there a SVN patch. See <a href="1256_1_1.html">this page</a>
for more information.</p>
+	<p>The project <a href="http://wiki.apache.org/cocoon/">wiki</a> is also
there to gather any other kind of documentation or contribution you would like to contribute,
and does not require any SVN, Maven or other technical skills.</p>
+
+	<h2>Quick references</h2>
+	<ul>
+	  <li>
+	    Discussion occurs on the <a href="mail-lists.html">Cocoon mailing lists</a>
+	  </li>
+	  <li>
+	    Information on access to the project source code is available for Cocoon <a href="798_1_1.html">2.2</a>
and <a href="3.0/source-repository.html">3.0</a>.
+	  </li>
+	  <li>
+	    Bugs and other issues can be posted on the Cocoon <a href="https://issues.apache.org/jira/browse/COCOON">2.1/2.2</a>
and <a href="https://issues.apache.org/jira/browse/COCOON3">3.0</a> JIRA
+	  </li>
+	</ul>
+
+	<h1>How do I become a contributor or a committer?</h1>
+	<p>Everyone can contribute to Cocoon as a contributor; contributors who	build up a
history of successful contributions over time are invited to become committers. The difference
is that committers have direct write access to the project SVN repositories, while contributors
post their contributions to JIRA issues where they're first reviewed, and then committed by
a committer to the project's SVN repository. See <a href="http://www.apache.org/dev/contributors.html">http://www.apache.org/dev/contributors.html</a>
for a good overview of working as a contributor.</p>
+	<p>We ask contributors of significant amounts of code to fill out and send into Apache,
an <a href="http://www.apache.org/licenses/#clas">Individual Contributors License Agreement
(ICLA)</a> (and perhaps also a <a href="http://www.apache.org/licenses/#clas">Corporate
Contributors License Agreement (CCLA)</a>).</p>
+	<p>If you're interested in committing to the project, you need to establish a history
over time of successful contributions to the project. After that, you can be invited to become
a committer.</p>
+	<ul>
+	  <li>
+	    You'll need to fill out some legal paperwork and go through a process to get an apache
committer account: See <a class="external" rel="nofollow" href="http://apache.org/dev/new-committers-guide.html">
New Committers Guide</a>, <a class="external" rel="nofollow" href="http://apache.org/dev/contributors.html">
Contributors</a>, and <a class="external" rel="nofollow" href="http://apache.org/dev/committers.html">
Committers</a> for more details.
+	  </li>
+	  <li>
+	    After you've received an email from <a href="mailto:root@apache.org">root@apache.org</a>
with your committer account information, change your initial password at <a href="https://id.apache.org">Apache
Account Utility</a>. For more details see <a class="external" rel="nofollow" href="http://apache.org/dev/version-control.html">Committer
Subversion Access</a>.
+	  </li>
+	  <li>
+	    Check out the Cocoon sources and test your svn account: <a href="http://svn.apache.org/viewcvs.cgi/cocoon">Subversion
Repository</a>.
+	  </li>
+	</ul>
+	<p>All Contributors and Committers should</p>
+	<ul>
+	  <li>Sign up for a <a class="external" rel="nofollow" href="http://wiki.apache.org/cocoon/FrontPage?action=newaccount">WiKi</a>
account.</li>
+	  <li>Sign up for an <a class="external" rel="nofollow" href="http://issues.apache.org/jira/">ASF
JIRA</a> account.</li>
+	</ul>
+
+      </div>
+    </div>
+  </body>
+</document>



Mime
View raw message