From 26f88434aa8473944b82bb6065dc598a0aa0d89a Mon Sep 17 00:00:00 2001 From: saxix Date: Fri, 6 Sep 2024 15:35:39 +0200 Subject: [PATCH] cleadup config --- docs/components/.pages | 3 +- docs/components/hope.md | 5 ++ docs/components/hope/stack.md | 14 ----- docs/components/index.md | 2 +- docs/components/pg/.pages | 3 + docs/components/pg/index.md | 4 -- docs/guide-adm/dependencies.md | 1 - docs/guide-adm/index.md | 0 docs/guide-user/people.md | 2 +- mkdocs.yml | 110 ++++++++++++++++----------------- 10 files changed, 66 insertions(+), 78 deletions(-) create mode 100644 docs/components/hope.md delete mode 100644 docs/components/hope/stack.md create mode 100644 docs/components/pg/.pages create mode 100644 docs/guide-adm/index.md diff --git a/docs/components/.pages b/docs/components/.pages index f47742d..9b394c8 100644 --- a/docs/components/.pages +++ b/docs/components/.pages @@ -1,7 +1,8 @@ nav: - index.md + - hope.md - hde.md - - Payment Gateway: components/pg/ + - Payment Gateway: pg - aurora.md - kobo.md - reporting.md diff --git a/docs/components/hope.md b/docs/components/hope.md new file mode 100644 index 0000000..21de99d --- /dev/null +++ b/docs/components/hope.md @@ -0,0 +1,5 @@ +# HOPE (core) + +- [User Manual](../guide-user/index.md) +- [Development Manual](../guide-dev/index.md) +- [Administration Manual](../guide-adm/index.md) diff --git a/docs/components/hope/stack.md b/docs/components/hope/stack.md deleted file mode 100644 index 6e78241..0000000 --- a/docs/components/hope/stack.md +++ /dev/null @@ -1,14 +0,0 @@ -# Technology stack and platform -## Modern and robust technology stack - -Our open-source software is crafted with a modern technology stack, designed for high performance, flexibility, and ease of contribution. We've thoughtfully selected technology stack that emphasizes scalability, security, and strong community support. - -Our backend is powered by Python Django, providing a reliable and scalable foundation where both RESTful and Graph APIs are implemented for fast and easy data exchange and integrations with other parts of the HOPE ecosystem. - -The frontend is built using React and HTML5 to create a responsive, dynamic user interface that delivers a seamless experience. The Database is PostgreSQL which provides efficient and reliable data storage. - -The code is packaged using Docker so it can be shipped and reusable. We use Kubernetes and Helm charts for deployments to any environment. - -We use GitHub for managing code and version control, along with the GitHub Actions for build pipelines for efficient and automated workflows. - -Transparency and collaboration are at the core of our approach. Our entire tech stack is open-source and documented, making it easy for anyone to understand and deploy HOPE. Our mission is to build and foster an inclusive community where developers of all skill levels can contribute. Our technology stack embodies our commitment to building a product that is both innovative and accessible to the open-source community diff --git a/docs/components/index.md b/docs/components/index.md index 7b40a45..375d5d2 100644 --- a/docs/components/index.md +++ b/docs/components/index.md @@ -1,5 +1,5 @@ --- -title: Hope (core) +title: Ecosystem --- # Ecosystem components diff --git a/docs/components/pg/.pages b/docs/components/pg/.pages new file mode 100644 index 0000000..b853ab4 --- /dev/null +++ b/docs/components/pg/.pages @@ -0,0 +1,3 @@ +nav: + - index.md + - wu.md diff --git a/docs/components/pg/index.md b/docs/components/pg/index.md index afa0859..d4ab414 100644 --- a/docs/components/pg/index.md +++ b/docs/components/pg/index.md @@ -1,7 +1,3 @@ ---- -title: Payment Gateway ---- - # Payment Gateway diff --git a/docs/guide-adm/dependencies.md b/docs/guide-adm/dependencies.md index fa76841..e94e3e5 100644 --- a/docs/guide-adm/dependencies.md +++ b/docs/guide-adm/dependencies.md @@ -5,7 +5,6 @@ tags: # Dependencies -- Python 3.12 - Postgres 15 - Redis - ElasticSearch diff --git a/docs/guide-adm/index.md b/docs/guide-adm/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide-user/people.md b/docs/guide-user/people.md index 5aca9b0..2de9641 100644 --- a/docs/guide-user/people.md +++ b/docs/guide-user/people.md @@ -12,7 +12,7 @@ c) Import data through API #### Beneficiary Registration with KOBO -[KoBo](Kobo) is a digital data collection tool that allows creation of customization of registration forms and easy collation of data for reporting and programmatic use. It consists of two components: +KoBo is a digital data collection tool that allows creation of customization of registration forms and easy collation of data for reporting and programmatic use. It consists of two components: 1. KoBo Toolbox which is a web application 2. KoBo Collect which is mobile application (for Android) diff --git a/mkdocs.yml b/mkdocs.yml index b849a70..04d6dfd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ site_description: "Documentation" site_dir: ./~build/docs site_name: "Documentation" site_url: https://unicef.github.io/hope-documentation/ -strict: true +#strict: true extra_css: - _theme/css/style.css extra_javascript: @@ -25,30 +25,30 @@ markdown_extensions: - abbr - admonition - attr_list - - def_list - - md_in_html - - mkdocs-click +# - def_list +# - md_in_html +# - mkdocs-click - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - - pymdownx.details +# - pymdownx.details - pymdownx.snippets: base_path: 'docs' check_paths: true url_download: true - auto_append: - - _includes/abbreviations.md - - pymdownx.highlight: - use_pygments: true - - pymdownx.tabbed: - alternate_style: true - - smarty - - tables - - toc: - permalink: # - baselevel: 1 +# auto_append: +# - _includes/abbreviations.md +# - pymdownx.highlight: +# use_pygments: true +# - pymdownx.tabbed: +# alternate_style: true +# - smarty +# - tables +# - toc: +# permalink: # +# baselevel: 1 extra: @@ -94,24 +94,24 @@ theme: features: - content.action.edit - content.code.copy - - content.tooltips - - header.autohide - - navigation.footer +# - content.tooltips +# - header.autohide +# - navigation.footer - navigation.indexes - navigation.tabs - - navigation.sections - - toc.integrate +# - navigation.sections +# - toc.integrate - navigation.instant - - navigation.instant.prefetch - - navigation.instant.progress +# - navigation.instant.prefetch +# - navigation.instant.progress plugins: - - alias - - gen-files: - scripts: -# - docs/_scripts/build_glossary.py - - docs/_scripts/get_settings.py - - autorefs +# - alias +# - gen-files: +# scripts: +## - docs/_scripts/build_glossary.py +# - docs/_scripts/get_settings.py +# - autorefs - awesome-pages: filename: .pages collapse_single_pages: true @@ -125,40 +125,38 @@ plugins: list_definitions: true list_references: true tooltip: heading - - ezlinks +# - ezlinks - link-marker - - mkdocstrings - - include-markdown: - encoding: ascii - preserve_includer_indent: false - dedent: false - trailing_newlines: true - comments: false - rewrite_relative_urls: true - heading_offset: 0 -# start: -# end: - recursive: true +# - mkdocstrings +# - include-markdown: +# encoding: ascii +# preserve_includer_indent: false +# dedent: false +# trailing_newlines: true +# comments: false +# rewrite_relative_urls: true +# heading_offset: 0 +# recursive: true - privacy - search - social: cards_dir: assets/images/social cards_layout_options: font_family: Noto Sans SC -# - autolinks - - blog: - blog_dir: howto - blog_toc: true - post_dir: "{blog}/posts" - post_date_format: "" - post_url_max_categories: 1 -# post_excerpt: optional - post_readtime: false - archive: false - categories: false - authors: false - pagination: false - draft: false +## - autolinks +# - blog: +# blog_dir: howto +# blog_toc: true +# post_dir: "{blog}/posts" +# post_date_format: "" +# post_url_max_categories: 1 +## post_excerpt: optional +# post_readtime: false +# archive: false +# categories: false +# authors: false +# pagination: false +# draft: false - tags: tags_file: tags.md