Merge pull request #6 from unicef/develop

release
unicef · Oct 1, 2024 · b18efec · b18efec
2 parents 64e8d5e + 8f85827
commit b18efec
Show file tree

Hide file tree

Showing 22 changed files with 71 additions and 50 deletions.
diff --git 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/.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
diff --git a/docs/components/aurora/.pages 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
@@ -1,4 +1,4 @@
-# Development Setup
+# Contributing
 
 
 Prerequisites:

diff --git a/docs/components/aurora/usage.md 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`
diff --git 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 <https://github.com/unicef/aurora>)
 
-[//]: # (- Kobo <https://www.kobotoolbox.org/> )
+- [Aurora](aurora/index.md) 
 
-[//]: # (- DeduplicationEngine <https://github.com/unicef/hope-dedup-engine>)
+- [Kobo](kobo.md) 
 
-[//]: # (- Country Report <https://github.com/unicef/hope-country-report>)
+- [DeduplicationEngine](hde.md)
 
-[//]: # (- Payment Gateway <https://github.com/unicef/hope-payment-gateway>)
+- [Country Report](reporting/index.md)
 
-[//]: # (- Country Workspace <https://github.com/unicef/hope-country-workspace> _&#40;not yet released&#41;_)
+- [Payment Gateway](pg/index.md)
 
-[//]: # (- User Management Module <https://github.com/unicef/hope-user-management> _&#40;not yet released&#41;_)
+- 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 <https://github.com/unicef/hope-flex-fields>)
+## Hope supporting libraries
+
+
+These are some of the libraries developed to support HOPE that are released under the OpenSource License
+
+
+- Flex Fields <https://github.com/unicef/hope-flex-fields>
+- Django SmartEnv <https://github.com/unicef/django-smart-env>
diff --git 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/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

diff --git a/docs/glossary/terms/program.md → docs/glossary/terms/programme.md b/docs/glossary/terms/program.md → 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-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.
diff --git 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"
 ```
diff --git 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 → docs/guide-user/_screenshots/programme/1.png b/docs/guide-user/_screenshots/program/1.png → docs/guide-user/_screenshots/programme/1.png
diff --git a/docs/guide-user/_screenshots/program/2.png → docs/guide-user/_screenshots/programme/2.png b/docs/guide-user/_screenshots/program/2.png → docs/guide-user/_screenshots/programme/2.png
diff --git a/docs/guide-user/_screenshots/program/3.png → docs/guide-user/_screenshots/programme/3.png b/docs/guide-user/_screenshots/program/3.png → docs/guide-user/_screenshots/programme/3.png
diff --git a/docs/guide-user/_screenshots/program/4.png → docs/guide-user/_screenshots/programme/4.png b/docs/guide-user/_screenshots/program/4.png → docs/guide-user/_screenshots/programme/4.png
diff --git a/docs/guide-user/_screenshots/program/5.png → docs/guide-user/_screenshots/programme/5.png b/docs/guide-user/_screenshots/program/5.png → docs/guide-user/_screenshots/programme/5.png
diff --git 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 → docs/guide-user/programme.md b/docs/guide-user/program.md → 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
@@ -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
@@ -1,20 +1,20 @@
 # Links
 
 [//]: # ([![CI]&#40;https://github.com/unicef/hope/actions/workflows/ci.yml/badge.svg?branch=develop&event=push&#41;]&#40;https://github.com/unicef/hope/actions/workflows/ci.yml&#41;)
-[//]: # ([![codecov]&#40;https://codecov.io/gh/unicef/hct-mis/graph/badge.svg?token=kAuZEX5k5o&#41;]&#40;https://codecov.io/gh/unicef/hope&#41;)
+[//]: # ([![codecov]&#40;https://codecov.io/gh/unicef/hope/graph/badge.svg?token=kAuZEX5k5o&#41;]&#40;https://codecov.io/gh/unicef/hope&#41;)
 [//]: # ([![Docker]&#40;https://img.shields.io/docker/pulls/unicef/hope&#41;]&#40;https://hub.docker.com/repository/docker/unicef/hope/tags&#41;)
 
 [//]: # ([![Lint]&#40;https://github.com/unicef/hope/actions/workflows/lint.yml/badge.svg&#41;]&#40;https://github.com/unicef/hope/actions/workflows/lint.yml&#41;)
 [//]: # ([![License]&#40;https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Funicef%2Fhope%2Fdevelop%2Fpyproject.toml&query=project.license.text&label=license&#41;]&#40;https://github.com/unicef/hope?tab=License-1-ov-file&#41;)
 
 
 
-- Official Web Site: <https://github.com/unicef/hct-mis/>{:target="_extra"}
+- Official Web Site: <https://github.com/unicef/hope/>{:target="_extra"}
 - Documentation: <https://unicef.github.io/hope-documentation/>{:target="_extra"}
-- License: <https://github.com/unicef/hct-mis?tab=AGPL-3.0-1-ov-file>{:target="_extra"}
+- License: <https://github.com/unicef/hope?tab=AGPL-3.0-1-ov-file>{:target="_extra"}
 
 
 ### Technical Resources
 
-- Source code: <https://github.com/unicef/hct-mis>{:target="_extra"}
-- Issue Tracker: <https://github.com/unicef/hct-mis/issues>{:target="_extra"}
+- Source code: <https://github.com/unicef/hope>{:target="_extra"}
+- Issue Tracker: <https://github.com/unicef/hope/issues>{:target="_extra"}