Documentation for all parts of the onCourse student management system
This is the source code for the documentation which can be found here:
- https://www.ish.com.au/onCourse/doc/manual/
- https://www.ish.com.au/onCourse/doc/web/
- https://www.ish.com.au/onCourse/doc/design/
- https://www.ish.com.au/onCourse/doc/dsl/
- https://www.ish.com.au/onCourse/doc/release-notes/
The documenation is built using gradle, so all you need to have installed on your machine is Java 11 or higher. Then run:
./gradlew asciidoctor
You can also build individual documentation projects with something like
./gradlew design:asciidoctor
We recommend Intellij with the Asciidoc plugin installed to work on this documentation.
This work is licensed under a Creative Commons Attribution 4.0 International License.
The DSL documentation also has a dependency on some swagger API files which are not available under an open source license yet. We are working on making that available.