GitHub user gtapper opened a pull request:
https://github.com/apache/incubator-trafodion/pull/262
Trafodion 1699
Ported the following documentation to use asciidoc thereby being part of
the Trafodion source tree: Client Installation Guide, Command Interface Guide,
odb User Guide, and SQL Reference Guide. Also began the creation of a new
Installation Guide, which is not activated yet.
Each document is part of the docs subdirectory under the docs directory.
Builds are done using maven under each document's subdirectory:
* *clean suite* builds the web book and the PDF version.
* *post-site* copies the generated files under the correct directories
under docs/target, which is assumed to exist; that is, the *clean site* step
under the master pom.xml should be run before building the documents.
Documents are now located under docs/target/docs under:
1. The document's directory, which is based on the source directory. This
directory contains the latest version of the document.
2. Under <version number>/<document directory>, which contains the release
version copy of the document.
All this is explained in the document.html file on the website.
This change means that the DCS and REST documents need to be copied to
their respective places. Please refer to documentation.md, which shows where
the documents should be placed on the target website and in which directory.
Previous .pdf versions on the website can be removed. Previous document
subdirectories can be remove, too. This last statement is specific for this
release only. In future releases, the latest versions will be overwritten and
new version directories will be created and populated with the SPECIFIC
assumption that the previous versioned directories are kept in place.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/gtapper/incubator-trafodion TRAFODION-1699
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-trafodion/pull/262.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #262
----
commit 859a7e4ca54b2f667e56d1fb79e91d976f2315e0
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-02T02:49:28Z
Rechecking of asciidoc conversion due to weird Windows10 upgrade.
commit 964e27f0115c8a148c01247a5a184ed8b9e7dc81
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-02T15:04:18Z
More commands documented.
commit d99ffe0a8eab850190ebc2a2a36b9016aef94d0c
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-05T05:24:11Z
Completed the SQL Statements chapter.
commit 1cca99a57121517e4787ed2a83ef8b8b1fc52e8a
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-05T07:00:50Z
Documented SQL Utilities.
commit 3bce4129af560faae6ec8482ac4681a3d8d29fee
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-07T08:21:00Z
Added SQL Language Elements chapter.
commit fca75ed3df0f001caf148bc7f5d6f5190233b55a
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-08T07:16:10Z
Addded SQL Clauses and SQL Functions and Expression.
commit 9bcd0e2b9cbb954bddb67ffe839d2a7280b5b54f
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-09T08:32:18Z
Completed functions and expressions.
commit d16c4a1a798811ded8d3cabcc16719b8fafda400
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-10T23:02:06Z
Completd the port of the SQL Reference Manual.
commit 8681b49819031d3c1f4da6cf9b93de88de5fa1ff
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-11T04:50:09Z
Updated to use standard theme.
commit 17b39a0a3ee8b0a6e8523180f13b54364eb40879
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-11T20:28:17Z
Updated the Command Interface Guide to use the standard PDF template.
commit 36c62720a3f2f4fdc561a1344f63d0a1db76ce4a
Author: Gunnar Tapper <[email protected]>
Date: 2016-01-12T05:30:48Z
Finished port to asciidoc for documentation and created the new document
directory.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
