Toolkit SPLDoc process

Edit me

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.

  1. cd /tmp
  2. git clone git@github.com:IBMStreams/streamsx.mqtt.git streamsx.mqtt.gh-pages
  3. cd streamsx.mqtt.gh-pages
  4. Check out the release, for which you want to generate the SPL documentation, for example git checkout v1.0.1
  5. ant spldoc
  6. The documentation for the toolkit is generated in the com.ibm.streamsx.mqtt/doc directory
  7. git checkout gh-pages
  8. pushd doc
  9. 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 example v1.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 ../com.ibm.streamsx.mqtt/doc/spldoc .
    • If you update an older SPLDOC (here v1.0.0): git rm -r v1.0.0/spldoc && mv -v ../com.ibm.streamsx.mqtt/doc/spldoc v1.0.0
    • If you add SPLDOC of a new version, (here latest version used to be v1.0.0):
      • move current latest doc into versioned directory: mkdir v1.0.0 && git mv ./spldoc v1.0.0
      • add generated doc as latest doc: mv -v ../com.ibm.streamsx.mqtt/doc/spldoc .
  10. popd
  11. remove the generated docs directory: rm -rfv com.ibm.streamsx.mqtt/doc
  12. Add untracked documentation to the index
  13. If you added new documentation, update the _docs/210-user_spldoc.md markdown file, which references all SPL docs.
  14. git commit -m "Update docs for vX.Y.Z
  15. git push -u origin gh-pages
  16. When the result is ok for you, delete the temporary clone that you created in the second step

Updated: