Toolkit SPLDoc process
The following steps can be followed to generate new SPLDocs for the toolkit and to add it to the github pages.
NOTE: It is recommended that a new repository be cloned in /tmp
to isolate SPL doc generation and
github pages documentation from development work.
cd /tmp
git clone git@github.com:IBMStreams/streamsx.kafka.git streamsx.kafka.gh-pages
cd streamsx.kafka.gh-pages
- Check out the release, for which you want to generate the SPL documentation, for example
git checkout v1.2.4
./gradlew spldoc
git checkout gh-pages
pushd doc
- The SPL documentation for the latest release, which is also available via the SPLDOC button on the entry page, is stored in subdirectory
spldoc
. Documentation of older releases are stored in versioned sub directories, for examplev1.2.3
. If you update existing documentation, replace the generated documentation in the right directory.- If you update latest SPLDOC:
git rm -r ./spldoc && mv -v ../docs/spldoc .
- If you update an older SPLDOC (here v1.2.3):
git rm -r v1.2.3/spldoc && mv -v ../docs/spldoc v1.2.3
- If you add SPLDOC of a new version, (here latest version used to be v1.2.4):
- move current latest doc into versioned directory:
mkdir v1.2.4 && git mv ./spldoc v1.2.4
- add generated doc as latest doc:
mv -v ../docs/spldoc .
- move current latest doc into versioned directory:
- If you update latest SPLDOC:
popd
- remove the generated
docs
directory:rm -rf docs
- Add untracked documentation to the index
- If you added new documentation, update the
_docs/210-user_spldoc.md
markdown file, which references all SPL docs. git commit -m "Update docs for vX.Y.Z
git push -u origin gh-pages
- When the result is ok for you, delete the temporary clone that you created in the second step