From fb77ee044cb27e9aa787d1cff680c45799312132 Mon Sep 17 00:00:00 2001 From: rbuisson Date: Wed, 27 Mar 2024 18:36:07 +0100 Subject: [PATCH] OZ-468: Remove the deprecated readmes --- .../resources/archetype-resources/README.md | 2 +- .../archetype-resources/readme/impl-guide.md | 60 ------------------- .../projects/it-basic/reference/README.md | 5 +- .../it-basic/reference/readme/impl-guide.md | 55 ----------------- 4 files changed, 5 insertions(+), 117 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 22399b2..4dcfee2 100644 --- a/maven-archetype/src/main/resources/archetype-resources/README.md +++ b/maven-archetype/src/main/resources/archetype-resources/README.md @@ -3,7 +3,7 @@ **${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). +Please refer to the online Ozone documentation for instructions how to run the project: https://docs.ozone-his.com/create-distro/#available-commands ## Release Notes 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 a5362a1..0000000 --- a/maven-archetype/src/main/resources/archetype-resources/readme/impl-guide.md +++ /dev/null @@ -1,60 +0,0 @@ -# ${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-demo.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-demo.sh -``` - -#### Option 2. Replace only the files needed, directly in the mounted Docker volume -```bash -rsync -av configs/ target/${artifactId}-/distro/configs -``` -(replace `` with the current version of ${distributionName}) - -### 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 f9f9bfb..061d056 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 @@ -2,6 +2,9 @@ **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). +## Implementer Guide +Please refer to the online Ozone documentation for instructions how to run the project: https://docs.ozone-his.com/create-distro/#available-commands +## Release Notes +### 1.0.0-SNAPSHOT (in progress) 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 ace6a5d..0000000 --- a/maven-archetype/src/test/resources/projects/it-basic/reference/readme/impl-guide.md +++ /dev/null @@ -1,55 +0,0 @@ -# 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-demo.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-demo.sh -``` - -```bash -rsync -av configs/ target/ozone-basic-/distro/configs -``` -(replace `` with the current version of basicDistribution) - - -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 - ... - -```