From 948e67e61453776cb570b0477b7de83f7a588792 Mon Sep 17 00:00:00 2001 From: rbuisson Date: Tue, 30 Apr 2024 18:30:15 +0200 Subject: [PATCH] HSC-252: Maven archetype: Provide a more user-friendly README --- .../resources/archetype-resources/README.md | 24 ++++++-- .../archetype-resources/readme/impl-guide.md | 60 ------------------- .../projects/it-basic/reference/README.md | 21 ++++++- .../it-basic/reference/readme/impl-guide.md | 55 ----------------- 4 files changed, 36 insertions(+), 124 deletions(-) delete mode 100644 maven-archetype/src/main/resources/archetype-resources/readme/impl-guide.md delete mode 100644 maven-archetype/src/test/resources/projects/it-basic/reference/readme/impl-guide.md diff --git a/maven-archetype/src/main/resources/archetype-resources/README.md b/maven-archetype/src/main/resources/archetype-resources/README.md index 01dbed6..613c03b 100644 --- a/maven-archetype/src/main/resources/archetype-resources/README.md +++ b/maven-archetype/src/main/resources/archetype-resources/README.md @@ -1,10 +1,22 @@ -# Ozone ${distributionName} +# ${distributionName} -**Ozone ${distributionName}** is a distribution of [Ozone HIS](https://www.ozone-his.com). +**${distributionName}** is a distribution of [Ozone HIS](https://www.ozone-his.com). -## Implementer Guide -A technical guide to help implementers building and running the project can be found [here](readme/impl-guide.md). +Available comamnds to build and run the project: +https://docs.ozone-his.com/create-distro/#available-commands -## Release Notes +--- -### ${version} (in progress) +

+ Ozone +

+ +

Health Information System

+ +

+
Engage with the Ozone community and access useful resources below: +

+ +

+ Docs    •    Forum    •    Chat Room +

\ No newline at end of file diff --git a/maven-archetype/src/main/resources/archetype-resources/readme/impl-guide.md b/maven-archetype/src/main/resources/archetype-resources/readme/impl-guide.md deleted file mode 100644 index be909d9..0000000 --- a/maven-archetype/src/main/resources/archetype-resources/readme/impl-guide.md +++ /dev/null @@ -1,60 +0,0 @@ -# Ozone ${distributionName} - Implementer Guide - -This distribution can be run using the [Ozone Docker Compose](https://github.com/ozone-his/ozone-docker-compose) project, which is the default configuration for this. The quick start command below is for demonstration and trial purposes and would not be suitable for a stable environment. - -## Quick Start - -Build -```bash -./scripts/mvnw clean package -``` - -Run -```bash -source target/go-to-scripts-dir.sh -./start-ozone.sh -``` - -### Working on configurations: - -If needed to work on the distro configurations and see the results, you have several options: -- (1) Turn down the whole project with its volumes, build again and run. -- (2) Replace files in the mounted Docker volume (all files or only individual files) - -#### Option 1. Turn down the whole project and start afresh -```bash -source target/go-to-scripts-dir.sh -./destroy-demo.sh -``` - -Re-build: -```bash -./scripts/mvnw clean package -``` - -Then start afresh: -```bash -source target/go-to-scripts-dir.sh -./start.sh -``` - -#### Option 2. Replace only the files needed, directly in the mounted Docker volume -```bash -rsync -av configs/ target/ozone-${distributionName}-/distro/configs -``` -(replace `` with the current version of ozone-kenya) - -### Excluding inherited files from Ozone Distro: - -It is possible to exclude some of the files inherited from the parent Ozone Distro transitive dependencies (thus the OpenMRS Distro Reference Application). -This can be achieved by providing your exclusion path in the main pom.xml, using the Maven Resource plugin `excludes`: - -Eg.: -```xml -${project.build.directory}/ozone - - distro/**/appointment* - distro/**/concepts*demo.csv - ... - -``` diff --git a/maven-archetype/src/test/resources/projects/it-basic/reference/README.md b/maven-archetype/src/test/resources/projects/it-basic/reference/README.md index b551e52..b6caaea 100644 --- a/maven-archetype/src/test/resources/projects/it-basic/reference/README.md +++ b/maven-archetype/src/test/resources/projects/it-basic/reference/README.md @@ -1,7 +1,22 @@ -# Ozone basicDistribution +# basicDistribution -**Ozone basicDistribution** is a distribution of [Ozone HIS](https://www.ozone-his.com). +**basicDistribution** is a distribution of [Ozone HIS](https://www.ozone-his.com). -A technical guide to help implementers building and running the project can be found [here](readme/impl-guide.md). +Available comamnds to build and run the project: +https://docs.ozone-his.com/create-distro/#available-commands +--- +

+ Ozone +

+ +

Health Information System

+ +

+
Engage with the Ozone community and access useful resources below: +

+ +

+ Docs    •    Forum    •    Chat Room +

\ No newline at end of file diff --git a/maven-archetype/src/test/resources/projects/it-basic/reference/readme/impl-guide.md b/maven-archetype/src/test/resources/projects/it-basic/reference/readme/impl-guide.md deleted file mode 100644 index 3defa31..0000000 --- a/maven-archetype/src/test/resources/projects/it-basic/reference/readme/impl-guide.md +++ /dev/null @@ -1,55 +0,0 @@ -# Ozone basicDistribution - Implementer Guide - -This distribution can be run using the [Ozone Docker Compose](https://github.com/ozone-his/ozone-docker-compose) project, which is the default configuration for this. The quick start command below is for demonstration and trial purposes and would not be suitable for a stable environment. - - -Build -```bash -./scripts/mvnw clean package -``` - -Run -```bash -source target/go-to-scripts-dir.sh -./start-ozone.sh -``` - - -If needed to work on the distro configurations and see the results, you have several options: -- (1) Turn down the whole project with its volumes, build again and run. -- (2) Replace files in the mounted Docker volume (all files or only individual files) - -```bash -source target/go-to-scripts-dir.sh -./destroy-demo.sh -``` - -Re-build: -```bash -./scripts/mvnw clean package -``` - -Then start afresh: -```bash -source target/go-to-scripts-dir.sh -./start.sh -``` - -```bash -rsync -av configs/ target/ozone-basicDistribution-/distro/configs -``` -(replace `` with the current version of ozone-kenya) - - -It is possible to exclude some of the files inherited from the parent Ozone Distro transitive dependencies (thus the OpenMRS Distro Reference Application). -This can be achieved by providing your exclusion path in the main pom.xml, using the Maven Resource plugin `excludes`: - -Eg.: -```xml -${project.build.directory}/ozone - - distro/**/appointment* - distro/**/concepts*demo.csv - ... - -```