This repository contains the documentation for cityEHR. The documentation is authored in LwDITA XDITA format.
If you just want to read the docs click here.
When the source code of a document is updated in GitHub, we use GitHub Actions to automatically render a new HTML and PDF version of the documentation.
| Title | Source Location | Renderings |
|---|---|---|
| Quick Start Guide | cityehr-quick-start-guide/src/main/lwdita/quick-start-guide | HTML / PDF |
| Modelling Guide | cityehr-modelling-guide/src/main/lwdita/modelling-guide | HTML / PDF |
If you wish to build the documentation on your own computer, you will need the following tools installed:
- Git
- Java JDK version 8 (or newer)
- Apache Maven 3.6 (or newer)
- If you have not already done so, clone the respoistory:
$ git clone https://github.com/cityehr/cityehr-documentation.git- Enter the clone folder:
$ cd cityehr-documentation- Run the following command to have Maven (mvn) render a new PDF and HTML version of the documentation:
$ mvn clean package -Dcityehr-documentation-website=trueYou can find the rendered versions of the documentation in the target/ sub-folder of each module. For example:
cityehr-documentation-website/target/website/index.htmlcityehr-quick-start-guide/target/quick-start-guide.pdfcityehr-quick-start-guide/target/website/index.htmlcityehr-modelling-guide/target/modelling-guide.pdfcityehr-modelling-guide/target/website/index.html