Excerpt |
---|
Contains information about how to add and modify Trafodion documentation that is part of the Trafodion source tree. This documentation is written in asciidoc. |
...
Table of Contents | ||||
---|---|---|---|---|
|
...
Source
Documents do not include version information as part of the file name.
...
- Be sure to source env.sh, so that the TRAFODION_VER environment variable is defined.
- Build everything using
mvn clean post-site
in the top-level directory.- As above, to skip over JDBC dependency, use
mvn -P'!jdbc' post-site
. - If run into outofmemory Java exception, try "export MAVEN_OPTS="-Xmx2048m -Xms1024m -XX:MaxPermSize=512m"
- As above, to skip over JDBC dependency, use
- Verify the contents in the generated
docs/target
directory.- All documents are in
docs/target/docs
directory.
- All documents are in
...
The external version of the Trafodion Document Tree is published to http://trafodion.incubator.apache.org/docs. Please refer to Publish below.
...
Version Directory | Content | Web Site Directory |
---|---|---|
latest | Known place for the latest version of a document. | trafodion.incubator.apache.org/docs/<document-name> |
<version> | Release-specific version of a document. | trafodion.incubator.apache.org/docs/<version>/<document-directory> |
...
Info |
---|
Publication is done when a committer is ready to update the external web site. You do not perform these steps as part of checking in changes. Publishing steps are documented in the "Merge Changes" section. |
Refer to Website Publishing for how the website and documents get published.