GITBOOK-51: change request with no subject merged in GitBook

documentation/README (1).md

@@ -4,33 +4,52 @@ description: What you need to start using OpenHIM Platform.
 
 # Getting Started
 
-## Software Requirements
+## Prerequisites
 
-The following tools are needed to run/deploy platform:
-
-* [Docker](https://docs.docker.com/engine/install/)
+Before getting started with OpenHIM Platform you will need to have Instant OpenHIE tool installed and functional. [Please follow this guide here](https://app.gitbook.com/s/TwrbQZir3ZdvejunAFia/getting-started/quick-start).
 
 {% hint style="info" %}
-* If you're a _**Windows**_** user**, you must use WSL2 to be able to run the platform.
-* You should limit the amount of RAM/CPU that will be used by WSL, for more details please check the following link: [Limiting memory usage in WSL2](https://www.aleksandrhovhannisyan.com/blog/limiting-memory-usage-in-wsl-2/).
+* If you're a _**Windows**_** user and are** using WSL2 to be able to run the platform: you should limit the amount of RAM/CPU that will be used by WSL, for more details please check the following link: [Limiting memory usage in WSL2](https://www.aleksandrhovhannisyan.com/blog/limiting-memory-usage-in-wsl-2/).
 {% endhint %}
 
 ## Quick Start
 
-1. Once Docker is installed initialise Docker Swarm: `docker swarm init`
-2. Download the [Instant OpenHIE 2 binary](https://jembi.gitbook.io/instant-v2/getting-started). Once you are able to execute the instant executable, return here.
-3. Go to the OpenHIM Platform [https://github.com/jembi/platform/releases/latest](https://github.com/jembi/platform/releases/latest) page and use the `<tag_name>` for the following steps.
-4. Download the latest OpenHIM Platform config file which configures Instant OpenHIE v2 to use OpenHIM Platform packages: `wget https://raw.githubusercontent.com/jembi/platform/<tag_name>/config.yaml`&#x20;
+Ensure Docker Swarm in initialised:&#x20;
 
-{% hint style="info" %}
-&#x20;e.g. `wget https://raw.githubusercontent.com/jembi/platform/2.5.0/config.yaml`
-{% endhint %}
+```bash
+docker swarm init
+```
+
+Download the latest OpenHIM Platform config file which configures Instant OpenHIE v2 to use OpenHIM Platform packages:
+
+```bash
+wget -qO config.yaml https://github.com/jembi/platform/releases/latest/download/config.yaml
+```
+
+Download the latest environment variable file, which sets configuration options for OpenHIM Platform packages:
 
-5. Download the latest environment variable file, which sets configuration options for OpenHIM Platform packages: `wget https://raw.githubusercontent.com/jembi/platform/<tag_name>/.env.local`
-6. Launch some OpenHIM Platform packages, e.g. `./instant package init --name interoperability-layer-openhim --name message-bus-kafka --env-file .env.local --dev` This launches the OpenHIM and Kafka packages in dev mode (which exposes service ports for development purposes) using the config supplied in the env var file.
+```bash
+wget -qO .env.local https://github.com/jembi/platform/releases/latest/download/.env.local
+```
+
+Launch some OpenHIM Platform packages, e.g.&#x20;
+
+```bash
+instant package init --name interoperability-layer-openhim --name message-bus-kafka --env-file .env.local --dev
+```
+
+This launches the OpenHIM and Kafka packages in dev mode (which exposes service ports for development purposes) using the config supplied in the env var file.
+
+To destroy the setup packages and delete their data run:&#x20;
+
+```bash
+instant package destroy --name interoperability-layer-openhim --name message-bus-kafka --env-file .env.local --dev
+```
 
 Next, you might want to browse the [recipes](recipes/) available in OpenHIM Platform. Each recipe bundles a set of packages and configuration to setup an HIE for a particular purpose.
 
 Alternatively you can also browse the individual set of [packages](packages/) that OpenHIM Platform offers. Each package's documentation lists the environment variables used to configure them.
 
 For more information on how to start stop and destroy packages using the command line, see the [Instant OpenHIE 2 CLI docs](https://jembi.gitbook.io/instant-v2/cli).
+
+Please [join us on Discord](https://discord.gg/R4XwXyZbwk) for support or to chat about new features or ideas.

documentation/packages/README.md

@@ -7,3 +7,4 @@ description: >-
 
 # 📦 Packages
 
+Package can be stood up individually using the `instant package init -n <package_name>` command, or they can be included in your own recipes. This can be accomplished by [creating a profile](https://app.gitbook.com/s/TwrbQZir3ZdvejunAFia/getting-started/config#launching-a-profile) that includes the necessary packages and any custom configuration packages.

documentation/recipes/README.md

@@ -1,4 +1,3 @@
-
 ---
 description: Pre-defined recipes for common use cases
 ---
@@ -7,6 +6,8 @@ description: Pre-defined recipes for common use cases
 
 OpenHIM platform comes bundled with a set of generic packages that can be deployed and configured to support a number of different use cases. To help users of OpenHIM Platform get started with something they can make use of immediately, a number of default OpenHIM Platform recipes are provided. These help you get started with everything you need setup and configured for a particular use case.
 
+These recipes combine and configure multiple packages together so that a functional HIE is stood up that is pre-configured to support a particular use case.
+
 We currently support the following default recipes:
 
 <table data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Central Data Repository with Data Warehouse</strong></td><td>A FHIR-based Shared Health record linked to an MPI for linking and matching patient demographics and a default reporting pipeline to transform and visualise FHIR data.</td><td></td><td><a href="central-data-repository-with-data-warehousing.md">central-data-repository-with-data-warehousing.md</a></td></tr><tr><td align="center"><strong>Central Data Repository</strong></td><td>A FHIR-based Shared Health record linked to an MPI for linking and matching patient demographics. No reporting is include but all FHIR data is pushed to Kafka for external system to use.</td><td></td><td><a href="central-data-repository-no-reporting.md">central-data-repository-no-reporting.md</a></td></tr><tr><td align="center"><strong>Master Patient Index</strong></td><td>A master patient index setup using JeMPI. it also includes OpenHIM as the API gateway providing security, a mapping mediator to allow FHIR-based communication with JeMPI and Keycloak to support user management.</td><td></td><td><a href="master-patient-index.md">master-patient-index.md</a></td></tr></tbody></table>