Skip to content

Commit

Permalink
[feature] copy city-ehr setup
Browse files Browse the repository at this point in the history
  • Loading branch information
marmoure committed Nov 20, 2024
0 parents commit 3e438cf
Show file tree
Hide file tree
Showing 232 changed files with 11,340 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: CI
on: [push, pull_request]
jobs:
build:
name: Build and Test
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
jdk: [11]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Java
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.jdk }}
distribution: 'liberica'
- name: Build
run: mvn -B clean package
51 changes: 51 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: pages
on:
push:
branches: ["main", "develop"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
generate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Java
uses: actions/setup-java@v4
with:
java-version: 11
distribution: 'liberica'
- name: Generate website (XSLT)
id: generate
# Override Maven properties for the Petal button url
run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Pquick-start-guide-website
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload pages artifact
id: deployment
uses: actions/upload-pages-artifact@v3
with:
path: cityehr-quick-start-guide/target/website/
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: generate
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.idea/
target/
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# cityEHR Documentation
[![Build Status](https://github.com/cityehr/cityehr-documentation/actions/workflows/ci.yml/badge.svg)](https://github.com/cityehr/cityehr-documentation/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-CC%20BY%20NC%20SA%204.0-blue.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

This respository contains the documentation for cityEHR. The documentation is authored in [LwDITA](https://dita-lang.org/lwdita/capabilities/capabilities) XDITA format.

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.


## Documents

| Title | Source Location | Renderings |
|---|---|---|
| Quick Start Guide | [cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular](cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular) | [HTML](https://cityehr.github.io/cityehr-documentation/) / [PDF](https://cityehr.github.io/cityehr-documentation/quickstart-guide.pdf) |


## Developing the Documentation

If you wish to build the documentation on your own computer, you will need the following tools installed:

* [Git](https://git-scm.com/)
* [Java JDK](https://bell-sw.com/pages/downloads/) version 8 (or newer)
* [Apache Maven](https://maven.apache.org/) 3.6 (or newer)

1. If you have not already done so, clone the respoistory:
```bash
$ git clone https://github.com/cityehr/cityehr-documentation.git
```

2. Enter the clone folder:
```bash
$ cd cityehr-documentation
```

3. Run the following command to have Maven (mvn) render a new PDF and HTML version of the documentation:
```bash
$ mvn clean package -Pquick-start-guide-website
```

You can find the rendered versions of the documentation in the `target/` sub-folder of each module. For example:
* `cityehr-quick-start-guide/target/quickstart-guide.pdf`
* `cityehr-quick-start-guide/target/website/index.html`
104 changes: 104 additions & 0 deletions cityehr-documentation-parent/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.seveninformatics.cityehr.documentation</groupId>
<artifactId>cityehr-documentation-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<name>cityEHR Documentation Parent POM</name>
<description>Parent POM for cityEHR documentation projects</description>
<url>https://seveninformatics.com/cityehr/</url>
<inceptionYear>2024</inceptionYear>

<organization>
<name>Seven Informatics</name>
<url>https://seveninformatics.com</url>
</organization>

<licenses>
<license>
<name>GNU Lesser General Public License, version 2.1</name>
<url>https://opensource.org/licenses/LGPL-2.1</url>
<distribution>repo</distribution>
<comments>For XSLT and Maven Code</comments>
</license>
<license>
<name>Creative Commons Attribution NonCommercial ShareAlike 4.0</name>
<url>https://creativecommons.org/licenses/by-nc-sa/4.0/</url>
<distribution>repo</distribution>
<comments>For Documentation Content</comments>
</license>
</licenses>

<developers>
<developer>
<name>John Chelsom</name>
<organization>Seven Informatics</organization>
<organizationUrl>https://www.seveninformatics.com</organizationUrl>
<email>[email protected]</email>
</developer>
</developers>

<contributors>
<contributor>
<name>Stephanie Cabrera</name>
</contributor>
<contributor>
<name>Catriona Hopper</name>
</contributor>
<contributor>
<name>Jennifer Ramirez</name>
</contributor>
<contributor>
<name>Adam Retter</name>
<organization>Evolved Binary</organization>
<organizationUrl>https://www.evolvedbinary.com</organizationUrl>
<email>[email protected]</email>
</contributor>
</contributors>

<scm>
<connection>scm:git:https://github.com/cityehr/cityehr-documentation.git</connection>
<developerConnection>scm:git:https://github.com/cityehr/cityehr-documentation.git</developerConnection>
<url>scm:git:https://github.com/cityehr/cityehr-documentation.git</url>
</scm>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<saxon.version>12.5</saxon.version>
</properties>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.3.1</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<version>1.1.0</version>
<configuration>
<transformerFactory>net.sf.saxon.TransformerFactoryImpl</transformerFactory>
</configuration>
<dependencies>
<dependency>
<groupId>net.sf.saxon</groupId>
<artifactId>Saxon-HE</artifactId>
<version>${saxon.version}</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.4.1</version>
</plugin>
</plugins>
</pluginManagement>
</build>

</project>
Loading

0 comments on commit 3e438cf

Please sign in to comment.