THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
| 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.
Source Location
| Document | Source Format | Source Tree | Output Format |
|---|---|---|---|
| Client Installation Guide | asciidoc | docs/client_install/ | Web Book, PDF |
| Command Interface Guide | asciidoc | docs/command_interface/ | Web Book, PDF |
| Contributor Guide | asciidoc | docs/contributor_guide/ | Web Book, PDF |
| DCS Reference Guide | asciidoc | dcs/src/main/asciidoc/ | Web Book |
| DCS APIs | javadoc | dcs/src/main/java/ | Web Book |
| odb User Guide | asciidoc | docs/odb/ | Web Book, PDF |
| Messages Guide | asciidoc | docs/messages_guide/ | Web Book, PDF |
| REST Reference Guide | asciidoc | core/rest/src/main/asciidoc/ | Web Book |
| REST APIs | javadoc | core/rest/src/main/java/ | Web Book |
| SQL Reference Manual | asciidoc | /docs/sql_reference/ | Web Book, PDF |
Source Tree Organization
DCS and REST
To be written.
All Other
All other documents share a common web-book style sheet definition, which is located in docs/css/trafodion-manuals.css.
The source tree for each manual is organized as follows:
...
Anchor modifying-documentation-making-changes modifying-documentation-making-changes
Making Changes
Please refer to the following web sites for guidance for information about working on asciidoc-based documentation.
...
Once you’ve made the desired changes, then do the following:
DCS and REST
...
Building an Individual Document
- Be sure to source env.sh, so that the TRAFODION_VER environment variable is defined.
- Build the document using
mvn clean site
...
- in the directory containing the document; for example:
dcs
...
- or docs/odb_user.
- If you have not previously built the JDBC drivers, the DCS and REST documents will give spurious errors about missing that dependency. The documents can be built fine, skipping over that dependency using
mvn -P'!jdbc' site.
- If you have not previously built the JDBC drivers, the DCS and REST documents will give spurious errors about missing that dependency. The documents can be built fine, skipping over that dependency using
Verify the content in the generated
targetdirectory.The
target/index.htmlfile provides the entry point for the web book
...
.
For those that have API documentation, the
target/apidocs/index.htmlfile
...
is the entry point
...
.
- For those that have PDF, the
target/index.pdffile contains the PDF version of the document.
Building the Entire Website, including Documents
- Be sure to source env.sh, so that the TRAFODION_VER environment variable is defined.
- Build everything using
mvn clean post-sitein 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/targetdirectory.- All documents are in
docs/target/docsdirectory.
- All documents are in
Other Documentation
- Build the document using
mvn clean siteagainst the directory containing the document; for example:docs/client_installordocs/odb_user. Verify the content in the generated
targetdirectory. Thetarget/index.pdffile contains the PDF version of the document whiletarget/site/index.htmlcontains the web-book version of the document.
...
| Anchor | ||||
|---|---|---|---|---|
|
Build Trafodion Document Tree
The external version of the Trafodion Document Tree is published to http://trafodion.incubator.apache.org/docs. Please refer to Publish below.
The build version of the Trafodion Document Tree is located in docs/target/docs, which is created when you build the Trafodion web site in Maven.
Version Directories
The Trafodion Document Tree consists of Version Directories:
| 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> |
...
latest: Provides a well-known place for each document. This practice makes it possible to link to a document in instructional text, web sites, and other documents.<version>: Provides per-release versions of documents. Previous versions are kept in the web site’s SVN repository ensuring that N versions of the documentation are available.
Document Directories
Each document is placed in its own Document Directory:
...
The Document Directories are copied under the Version Directories thereby creating the web-accessible Trafodion document tree.
Populate Trafodion Document Tree
The build version of the Trafodion Document Tree is populated as follows:
...
Run maven post-site build step.
...
Run maven post-site build step.
...
.
...
Run maven post-site build step.
...
Run maven post-site build step.
...
- Create Version Directories, if needed.
- Create Document Directories, if needed.
- Copy
$SQ_HOME/core/rest/target/site/to the appropriate Document Directories.
...
Run maven post-site build step.
Anchor modify-documentation-publish modify-documentation-publish
Publish
| 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. |
Do the following:
- Build the web site.
- Build the different document as described in Making Changes above.
- Build the Trafodion Document Tree as described in Build Trafodion Document Tree above.
Publishing steps are documented in the "Merge Changes" section. |
The resulting docs/target/docs/ directory is checked into the web-site SVN branch.