From 6eb67060a044d7b4bfd7c1f4ec677513f387482c Mon Sep 17 00:00:00 2001 From: Stefano Apostolico Date: Tue, 24 Sep 2024 18:11:56 +0200 Subject: [PATCH] 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