teiid
Teiid Documentation

Updated 2 days ago

Contribute to Teiid Documentation

The pages themselves have commenting enabled. You should be able to click on any text area to add a comment.

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

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 [email protected]: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 you finished this steps, the content of documents will 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:

$ gitbook install
$ gitbook serve -w

Once above commands executes successfully, the http format document can be test 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.