Skip to content

Commit

Permalink
Another set of building section migration (#1549)
Browse files Browse the repository at this point in the history
* Another set of building section migration

* Fix broken builds in hugo
  • Loading branch information
esthermmoturi authored Sep 19, 2024
1 parent 1a2d1c0 commit 832c46c
Show file tree
Hide file tree
Showing 23 changed files with 28 additions and 26 deletions.
2 changes: 1 addition & 1 deletion content/en/building/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Concepts"
weight: 2
weight: 3
description: >
Basic concepts that will help you understand how CHT applications are built
aliases:
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/examples/anc.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,6 @@ Both maternal and newborn care workflows are defined to connect form actions and
Here are a few additional resources to help get you started with the maternal and newborn health reference application.

- View the [configuration code for this reference app](https://github.com/medic/cht-core/tree/master/config/default/)
- Install the reference app following these [easy installation instructions]({{< ref "building/tutorials/local-setup" >}})
- Install the reference app following these [easy installation instructions]({{< ref "building/local-setup" >}})
- Modify the maternal and newborn reference application for your project context using [configuration best practices]({{< ref "design/best-practices" >}})
- Understand the basis for measuring the impact of maternal and newborn workflows by reviewing the World Health Organization's [Core Health Indicators](https://www.who.int/data/gho/data/indicators/indicators-index)
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ A CHP uses the assessment form to report a death caused by an adverse drug react
Here are a few additional resources to help get you started with the pharmacovigilance health reference application.

- View the [configuration code for this reference app](https://github.com/medic/cht-accelerator/tree/main/IntelliSOFT/Example%20CHT%20application/cht_pvers)
- Install the reference app following these [easy installation instructions]({{< ref "building/tutorials/local-setup" >}})
- Install the reference app following these [easy installation instructions]({{< ref "building/local-setup" >}})
- Modify the pharmacovigilance reference application for your project context using [configuration best practices]({{< ref "design/best-practices" >}})

The open sharing of digital health apps used by CHWs is a monumental milestone in the digital health space, and for the CHT Community. Reach out on the [forum](https://forum.communityhealthtoolkit.org/) to share how you will leverage these resources, along with your feedback and continued innovations that could benefit the larger community.
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/examples/pih.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ The Human Immunodeficiency Virus (HIV) workflow is designed to guide CHWs in HIV
Here are a few additional resources to help get you started with the integrated health reference application.

- View the [configuration code for this reference app](https://github.com/medic/cht-pih-malawi-app)
- Install the reference app following these [easy installation instructions]({{< ref "building/tutorials/local-setup" >}})
- Install the reference app following these [easy installation instructions]({{< ref "building/local-setup" >}})
- Modify the maternal and newborn reference application for your project context using [configuration best practices]({{< ref "design/best-practices" >}})

The open sharing of digital health apps used by CHWs is a monumental milestone in the digital health space, and for the CHT Community. Reach out on the [forum](https://forum.communityhealthtoolkit.org/) to share how you will leverage these resources, along with your feedback and continued innovations that could benefit the larger community.
2 changes: 1 addition & 1 deletion content/en/building/features/admin/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 12
description: >
An interface for non-technical administrative users to manage users and settings
relatedContent: >
building/concepts/prerequisites
building/prerequisites
aliases:
- /apps/features/admin/
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: "Getting started building a CHT app"
linkTitle: Getting started
weight: 1
weight: 2
description: >
Setting up a local environment to build and test CHT 4.x applications
relatedContent: >
contribute/code/core/using-windows
hosting/3.x/self-hosting
hosting/3.x/ec2-setup-guide
aliases:
- /building/tutorials/local-setup
- /apps/tutorials/local-setup
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
---
title: "Prerequisites for App Development"
linkTitle: "Prerequisites"
weight: 9
weight: 1
description: >
Tools and background skills that are helpful for developing CHT apps
relatedContent: >
building/tutorials/local-setup
building/local-setup
aliases:
- /building/concepts/prerequisites
- /apps/concepts/prerequisites
---
There are no set prerequisites for users of CHT apps, yet the following are helpful for developing CHT applications.

## Test Instance
To build your own application using the Core Framework you will need an instance set up for testing. You can set up a local instance by [following these instructions]({{< ref "building/tutorials/local-setup" >}}).
To build your own application using the Core Framework you will need an instance set up for testing. You can set up a local instance by [following these instructions]({{< ref "building/local-setup" >}}).

## Build tool
The build tool for applications using the Core Framework is `cht-conf`. To set it up, follow the [installation instructions](https://github.com/medic/cht-conf/blob/master/README.md). To properly use the tool you will need your application files in set locations within a folder. Once you are set up with the basic file structure you can edit the files, and rebuild the application by compiling or converting components as needed, and uploading them to your test instance.
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/app-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You will be building assessment workflow that allows Community Health Workers to

## Required Resources

You should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}) and a [project folder set up]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) already.
You should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}) and a [project folder set up]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) already.

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/application-graphics.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You will cover site branding, partner logos, header tab icons, and app icons (us

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}) and completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup.
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}) and completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup.

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/application-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The settings which control CHT apps are defined in the *[app_settings.json]({{<

## Required Resources

You should have a functioning CHT instance and have cht-conf installed locally. {{< see-also page="building/tutorials/local-setup" title="How to set up a CHT local configuration environment" >}}
You should have a functioning CHT instance and have cht-conf installed locally. {{< see-also page="building/local-setup" title="How to set up a CHT local configuration environment" >}}

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/application-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Using `cht-conf-test-harness`, you can write tests and run them with [Mocha](htt
## Preparation

Writing tests for CHT apps requires a good understanding of the project workflows and requirements. To test using the harness, there are a few things you need to set up:
1. From the previous tutorials, you should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}) and a [project folder set up]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}).
1. From the previous tutorials, you should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}) and a [project folder set up]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}).
`cht-conf` which is short for CHT app configurer, is a command-line interface tool used to manage and configure your CHT apps. It is used for backup, conversion, validation, uploading and other actions which can be found by running `cht --help`.
2. Ensure your `package.json` file has the required libraries. A `package.json` file is used to record important metadata about a project and defines functional attributes that npm uses to install dependencies and run scripts. This file should be at the root of your project folder.
If your `package.json` file does not already have them, add `cht-conf-test-harness`, `chai`, and `mocha` by running this in your command-line:
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/condition-cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Condition cards have several configurable elements including:

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}), completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}), completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/contact-and-users-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In this tutorial you will learn how to create and edit contacts and their associ

## Required Resources

You should have a functioning CHT instance with contact forms configured. Read [How to set up a CHT local configuration environment]({{% ref "building/tutorials/local-setup" %}})
You should have a functioning CHT instance with contact forms configured. Read [How to set up a CHT local configuration environment]({{% ref "building/local-setup" %}})

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/contact-and-users-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See more [key concepts]({{% ref "building/tutorials/contact-and-users-1#brief-ov

## Required Resources

You should have a functioning CHT instance and have cht-conf installed locally. Read [How to set up a CHT local configuration environment]({{% ref "building/tutorials/local-setup" %}})
You should have a functioning CHT instance and have cht-conf installed locally. Read [How to set up a CHT local configuration environment]({{% ref "building/local-setup" %}})

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/contact-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The *properties* for each object determine how and when the field is shown.

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}), and completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup.
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}), and completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup.

## Implementation Steps

Expand Down
4 changes: 2 additions & 2 deletions content/en/building/tutorials/couch2pg-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 2
description: >
Setting up a Couch2pg service to download data from CouchDB to Postgres Database
relatedContent: >
building/tutorials/local-setup
building/local-setup
aliases:
- /apps/tutorials/couch2pg-setup
---
Expand Down Expand Up @@ -46,7 +46,7 @@ Before you begin, you need to have some useful software and tools that are requi
* [PostgreSQL](https://www.postgresql.org/) 9.4 or later

## Prerequisites
You should have a functioning [CHT instance installed locally]({{< ref "building/tutorials/local-setup" >}})
You should have a functioning [CHT instance installed locally]({{< ref "building/local-setup" >}})

You should have a working database with a user that has full creation rights on the database. A database `POSTGRES_DB_NAME` and `couch2pg` user can be created and access granted using the following query:
```
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/form-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You will be adding meta-data and context to an assessment workflow that allows C

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}), completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}), completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/localizing-cht.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ By the end of the tutorial you should be able to:

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}), completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [messages-sw.properties]({{< ref "../reference/translations" >}}) file.
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}), completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [messages-sw.properties]({{< ref "../reference/translations" >}}) file.

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/sms-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ SMS forms are defined in either the `base_settings.json` or the `app_settings/fo

## Required Resources

You should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}).
You should have a [functioning CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}).

You also need to have some [prior knowledge on `app_settings.json`]({{% ref "building/tutorials/application-settings" %}}).

Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You will be adding target widgets that will allow Community Health Workers (CHWs

## Required Resources

You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/tutorials/local-setup" >}}), completed a [project folder]({{< ref "building/tutorials/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).
You should have a functioning [CHT instance with `cht-conf` installed locally]({{< ref "building/local-setup" >}}), completed a [project folder]({{< ref "building/local-setup#3-create-and-upload-a-blank-project" >}}) setup, and an [assessment form]({{< ref "building/tutorials/app-forms" >}}).

## Implementation Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/hosting/3.x/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >
---

{{% pageinfo %}}
To get an overview on how these hosting solutions use `docker` and `docker-compose`, as well as other key CHT concepts, be sure to read the [guide on a Local Setup]({{< relref "building/tutorials/local-setup" >}}). Note that while this is for CHT 4.x, the concepts apply to 3.x.
To get an overview on how these hosting solutions use `docker` and `docker-compose`, as well as other key CHT concepts, be sure to read the [guide on a Local Setup]({{< relref "building/local-setup" >}}). Note that while this is for CHT 4.x, the concepts apply to 3.x.
{{% /pageinfo %}}

Before beginning any of these guides, be sure to meet all of the [CHT hosting requirements]({{< relref "hosting/requirements" >}}) first.
Expand Down
2 changes: 1 addition & 1 deletion content/en/hosting/3.x/ssl-cert-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ relatedContent: >


## Requirements
- Installed CHT-Core 3.x via either [Self Hosted]({{< relref "hosting/3.x/self-hosting" >}}), [EC2]({{< relref "hosting/3.x/ec2-setup-guide" >}}) or [Local Setup]({{< relref "building/tutorials/local-setup" >}}), but must use `docker-compose`.
- Installed CHT-Core 3.x via either [Self Hosted]({{< relref "hosting/3.x/self-hosting" >}}), [EC2]({{< relref "hosting/3.x/ec2-setup-guide" >}}) or [Local Setup]({{< relref "building/local-setup" >}}), but must use `docker-compose`.
- Your own SSL certifications like Let's Encrypt.

## Copy certs into medic-os container
Expand Down
2 changes: 1 addition & 1 deletion content/en/hosting/4.x/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ relatedContent: >
building/guides/updates/preparing-for-4/
---

{{% alert title="Note" %}} To get an overview on how these hosting solutions use `docker` and `docker-compose`, as well as other key CHT concepts, be sure to read the [guide on a Local Setup]({{< relref "building/tutorials/local-setup" >}}). {{% /alert %}}
{{% alert title="Note" %}} To get an overview on how these hosting solutions use `docker` and `docker-compose`, as well as other key CHT concepts, be sure to read the [guide on a Local Setup]({{< relref "building/local-setup" >}}). {{% /alert %}}

Before beginning any of these guides, be sure to meet all of the [CHT hosting requirements]({{< relref "hosting/requirements" >}}) first.

Expand Down

0 comments on commit 832c46c

Please sign in to comment.