Legal Notice

{{ book.productnameFull }} {{ book.versionNumber }} Documentation

Contribute

The documentation project is hosted on GitHub at (teiid/teiid-documents).

It is published on GitHub Pages at (teiid.github.io/teiid-documents/master/content) ('master' can be substituted with any maintained branch e.g. '10.3.x').

For simple changes you can just use the online editing capabilities of GitHub by navigating to the appropriate source file and selecting fork/edit.

For larger changes follow these 3 steps:

Step.1 clone the sources

git clone git@github.com:teiid/teiid-documents.git

Step.2 do edit

Use any text editor to edit the adoc files, AsciiDoc Syntax Quick Reference can help you in AsciiDoc Syntax.

Step.3 submit your change

Once the pull request is committed the published content will be updated automatically.

Test locally

You may need test locally, to make sure the changes are correct, to do this install gitbook, then execute the following commands from the checkout location:

$ cd wildfly
$ gitbook install
$ gitbook serve -w

Once above commands execute successfully (may take a few minutes), you should see the "Serving book at …​" message and the http format document can be tested locally via http://localhost:4000/.

Generate html/pdf/epub/mobi

You may locally create rendered forms of the documentation. To do this install gitbook and ebook-convert, then execute the following commands from the checkout location:

$ gitbook build ./ teiid-documents
$ gitbook pdf ./ teiid-documents.pdf
$ gitbook epub ./ teiid-documents.epub
$ gitbook mobi ./ teiid-documents.mobi

Once above commands executes successfully, the teiid-documents folder, teiid-documents.pdf, teiid-documents.epub, and teiid-documents.mobi will be generated.

CI Build

The .travis.yaml file allows for continuous integration of doc changes on multiple branches to be published to a single gh-pages branch. When you setup the travis build job you must create the gh-pages branch if it does not already exist:

git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m "initializing gh-pages"
git push origin gh-pages

You will need to add an appropriate user and git api key with repo access as the environment properties GITHUB_USER and GITHUB_API_KEY respectively in the travis build settings.