You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by an...@apache.org on 2015/08/22 23:36:51 UTC
svn commit: r1697134 -
/incubator/tamaya/site/trunk/content/documentation.mdtext
Author: anatole
Date: Sat Aug 22 21:36:50 2015
New Revision: 1697134
URL: http://svn.apache.org/r1697134
Log:
Compacting.
Modified:
incubator/tamaya/site/trunk/content/documentation.mdtext
Modified: incubator/tamaya/site/trunk/content/documentation.mdtext
URL: http://svn.apache.org/viewvc/incubator/tamaya/site/trunk/content/documentation.mdtext?rev=1697134&r1=1697133&r2=1697134&view=diff
==============================================================================
--- incubator/tamaya/site/trunk/content/documentation.mdtext (original)
+++ incubator/tamaya/site/trunk/content/documentation.mdtext Sat Aug 22 21:36:50 2015
@@ -37,17 +37,14 @@ Other interesting links, especially rela
# Enhancing Documentation
## Documentation Sources
-
The documentation is managed as part of the [Tamaya Source](source.html)
## Documentation Format
-
The format used for Tamaya 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:
@@ -58,12 +55,10 @@ If you cloned the source repository and
The generate documentation will be available at `REPO_ROOT/docs/target/site`
## Contribute
-
If you would like to submit a documentation patch through Jira, you can have a look at the
[suggested approach](suggested-git-workflows.html).
## Publish procedure (for committers only)
-
If you're a committer and want to publish the documentation at [Tamaya Site](http://tamaya.incubator.apache.org/documentation/)
you have do the following steps: