Skip to content

Commit

Permalink
Fix bad links (#1546)
Browse files Browse the repository at this point in the history
* chore: Fix broken links on CHT Sync pages

* Fix bad links

* Fix links

* Update content/en/building/guides/data/analytics/couch2pg-to-cht-sync-migration.md

Co-authored-by: Andra Blaj <[email protected]>

* Update content/en/building/guides/data/analytics/couch2pg-to-cht-sync-migration.md

Co-authored-by: Andra Blaj <[email protected]>

---------

Co-authored-by: Andra Blaj <[email protected]>
  • Loading branch information
esthermmoturi and andrablaj authored Sep 20, 2024
1 parent cca81ee commit 7ab6b93
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ This page outlines guidelines for migrating from [couch2pg](https://github.com/m
## Key Considerations
- **Server resources**: To minimize downtime, running both couch2pg and CHT Sync in parallel during the migration process is recommended. With this in mind, ensure that the server and database resources are sufficient to handle the load.
- **dbt Modelling**: Avoid the temptation to model new dbt models after existing SQL views and tables. Instead, take the opportunity to re-evaluate the data needs and design new models that are more efficient and effective. Think of what data needs to be shown and how it should be shown in data visualization tools and use that to guide the design of the new models.
- **Testing**: After migrating, thoroughly test the new dbt models to ensure that they work as expected. Refer to the [testing dbt models guide](({{< relref "building/guides/data/analytics/building-dbt-models" >}})) for more information on testing.
- **Feedback**: Provide any feedback and create issues for errors or bugs encountered in the [CHT Sync](https://github.com/medic/cht-sync) and [CHT Pipeline](https://github.com/medic/cht-pipeline/) repositories to improve the tools.
- **Testing**: After migrating, thoroughly test the new dbt models to ensure that they work as expected. Refer to the [testing dbt models guide]({{< relref "building/guides/data/analytics/building-dbt-models" >}}) for more information on testing.
- **Feedback**: Provide any feedback and create issues for errors or bugs encountered in the [cht-sync](https://github.com/medic/cht-sync) and [cht-pipeline](https://github.com/medic/cht-pipeline/) repositories to improve the tools.

## Migration Steps
1. **Plan the migration**: Determine the scope of the migration, including the data sources, the data models, and the data transformations. Identify the existing SQL views, tables, and dashboards and assess what data you want to visualize.
1. **Set up CHT Sync**: Follow the instructions [to setup CHT Sync locally](({{< relref "building/guides/data/analytics/setup" >}})).
1. **Build dbt models**: Use the [dedicated guidelines](({{< relref "building/guides/data/analytics/building-dbt-models" >}})) to build dbt models for the data you want to visualize.
1. **Deploy CHT Sync**: Once the dbt models are tested locally and working as expected, deploy CHT Sync in production. Follow [the instructions to set up CHT Sync in production](({{< relref "building/guides/data/analytics/production" >}})). It is recommended that CHT Sync be run in parallel with couch2pg during the migration process. This minimises disruption to users of the existing dashboards because they can continue to use the existing data while the new pipeline is being set up. It also makes it easier to compare the data from couch2pg when testing the new pipeline.
1. **Set up CHT Sync**: Follow the instructions [to setup CHT Sync locally]({{< relref "building/guides/data/analytics/setup" >}}).
1. **Build dbt models**: Use the [dedicated guidelines]({{< relref "building/guides/data/analytics/building-dbt-models" >}}) to build dbt models for the data you want to visualize.
1. **Deploy CHT Sync**: Once the dbt models are tested locally and working as expected, deploy CHT Sync in production. Follow [the instructions to set up CHT Sync in production]({{< relref "building/guides/data/analytics/production" >}}). It is recommended that CHT Sync be run in parallel with couch2pg during the migration process. This minimises disruption to users of the existing dashboards because they can continue to use the existing data while the new pipeline is being set up. It also makes it easier to compare the data from couch2pg when testing the new pipeline.
1. **Create replica dashboards**: In the data visualization tool of your choice, create replica dashboards of your current setup and compare the data from the old and new pipelines.
1. **Test and adjust the dbt models**: Test the dbt models to ensure they are working as expected and that the replica and initial dashboards match. Adjust the models to ensure they are accurate.
1. **Optimize**: Once the dbt models are working as expected and the dashboards display the expected data, optimize the models to improve performance. This may involve restructuring the models, adding indexes, or making other adjustments to improve the speed and efficiency of the models. Having a look at the [dbt models guide](({{< relref "building/guides/data/analytics/building-dbt-models" >}})) will help you understand how to optimize the models.
1. **Set up monitoring and alerting**: [Setup CHT Watchdog](({{< relref "hosting/monitoring/setup" >}})) to monitor the running of CHT Sync and CHT Pipeline and set up alerts for any failures.
1. **Optimize**: Once the dbt models are working as expected and the dashboards display the expected data, optimize the models to improve performance. This may involve restructuring the models, adding indexes, or making other adjustments to improve the speed and efficiency of the models. Having a look at the [dbt models guide]({{< relref "building/guides/data/analytics/building-dbt-models" >}}) will help you understand how to optimize the models.
1. **Set up monitoring and alerting**: [Setup CHT Watchdog]({{< relref "hosting/monitoring/setup" >}}) to monitor the running of CHT Sync and set up alerts for any failures.
1. **Remove couch2pg and the duplicate database**: Once the new pipeline runs as expected, you can remove couch2pg and the duplicate database. Ensure that all data is being synced correctly, that the dbt models are working as expected, and that the dashboards display the expected data before switching them off and removing couch2pg.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Also not - if you only want to test with mobile devices that require a valid TLS
## Overview
When using a local [development environment]({{< relref "contribute/code/core/dev-environment" >}}), you may want to share your work with other collaborators. By using a publicly accessible web server, you can receive the secure https requests and forward them back to your CHT instance which doesn't have https set up:

[<img src="/apps/guides/debugging/images/SSH.tunnel.diagram.svg" width=100% height=100%>](/apps/guides/debugging/images/SSH.tunnel.diagram.svg)
[<img src="/apps/guides/debugging/images/SSH.tunnel.diagram.svg" width=100% height=100%>](/building/guides/debugging/images/SSH.tunnel.diagram.svg)

Once you have this web server set up, you may continue to use it whenever you want by simply reconnecting to it via the secure tunnel.

Expand Down Expand Up @@ -83,7 +83,7 @@ The steps in this guide can be done on any of the cheap server providers out the
From the SSH command in step 10 above:
[<img src="/apps/guides/debugging/images/ssh.ports.svg" width=100% height=100%>](/apps/guides/debugging/images/ssh.ports.svg)
[<img src="/building/guides/debugging/images/ssh.ports.svg" width=100% height=100%>](/building/guides/debugging/images/ssh.ports.svg)
1. `8081` - Remote port on cht.domain.com to listen to. This is the same port that apache redirects to in step 2 above.
1. `127.0.0.1` - Host to send forwarded traffic to. In this case, your local machine.
Expand Down
2 changes: 1 addition & 1 deletion content/en/hosting/3.x/app-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ docker-compose -f docker-compose-developer-3.x-only.yml up

This may take some minutes to fully start depending on the speed of the Internet connection and speed of the bare-metal host. This is because docker needs to download all the storage layers for all the containers and the CHT needs to run the first run set up. After downloads and setup has completed, the CHT should be accessible on [https://localhost](https://localhost).

When connecting to a new dev CHT instance for the first time, an error will be shown, "Your connection is not private" (see [screenshot](/apps/tutorials/local-setup/privacy.error.png)). To get past this, click "Advanced" and then click "Proceed to localhost".
When connecting to a new dev CHT instance for the first time, an error will be shown, "Your connection is not private" (see [screenshot](/building/tutorials/local-setup/privacy.error.png)). To get past this, click "Advanced" and then click "Proceed to localhost".

## Running the Nth CHT instance

Expand Down
2 changes: 1 addition & 1 deletion content/en/hosting/4.x/app-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ cd ~/cht_4_app_developer-dir && docker compose up

This may take some minutes to fully start depending on the speed of the internet connection and speed of the host. This is because docker needs to download all the storage layers for all the containers and the CHT needs to run the first run set up. After downloads and setup has completed, the CHT should be accessible on [https://localhost:8443](https://localhost:8443). You can log in with username `medic` and password `password`.

When connecting to a new dev CHT instance for the first time, an error will be shown, "Your connection is not private" with `NET::ERR_CERT_AUTHORITY_INVALID` (see [screenshot](/apps/tutorials/local-setup/privacy.error.png)). To get past this, click "Advanced" and then click "Proceed to localhost".
When connecting to a new dev CHT instance for the first time, an error will be shown, "Your connection is not private" with `NET::ERR_CERT_AUTHORITY_INVALID` (see [screenshot](/building/tutorials/local-setup/privacy.error.png)). To get past this, click "Advanced" and then click "Proceed to localhost".

## Running the Nth CHT instance

Expand Down

0 comments on commit 7ab6b93

Please sign in to comment.