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 c2af3db..b11f610 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 8d1b7d9..9b5cfe9 100644 --- a/docs/guide-user/program.md +++ b/docs/guide-user/programme.md @@ -23,13 +23,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 @@ -42,7 +42,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 @@ -54,7 +54,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 @@ -63,4 +63,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"}