From 72aa42dbf8283dc34a92745dd3f9ff06190b95e9 Mon Sep 17 00:00:00 2001 From: Stefano Apostolico Date: Tue, 24 Sep 2024 18:11:56 +0200 Subject: [PATCH 1/5] updates docs --- docs/components/.pages | 8 ++++---- docs/components/aurora.md | 9 --------- docs/components/index.md | 29 +++++++++++++++-------------- docs/glossary/terms/process.md | 2 +- 4 files changed, 20 insertions(+), 28 deletions(-) delete mode 100644 docs/components/aurora.md diff --git a/docs/components/.pages b/docs/components/.pages index 97d0ada..7869613 100644 --- a/docs/components/.pages +++ b/docs/components/.pages @@ -1,9 +1,9 @@ nav: - index.md -# - hope.md + + - Aurora: aurora + - kobo.md - hde.md + - Country Report: reporting - Payment Gateway: pg - - Aurora: aurora -# - kobo.md -# - reporting/index.md # - workspace.md diff --git a/docs/components/aurora.md b/docs/components/aurora.md deleted file mode 100644 index 784fd44..0000000 --- a/docs/components/aurora.md +++ /dev/null @@ -1,9 +0,0 @@ -# Aurora - - -Aurora is an open source project to collect and register data. It is focused mainly on performance and security. - - - - -## Install diff --git a/docs/components/index.md b/docs/components/index.md index 675770d..06c5096 100644 --- a/docs/components/index.md +++ b/docs/components/index.md @@ -9,26 +9,27 @@ and extend the platform according to their unique needs. It’s built to be scalable, adaptable, and interoperable, making it simple to integrate with other systems and platforms, ensuring smooth workflows and easy expansion as your needs grow. -[//]: # () -[//]: # (- Aurora ) -[//]: # (- Kobo ) +- [Aurora](aurora/index.md) -[//]: # (- DeduplicationEngine ) +- [Kobo](kobo.md) -[//]: # (- Country Report ) +- [DeduplicationEngine](hde.md) -[//]: # (- Payment Gateway ) +- [Country Report](reporting/index.md) -[//]: # (- Country Workspace _(not yet released)_) +- [Payment Gateway](pg/index.md) -[//]: # (- User Management Module _(not yet released)_) +- Country Workspace _(not yet released)_ -[//]: # () -[//]: # (## Hope supporting libraries) +- User Management Module _(not yet released)_ -[//]: # () -[//]: # (These are some of the libraries developed to support HOPE that are released under the OpenSource License) -[//]: # () -[//]: # (- Flex Fields ) +## Hope supporting libraries + + +These are some of the libraries developed to support HOPE that are released under the OpenSource License + + +- Flex Fields +- Django SmartEnv diff --git a/docs/glossary/terms/process.md b/docs/glossary/terms/process.md index f342f05..0d67e46 100644 --- a/docs/glossary/terms/process.md +++ b/docs/glossary/terms/process.md @@ -15,7 +15,7 @@ Act of recording of unique households and individuals by data collection. The registration data can be shared by other organizations that have done this activity. -It can happen on-line using [Aurora](../../components/aurora.md) or offline using [Kobo](../../components/kobo.md) or importing XLSX files. +It can happen on-line using [Aurora](../../components/aurora/index.md) or offline using [Kobo](../../components/kobo.md) or importing XLSX files. ## Targeting From 831021f9ceda95cc3627af07f887a0634ac6de6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartosz=20Wo=C5=BAniak?= <17177420+wozniakpl@users.noreply.github.com> Date: Tue, 24 Sep 2024 18:03:19 +0200 Subject: [PATCH 2/5] point to charts readme --- docs/guide-adm/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/guide-adm/index.md b/docs/guide-adm/index.md index e3948cd..ec863e3 100644 --- a/docs/guide-adm/index.md +++ b/docs/guide-adm/index.md @@ -19,5 +19,6 @@ We require at least Docker 19.03.6 and Compose 2.19.0. ## Helm Chart -HOPE teaml also maintain Kubernetes Heln charts that are available in a -[dedicate Repository](https://github.com/unicef/hope-core-chart). +The system can be deployed on a k8s cluster. It has been tested on AKS. + +Please refer to the README in [https://github.com/unicef/hope-helm-charts](https://github.com/unicef/hope-helm-charts) for more information about deploying HOPE on Kubernetes with Helm. From f23a15705e656f785bf2e093feac9b3fc503b1f6 Mon Sep 17 00:00:00 2001 From: Stefano Apostolico Date: Wed, 25 Sep 2024 17:25:52 +0200 Subject: [PATCH 3/5] updates --- docs/components/aurora/.pages | 4 ++++ docs/components/aurora/setup.md | 2 +- docs/components/aurora/usage.md | 24 ++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/components/aurora/.pages create mode 100644 docs/components/aurora/usage.md diff --git a/docs/components/aurora/.pages b/docs/components/aurora/.pages new file mode 100644 index 0000000..f596b17 --- /dev/null +++ b/docs/components/aurora/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - Contributing: setup + - Usage: usage.md diff --git a/docs/components/aurora/setup.md b/docs/components/aurora/setup.md index 0cdc3e3..3e31300 100644 --- a/docs/components/aurora/setup.md +++ b/docs/components/aurora/setup.md @@ -1,4 +1,4 @@ -# Development Setup +# Contributing Prerequisites: diff --git a/docs/components/aurora/usage.md b/docs/components/aurora/usage.md new file mode 100644 index 0000000..f92c781 --- /dev/null +++ b/docs/components/aurora/usage.md @@ -0,0 +1,24 @@ +# Run + +To start working with Aurora you can: + + +### Build and use your docker + +After you have cloned the repo, be sure to have a Reddis and PostgreSQL server running on your machine + + export ADMIN_EMAIL=admin@example.com + export ADMIN_PASSWORD=password + export DATABASE_URL=postgres://postgres:@127.0.0.1:5432/aurora + export CACHE_URL=redis://127.0.0.1:6379/1?client_class=django_redis.client.DefaultClient + + cd docker + + make build run + + +### Use provided compose.yml + + docker compose up + +navigate to http://localhost:8000/admin/ and login using `admin@example.com/password` From 921269e6bcd42c5548f0772deec8917260809f42 Mon Sep 17 00:00:00 2001 From: Domenico DiNicola Date: Thu, 26 Sep 2024 08:56:39 +0200 Subject: [PATCH 4/5] updates --- docs/_scripts/get_settings.py | 2 +- docs/components/pg/index.md | 2 +- docs/glossary/terms/{program.md => programme.md} | 4 ++-- docs/guide-user/.pages | 2 +- .../_screenshots/{program => programme}/1.png | Bin .../_screenshots/{program => programme}/2.png | Bin .../_screenshots/{program => programme}/3.png | Bin .../_screenshots/{program => programme}/4.png | Bin .../_screenshots/{program => programme}/5.png | Bin docs/guide-user/index.md | 2 +- docs/guide-user/{program.md => programme.md} | 10 +++++----- docs/index.md | 4 ++-- docs/links.md | 10 +++++----- 13 files changed, 18 insertions(+), 18 deletions(-) rename docs/glossary/terms/{program.md => programme.md} (98%) rename docs/guide-user/_screenshots/{program => programme}/1.png (100%) rename docs/guide-user/_screenshots/{program => programme}/2.png (100%) rename docs/guide-user/_screenshots/{program => programme}/3.png (100%) rename docs/guide-user/_screenshots/{program => programme}/4.png (100%) rename docs/guide-user/_screenshots/{program => programme}/5.png (100%) rename docs/guide-user/{program.md => programme.md} (93%) diff --git a/docs/_scripts/get_settings.py b/docs/_scripts/get_settings.py index f4267bf..6be56da 100644 --- a/docs/_scripts/get_settings.py +++ b/docs/_scripts/get_settings.py @@ -23,7 +23,7 @@ index = "guide-adm/hope/settings.md" -FILE = "https://raw.githubusercontent.com/unicef/hct-mis/develop/backend/hct_mis_api/config/env.py" +FILE = "https://raw.githubusercontent.com/unicef/hope/develop/backend/hct_mis_api/config/env.py" res = requests.get(FILE) buf = StringIO(res.text) execCode = compile(res.text, 'mulstring', 'exec') diff --git a/docs/components/pg/index.md b/docs/components/pg/index.md index d4ab414..8901488 100644 --- a/docs/components/pg/index.md +++ b/docs/components/pg/index.md @@ -46,5 +46,5 @@ Once HOPE confirms that Payment Plan is ready, PG starts sending data to Western Transactions support: -- Money in Minutes (aka Cash by FSP) +- Money in Minutes (aka Cash over the counter) - Wallets (aka Mobile Money) diff --git a/docs/glossary/terms/program.md b/docs/glossary/terms/programme.md similarity index 98% rename from docs/glossary/terms/program.md rename to docs/glossary/terms/programme.md index 673180a..8355a1d 100644 --- a/docs/glossary/terms/program.md +++ b/docs/glossary/terms/programme.md @@ -1,9 +1,9 @@ --- description: "unique address identity for a User" template: term.html -title: Program +title: Programme tags: - - program + - programme - cycle terms: - glossary: diff --git a/docs/guide-user/.pages b/docs/guide-user/.pages index 2206100..0fcf87b 100644 --- a/docs/guide-user/.pages +++ b/docs/guide-user/.pages @@ -1,6 +1,6 @@ nav: - index.md - - Program Management: program.md + - Program Management: programme.md - Beneficiary Management: beneficiary.md - Population Management: population.md - Targeting: targeting.md diff --git a/docs/guide-user/_screenshots/program/1.png b/docs/guide-user/_screenshots/programme/1.png similarity index 100% rename from docs/guide-user/_screenshots/program/1.png rename to docs/guide-user/_screenshots/programme/1.png diff --git a/docs/guide-user/_screenshots/program/2.png b/docs/guide-user/_screenshots/programme/2.png similarity index 100% rename from docs/guide-user/_screenshots/program/2.png rename to docs/guide-user/_screenshots/programme/2.png diff --git a/docs/guide-user/_screenshots/program/3.png b/docs/guide-user/_screenshots/programme/3.png similarity index 100% rename from docs/guide-user/_screenshots/program/3.png rename to docs/guide-user/_screenshots/programme/3.png diff --git a/docs/guide-user/_screenshots/program/4.png b/docs/guide-user/_screenshots/programme/4.png similarity index 100% rename from docs/guide-user/_screenshots/program/4.png rename to docs/guide-user/_screenshots/programme/4.png diff --git a/docs/guide-user/_screenshots/program/5.png b/docs/guide-user/_screenshots/programme/5.png similarity index 100% rename from docs/guide-user/_screenshots/program/5.png rename to docs/guide-user/_screenshots/programme/5.png diff --git a/docs/guide-user/index.md b/docs/guide-user/index.md index ce434b4..cc56eab 100644 --- a/docs/guide-user/index.md +++ b/docs/guide-user/index.md @@ -5,7 +5,7 @@ title: User Manual Hope is composed by different modules: -- [Program Management](program.md) +- [Programme Management](programme.md) - [Beneficiary Management](beneficiary.md) - [Population Management](population.md) - [Targeting](targeting.md) diff --git a/docs/guide-user/program.md b/docs/guide-user/programme.md similarity index 93% rename from docs/guide-user/program.md rename to docs/guide-user/programme.md index edec95b..032f33d 100644 --- a/docs/guide-user/program.md +++ b/docs/guide-user/programme.md @@ -28,13 +28,13 @@ What Do I Need to Do Before Creating a Programme in Hope? Select the ‘Programme Management’ tab in the legend, then select ‘Create Programme’ -![Image](_screenshots/program/1.png) +![Image](_screenshots/programme/1.png) #### Provides infos Fill in the required fields for the new Programme. -![Image](_screenshots/program/2.png) +![Image](_screenshots/programme/2.png) !!! note @@ -47,7 +47,7 @@ Fill in the required fields for the new Programme. Upon clicking “Next”, the programme partners page will appear where you can select a programme partner from a drop-down list and grant access to the entire business area or limit access by administrative areas. Users are also able to assign more than one partner to a programme. -![Image](_screenshots/program/3.png) +![Image](_screenshots/programme/3.png) #### Complete setup @@ -59,7 +59,7 @@ Three actions can occur in the Programme Details page: 1. To change programme settings, click on the Edit button. 1. To remove the programme, click on the remove button. (Note that you can only remove a programme in draft status) -![Image](_screenshots/program/4.png) +![Image](_screenshots/programme/4.png) #### Activate the Program @@ -68,4 +68,4 @@ After the programme is activated, the following actions can be performed on the 1. Edit Programme: to update programme’s details. 1. Finish Programme: to deactivate the programme after it has been completed. -![Image](_screenshots/program/5.png) +![Image](_screenshots/programme/5.png) diff --git a/docs/index.md b/docs/index.md index 40f4cd5..cbacea6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,11 @@ title: Documentation HOPE is UNICEF's humanitarian cash transfer corporate platform that is used since 2021 in more than 20 countries by UNICEF and its partners (Civil Society and Government organizations). HOPE provides a unified consolidated reporting for beneficiary data, increase accountability and -traceability, grow cash programs while ensuring due diligence, risk informed implementation and +traceability, grow cash programmes while ensuring due diligence, risk informed implementation and overall - simplifying a system of complex processes to pay cash transfer at scale in humanitarian contexts. -Summary: The HOPE system allows organization disbursing cash transfers to perform the following function with programme quality assurance, data protection standards and a risk informed cash transfer delivery for Humanitarian Cash Transfers as well as incentive payments for frontline workers. HOPE offers the following high level functiinalities: +Summary: The HOPE system allows organization disbursing cash transfers to perform the following function with programme quality assurance, data protection standards and a risk informed cash transfer delivery for Humanitarian Cash Transfers as well as incentive payments for frontline workers. HOPE offers the following high level functionalities: 1. Collect beneficiary data. 2. Associate data with cash transfers programmes diff --git a/docs/links.md b/docs/links.md index 764b762..3d884d4 100644 --- a/docs/links.md +++ b/docs/links.md @@ -1,7 +1,7 @@ # Links [//]: # ([![CI](https://github.com/unicef/hope/actions/workflows/ci.yml/badge.svg?branch=develop&event=push)](https://github.com/unicef/hope/actions/workflows/ci.yml)) -[//]: # ([![codecov](https://codecov.io/gh/unicef/hct-mis/graph/badge.svg?token=kAuZEX5k5o)](https://codecov.io/gh/unicef/hope)) +[//]: # ([![codecov](https://codecov.io/gh/unicef/hope/graph/badge.svg?token=kAuZEX5k5o)](https://codecov.io/gh/unicef/hope)) [//]: # ([![Docker](https://img.shields.io/docker/pulls/unicef/hope)](https://hub.docker.com/repository/docker/unicef/hope/tags)) [//]: # ([![Lint](https://github.com/unicef/hope/actions/workflows/lint.yml/badge.svg)](https://github.com/unicef/hope/actions/workflows/lint.yml)) @@ -9,12 +9,12 @@ -- Official Web Site: {:target="_extra"} +- Official Web Site: {:target="_extra"} - Documentation: {:target="_extra"} -- License: {:target="_extra"} +- License: {:target="_extra"} ### Technical Resources -- Source code: {:target="_extra"} -- Issue Tracker: {:target="_extra"} +- Source code: {:target="_extra"} +- Issue Tracker: {:target="_extra"} From 8f858279de7295faac893f628ef6ea52b8db447e Mon Sep 17 00:00:00 2001 From: Domenico DiNicola Date: Tue, 1 Oct 2024 15:15:40 +0200 Subject: [PATCH 5/5] fix --- docs/guide-dev/stack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide-dev/stack.md b/docs/guide-dev/stack.md index bb5ce24..b42c038 100644 --- a/docs/guide-dev/stack.md +++ b/docs/guide-dev/stack.md @@ -16,5 +16,5 @@ Here a brief list of the relevant technologies ## pyproject.toml ``` ini ---8<-- "https://raw.githubusercontent.com/unicef/hope/refs/heads/develop/src/pyproject.toml" +--8<-- "https://raw.githubusercontent.com/unicef/hope/refs/heads/develop/pyproject.toml" ```