deltaspike-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rafab...@apache.org
Subject svn commit: r1626073 - in /deltaspike/site/trunk/content: community.mdtext documentation.mdtext
Date Thu, 18 Sep 2014 20:17:56 GMT
Author: rafabene
Date: Thu Sep 18 20:17:55 2014
New Revision: 1626073

URL: http://svn.apache.org/r1626073
Log:
DELTASPIKE-716 - Added DS Documentaiton info page

Added:
    deltaspike/site/trunk/content/documentation.mdtext
Modified:
    deltaspike/site/trunk/content/community.mdtext

Modified: deltaspike/site/trunk/content/community.mdtext
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/community.mdtext?rev=1626073&r1=1626072&r2=1626073&view=diff
==============================================================================
--- deltaspike/site/trunk/content/community.mdtext (original)
+++ deltaspike/site/trunk/content/community.mdtext Thu Sep 18 20:17:55 2014
@@ -38,6 +38,9 @@ You are very welcome to follow our twitt
 Everybody is welcome to get involved with our community. You can find general information
at [http://apache.org/foundation/getinvolved.html](http://apache.org/foundation/getinvolved.html)
and [http://apache.org/foundation/how-it-works.html](http://apache.org/foundation/how-it-works.html).
 The following sections provides some details about the different levels of getting involved.
 
+If you want to contribute with [DeltaSpike Documentation](/documentation/), please read the
[instructions
+about the Documentation](documentation.html) that adresses how to contribute, render and
publish it.
+
 ## Contributors
 
 Before you get a committer you have to contribute to our effort. E.g. you can help users,
participate in discussions on the dev list, submit patches,... . Therefore, it's essential
to file a/n [(I)CLA](http://www.apache.org/licenses/icla.txt) or [CLA](http://www.apache.org/licenses/cla-corporate.txt)
and send it to secretary at apache dot org (or fax it) as early as possible.

Added: deltaspike/site/trunk/content/documentation.mdtext
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation.mdtext?rev=1626073&view=auto
==============================================================================
--- deltaspike/site/trunk/content/documentation.mdtext (added)
+++ deltaspike/site/trunk/content/documentation.mdtext Thu Sep 18 20:17:55 2014
@@ -0,0 +1,60 @@
+Title: Documentation
+
+Notice:    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
+           regarding copyright ownership.  The ASF licenses this file
+           to you 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.
+
+[TOC]
+
+
+***
+
+# Sources
+
+DeltaSpike documentation is available with the [sources](documentation/source.html).
+
+# Format
+
+The format used for DeltaSpike documentation is [ASCIIDOC](http://www.methods.co.nz/asciidoc/)
because it's easily exportable to PDF, HTML, and it's also easy to contribute. It can be used
to export also to epub and also be used to write books
+
+# Rendering documentation as HTML
+
+_Requirenment: Have [Maven](http://maven.apache.org/) installed._
+
+If you cloned the source repository and want to render the documentation as HTML, you just
need to run the following command:
+
+    $ cd REPO_ROOT/documentation
+    $ mvn site
+
+The generate documentation will be available at `REPO_ROOT/documentation/target/site`
+
+# Publish procedure
+
+To publish the documentation at [DeltaSpike Site](http://deltaspike.apache.org/documentation/)
you have do the following steps:
+
+Put the following information in your ~/.m2/settings.xml file
+
+    <server>
+      <id>deltaspike-site</id>
+      <username><YOUR_USERNAME></username>
+      <password><YOUR_PASSWORD></password>
+    </server>
+
+Then run:
+
+    mvn site-deploy
+
+After log in to <https://cms.apache.org/deltaspike/publish> and click on the `Submit`
button.
\ No newline at end of file



Mime
View raw message