SPLDoc Process

Jump to bottom Edit New page

James Cancilla edited this page Aug 1, 2017 · 4 revisions

The following steps can be followed to generate new SPLDocs for the toolkit.

NOTE: It is recommended that a new repository be cloned in /tmp to isolate doc generation from development work.

cd /tmp
git clone [email protected]:IBMStreams/streamsx.kafka.git
cd streamsx.kafka
./gradlew spldoc
git checkout gh-pages
mkdir docs/vX.Y.Z
cp -r docs/spldoc docs/vX.Y.Z -> i.e. v1.1.0
git add docs/vX.Y.Z -> Do not add docs/spldoc to the index
git commit -m "Update docs for vX.Y.Z
git push -u origin