From 9ab0e0a6a024540a9a2e73de15165c1c6612d287 Mon Sep 17 00:00:00 2001 From: Ryan Crichton Date: Mon, 8 Jul 2024 07:10:19 +0000 Subject: [PATCH] GITBOOK-55: change request with no subject merged in GitBook --- documentation/SUMMARY.md | 21 ++++++++++--------- documentation/guides/README.md | 6 ++++++ .../{ => guides}/development/README.md | 2 +- .../development/config-importing.md | 0 .../disaster-recovery-process/README.md | 0 .../elasticsearch.md | 0 .../hapi-fhir-data.md | 0 .../disaster-recovery-process/openhim-data.md | 0 .../provisioning-up-remote-servers/README.md | 0 .../provisioning-up-remote-servers/ansible.md | 0 .../terraform.md | 0 .../{ => guides}/resource-allocations.md | 2 +- 12 files changed, 19 insertions(+), 12 deletions(-) create mode 100644 documentation/guides/README.md rename documentation/{ => guides}/development/README.md (88%) rename documentation/{ => guides}/development/config-importing.md (100%) rename documentation/{ => guides}/disaster-recovery-process/README.md (100%) rename documentation/{ => guides}/disaster-recovery-process/elasticsearch.md (100%) rename documentation/{ => guides}/disaster-recovery-process/hapi-fhir-data.md (100%) rename documentation/{ => guides}/disaster-recovery-process/openhim-data.md (100%) rename documentation/{ => guides}/provisioning-up-remote-servers/README.md (100%) rename documentation/{ => guides}/provisioning-up-remote-servers/ansible.md (100%) rename documentation/{ => guides}/provisioning-up-remote-servers/terraform.md (100%) rename documentation/{ => guides}/resource-allocations.md (96%) diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md index 1c4fbf46..3411eb3a 100644 --- a/documentation/SUMMARY.md +++ b/documentation/SUMMARY.md @@ -53,15 +53,16 @@ * [Local Development](packages/reverse-proxy-nginx/local-development.md) * [Environment Variables](packages/reverse-proxy-nginx/environment-variables.md) * [🗒️ Cheat sheet](cheat-sheet.md) -* [Provisioning remote servers](provisioning-up-remote-servers/README.md) - * [Ansible](provisioning-up-remote-servers/ansible.md) - * [Terraform](provisioning-up-remote-servers/terraform.md) * [Architecture](architecture.md) -* [Resource Allocations](resource-allocations.md) -* [Development](development/README.md) - * [Config Importing](development/config-importing.md) -* [Disaster Recovery Process](disaster-recovery-process/README.md) - * [Elasticsearch](disaster-recovery-process/elasticsearch.md) - * [HAPI FHIR Data](disaster-recovery-process/hapi-fhir-data.md) - * [OpenHIM Data](disaster-recovery-process/openhim-data.md) +* [Guides](guides/README.md) + * [Provisioning remote servers](guides/provisioning-up-remote-servers/README.md) + * [Ansible](guides/provisioning-up-remote-servers/ansible.md) + * [Terraform](guides/provisioning-up-remote-servers/terraform.md) + * [Resource Allocations](guides/resource-allocations.md) + * [Disaster Recovery Process](guides/disaster-recovery-process/README.md) + * [Elasticsearch](guides/disaster-recovery-process/elasticsearch.md) + * [HAPI FHIR Data](guides/disaster-recovery-process/hapi-fhir-data.md) + * [OpenHIM Data](guides/disaster-recovery-process/openhim-data.md) + * [Development](guides/development/README.md) + * [Config Importing](guides/development/config-importing.md) * [Community](community.md) diff --git a/documentation/guides/README.md b/documentation/guides/README.md new file mode 100644 index 00000000..75091e6a --- /dev/null +++ b/documentation/guides/README.md @@ -0,0 +1,6 @@ +--- +description: Various notes and guide +--- + +# Guides + diff --git a/documentation/development/README.md b/documentation/guides/development/README.md similarity index 88% rename from documentation/development/README.md rename to documentation/guides/development/README.md index 76945818..344000d9 100644 --- a/documentation/development/README.md +++ b/documentation/guides/development/README.md @@ -2,7 +2,7 @@ ## Adding Packages -* The Go Cli runs all services from the `jembi/platform` docker image. When adding new packages or updating existing packages to Platform you will need to build/update your local `jembi/platform` image. [How to build the image](<../README (1).md>). +* The Go Cli runs all services from the `jembi/platform` docker image. When adding new packages or updating existing packages to Platform you will need to build/update your local `jembi/platform` image. [How to build the image](<../../README (1).md>). * As you add new packages to the platform remember to list them in the `config.yml` file - otherwise the added package will not be detected by the [platform-cli tool](https://app.gitbook.com/o/lTiMw1wKTVQEjepxV4ou/s/TwrbQZir3ZdvejunAFia/). ## diff --git a/documentation/development/config-importing.md b/documentation/guides/development/config-importing.md similarity index 100% rename from documentation/development/config-importing.md rename to documentation/guides/development/config-importing.md diff --git a/documentation/disaster-recovery-process/README.md b/documentation/guides/disaster-recovery-process/README.md similarity index 100% rename from documentation/disaster-recovery-process/README.md rename to documentation/guides/disaster-recovery-process/README.md diff --git a/documentation/disaster-recovery-process/elasticsearch.md b/documentation/guides/disaster-recovery-process/elasticsearch.md similarity index 100% rename from documentation/disaster-recovery-process/elasticsearch.md rename to documentation/guides/disaster-recovery-process/elasticsearch.md diff --git a/documentation/disaster-recovery-process/hapi-fhir-data.md b/documentation/guides/disaster-recovery-process/hapi-fhir-data.md similarity index 100% rename from documentation/disaster-recovery-process/hapi-fhir-data.md rename to documentation/guides/disaster-recovery-process/hapi-fhir-data.md diff --git a/documentation/disaster-recovery-process/openhim-data.md b/documentation/guides/disaster-recovery-process/openhim-data.md similarity index 100% rename from documentation/disaster-recovery-process/openhim-data.md rename to documentation/guides/disaster-recovery-process/openhim-data.md diff --git a/documentation/provisioning-up-remote-servers/README.md b/documentation/guides/provisioning-up-remote-servers/README.md similarity index 100% rename from documentation/provisioning-up-remote-servers/README.md rename to documentation/guides/provisioning-up-remote-servers/README.md diff --git a/documentation/provisioning-up-remote-servers/ansible.md b/documentation/guides/provisioning-up-remote-servers/ansible.md similarity index 100% rename from documentation/provisioning-up-remote-servers/ansible.md rename to documentation/guides/provisioning-up-remote-servers/ansible.md diff --git a/documentation/provisioning-up-remote-servers/terraform.md b/documentation/guides/provisioning-up-remote-servers/terraform.md similarity index 100% rename from documentation/provisioning-up-remote-servers/terraform.md rename to documentation/guides/provisioning-up-remote-servers/terraform.md diff --git a/documentation/resource-allocations.md b/documentation/guides/resource-allocations.md similarity index 96% rename from documentation/resource-allocations.md rename to documentation/guides/resource-allocations.md index f4ce75e3..afcf85c1 100644 --- a/documentation/resource-allocations.md +++ b/documentation/guides/resource-allocations.md @@ -20,7 +20,7 @@ As a default, each package contained in Platform is allocated a maximum of 3 GB ## Allocating Resources per Package -The resource allocation can be set on a per-package basis, as specified by the relevant environment variables found in the relevant [Packages section](packages/). +The resource allocation can be set on a per-package basis, as specified by the relevant environment variables found in the relevant [Packages section](../packages/). ## Notes