From df1f96505487886f18cd81bd2cf8c31c2659add7 Mon Sep 17 00:00:00 2001 From: Celine Lewerentz Date: Thu, 2 Oct 2025 19:33:37 +0700 Subject: [PATCH 1/3] split module installation and rewrite getting started index page --- docs/getting_started/farmer_installation.md | 39 +++++ docs/getting_started/index.md | 64 ++++---- docs/getting_started/installation_deb.md | 6 +- docs/getting_started/module_installation.md | 166 +++++--------------- docs/getting_started/social_installation.md | 36 +++++ docs/getting_started/spmis_installation.md | 42 +++++ docs/overview/index.md | 8 +- docs/overview/products/farmer_registry.md | 4 +- docs/overview/products/index.md | 6 +- docs/overview/products/social_registry.md | 4 +- docs/overview/products/sp_mis.md | 6 +- 11 files changed, 198 insertions(+), 183 deletions(-) create mode 100644 docs/getting_started/farmer_installation.md create mode 100644 docs/getting_started/social_installation.md create mode 100644 docs/getting_started/spmis_installation.md diff --git a/docs/getting_started/farmer_installation.md b/docs/getting_started/farmer_installation.md new file mode 100644 index 000000000..ad2a0b52e --- /dev/null +++ b/docs/getting_started/farmer_installation.md @@ -0,0 +1,39 @@ +--- +myst: + html_meta: + "title": "OpenSPP Module Installation Guide" + "description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry" + "keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry" +--- + +# Farmer Registry installation + +**OpenSPP Farmer Registry Base / spp_base_farmer_registry** + +The {doc}`OpenSPP Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives. + +**What's included:** +- Farmer and farm household registration +- Land parcel mapping with GIS integration +- Crop and livestock tracking +- Agricultural input distribution management +- Seasonal cycle management +- Integration with agricultural extension services + +**Installation steps:** + +1. Navigate to the **Apps** menu. +2. In the Apps menu, search for {doc}`spp_base_farmer_registry ` or "OpenSPP Farmer Registry Base" + +![Searching for SPP Farmer Registry module](module_installation/05-spp_farmer1.jpg) + +3. Click the **Activate** button to install the module and its dependencies. + +![SPP Farmer Registry module installation complete](module_installation/06-spp_farmer2.jpg) + +4. Restart OpenSPP after installing the module: + ```bash + sudo systemctl restart openspp + ``` + +**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index 1983dd89a..8541581cc 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -11,33 +11,46 @@ myst: Welcome to OpenSPP! This guide will help you get your social protection platform up and running quickly. ## Quick start path +Start here if you're setting up OpenSPP for the first time: :::::{grid} 2 :gutter: 3 -::::{grid-item-card} New installation -Start here if you're setting up OpenSPP for the first time: +::::{grid-item-card} I want to use the OpenSPP products + +1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) ` + +
-1. **{doc}`Installation guide `** - Install OpenSPP on Debian/Ubuntu (30 minutes) +2. Install {doc}`SP-MIS `, {doc}`Social Registry `, or {doc}`Farmer Registry ` from the available modules. -2. **{doc}`Module installation `** - Choose {doc}`SP-MIS <../overview/products/sp_mis>`, {doc}`Social Registry <../overview/products/social_registry>`, or {doc}`Farmer Registry <../overview/products/farmer_registry>` +
-3. **Initial setup** - Configure your first program and import data +3. Get your system ready for use: + - Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` + - Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` + - Configure user access - {doc}`Administration <../user_guide/administration/index>` + :::: -::::{grid-item-card} Learn the system -Explore OpenSPP's capabilities: +::::{grid-item-card} I want to select my modules freely + +1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) ` + +
+ +2. Choose modules to install. Read more about {doc}`module installation ` and {doc}`available modules <../reference/modules/index>` + +
-- **{doc}`Features <../overview/features/index>`** - Understand key features -- **{doc}`Products <../overview/products/index>`** - Choose the right product configuration -- **{doc}`User guide <../user_guide/index>`** - Learn day-to-day operations +3. Get your system ready for use: + - Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` + - Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` + - Configure user access - {doc}`Administration <../user_guide/administration/index>` :::: ::::: -## Choose your configuration +## OpenSPP configurations OpenSPP offers three primary configurations based on your needs: @@ -59,28 +72,6 @@ OpenSPP offers three primary configurations based on your needs: - • Farm mapping
• Crop tracking
• Input distribution
• Seasonal cycles ``` -## Steps - -### 1. System installation -**Time required:** 30-45 minutes - -Install OpenSPP using our Debian packages: -- {doc}`Installation Guide ` - Production deployment on Ubuntu/Debian - -### 2. Module configuration -**Time required:** 15-30 minutes - -After installation, configure your system: -- {doc}`Module Installation ` - Install base modules and extensions - -### 3. Initial setup -**Time required:** 1-2 hours - -Get your system ready for use: -- Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>` -- Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>` -- Configure user access - {doc}`Administration <../user_guide/administration/index>` - ## Where to go next Based on your role: @@ -121,6 +112,7 @@ Based on your role: - **[GitHub Discussions](https://github.com/orgs/OpenSPP/discussions)** - Ask questions and get help from the community - **[Report Issues](https://github.com/OpenSPP/openspp-modules/issues)** - Report bugs or request features - **{doc}`OpenSPP Glossary <../reference/glossary>`** - Look up terms (available in multiple languages) +- **[OpenSPP Discord server](https://discord.gg/bgrwxhEQty)** - Join the OpenSPP Discord server and meet the rest of the community ```{toctree} --- diff --git a/docs/getting_started/installation_deb.md b/docs/getting_started/installation_deb.md index 693e873f7..38c54b086 100644 --- a/docs/getting_started/installation_deb.md +++ b/docs/getting_started/installation_deb.md @@ -6,10 +6,14 @@ myst: "keywords": "OpenSPP, installation, Ubuntu 24.04, Debian 12, PostgreSQL, APT repository, setup guide" --- -# Installation guide +# Installing OpenSPP This guide walks you through installing OpenSPP on Ubuntu 24.04 or Debian 12 (Bookworm) using the official APT repository hosted on Nexus. +:::{tip} +For development setup instructions, see the {doc}`Development Setup Guide <../developer_guide/setup>`. +::: + ## Prerequisites Before installing OpenSPP, ensure you have: diff --git a/docs/getting_started/module_installation.md b/docs/getting_started/module_installation.md index 49eb80d70..25e7a4e7a 100644 --- a/docs/getting_started/module_installation.md +++ b/docs/getting_started/module_installation.md @@ -10,124 +10,46 @@ myst: OpenSPP's modular architecture allows organizations to deploy only the features they need. Built on Odoo 17, the platform extends functionality through specialized modules that can be mixed and matched to create tailored social protection solutions. This guide covers installing OpenSPP modules for different use cases. -## Prerequisites - -Before installing OpenSPP modules, ensure you have: - -- **Odoo 17 instance** running and accessible -- **OpenSPP modules** source code from the [OpenSPP repository](https://github.com/OpenSPP/openspp-modules/tree/17.0/) -- **Addons path** configured to include the `openspp-modules` directory -- **Administrator access** to your Odoo instance -- **Developer mode** knowledge (required for module installation) - -:::{tip} -For development setup instructions, see the {doc}`Development Setup Guide <../developer_guide/setup>`. +:::{important} +Before installing OpenSPP modules, ensure you have an **Odoo 17 instance** running and accessible. If not, follow the {doc}`Installation guide ` in order to install it. ::: -## General installation process - -Installing an Odoo module, including those for OpenSPP, follows a standard procedure: +## Installing OpenSPP base modules -1. **Place Modules in Addons Path**: Ensure the `openspp-modules` directory is included in your Odoo configuration's `addons_path`. -2. **Update apps list**: - - Log in to your Odoo instance with administrator privileges. - - Activate the developer mode. - - Navigate to the **Apps** menu. - - Click on **Update Apps List** and confirm the update. -3. **Install the module**: - - In the **Apps** menu, clear the default "Apps" filter from the search bar. - - Search for the desired module by its technical name or title. - - Click the **Activate** button on the module's card to begin the installation. - -![OpenSPP Apps menu interface](module_installation/01-apps-ui.jpg) - -## Installation setups - -OpenSPP can be configured in different ways depending on your project's needs. Below are the installation guides for three primary setups. +OpenSPP comes with three configured base modules depending on your needs. The steps on how to install these can be found in {doc}`Installation of OpenSPP Social Registry `, {doc}`Installation of OpenSPP SP-MIS ` and {doc}`Installation of OpenSPP Farmer Registry `. :::{important} -The **SP-MIS** ({doc}`spp_base `), and **Farmer Registry** ({doc}`spp_farmer_registry_base `) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. +The **SP-MIS** ({doc}`spp_base_spmis `), **Farmer Registry** ({doc}`spp_base_farmer_registry `) and **Social Registry** ({doc}`spp_base_social_registry `) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. ::: -### 1. SP-MIS installation (spp_base) - -The Social Protection Management Information System ({doc}`SP-MIS <../overview/products/sp_mis>`) configuration provides comprehensive functionality for managing social protection programs. This setup is ideal for organizations running cash transfers, social assistance programs, or humanitarian interventions. - -**What's included:** -- Registry management for individuals and groups -- Program cycles and beneficiary enrollment -- Eligibility determination and targeting -- Entitlement calculation and management -- Payment processing integration - -**Installation steps:** - -1. Follow the General Installation Process to update your Apps list -2. In the Apps menu, search for {doc}`spp_base ` or "OpenSPP Base" - -![Searching for SPP Base module in Apps](module_installation/02-spp_base01.jpg) - -3. Click the **Activate** button to install the module. This will also install all its dependencies, providing a complete SP-MIS foundation. - -![SPP Base module installation screen](module_installation/03-spp_base2.jpg) - -Once installed, you will see the "Registry" application in your Odoo dashboard, which is the main entry point for the OpenSPP system. - -![SPP Base module successfully installed](module_installation/04-spp_base3.jpg) - -### 2. Social Registry installation (spp_registry_base) - -The {doc}`Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information. - -**What's included:** -- Unified beneficiary database across programs -- Advanced deduplication and data quality management -- Dynamic registration and needs assessment -- Inter-program data sharing and coordination -- Household composition and relationship tracking -- Socioeconomic data collection and analysis -- Data privacy and access control mechanisms - -**Installation steps:** - -1. Follow the General Installation Process to update your Apps list -2. In the Apps menu, search for {doc}`spp_registry_base ` or "OpenSPP Social Registry" -3. Click the **Activate** button to install the module and its dependencies - -Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs. - -### 3. Farmer Registry installation (spp_farmer_registry_base) +## Installing additional modules -The {doc}`Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives. +After setting up your base system you can extend the functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery. -**What's included:** -- Farmer and farm household registration -- Land parcel mapping with GIS integration -- Crop and livestock tracking -- Agricultural input distribution management -- Seasonal cycle management -- Integration with agricultural extension services +:::{note} +Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both. +::: -**Installation steps:** +## General installation process -1. Follow the general installation process to update your Apps list -2. In the Apps menu, search for {doc}`spp_farmer_registry_base ` or "OpenSPP Farmer Registry Base" +Installing an Odoo module, including those for OpenSPP, follows a standard procedure: -![Searching for SPP Farmer Registry module](module_installation/05-spp_farmer1.jpg) +1. Navigate to the **Apps** menu. -3. Click the **Activate** button to install the module and its dependencies. +2. Search for the desired module by its technical name or title. If the module does not show up, clear the default "Apps" filter from the search bar. -![SPP Farmer Registry module installation complete](module_installation/06-spp_farmer2.jpg) +3. Click the **Activate** button on the module's card to begin the installation. -## Installing additional modules +![OpenSPP Apps menu interface](module_installation/01-apps-ui.jpg) -After setting up your base system (either SP-MIS or Farmer Registry), you can extend functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery. +4. Restart OpenSPP after installing the modules: + ```bash + sudo systemctl restart openspp + ``` -:::{note} -Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both. -::: +**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. -### Common extension modules +## Common extension modules **Data management:** - **Change request** ({doc}`spp_change_request `) - Workflow for reviewing and approving data modifications @@ -144,41 +66,11 @@ Additional modules automatically detect and respect your base configuration (SP- - **OpenID Connect** ({doc}`spp_oauth `) - Single sign-on and authentication - **DCI API Server** ({doc}`spp_dci_api_server `) - Data Collection Interface API -### Example: Installing change request module - -Let's walk through installing the {doc}`Change Request ` module as an example: - -**Steps:** - -1. Navigate to the **Apps** menu -2. Search for {doc}`spp_change_request ` or "OpenSPP Change Request" - -![Searching for SPP Change Request module](module_installation/08-spp_cr1.jpg) - -3. Click the **Activate** button. - -![SPP Change Request module installed](module_installation/09-spp_cr2.jpg) - -### Example: Installing cash entitlement module - -The **OpenSPP Entitlement: Cash** ({doc}`spp_entitlement_cash `) module adds functionality to manage cash-based entitlements for registrants. - -**Steps:** - -1. Navigate to the **Apps** menu. -2. Search for {doc}`spp_entitlement_cash ` or "OpenSPP Entitlement: Cash". - -![Searching for SPP Entitlement Cash module](module_installation/10-spp_ent_cash1.jpg) - -3. Click the **Activate** button. - -![SPP Entitlement Cash module installation complete](module_installation/11-spp_ent_cash2.jpg) - ## Module dependencies OpenSPP modules often have dependencies that are automatically installed. Understanding these relationships helps with troubleshooting: -- **Core dependencies** are always installed (e.g., {doc}`spp_base ` installs registry modules) +- **Core dependencies** are always installed (e.g., {doc}`spp_base_spmis ` installs registry modules) - **Optional dependencies** can be manually selected based on your needs - **Conflicting modules** will show warnings during installation attempts @@ -214,3 +106,15 @@ After installing your modules: 4. **Test workflows** - Verify the installed features work as expected For detailed configuration guides for specific modules, see the {doc}`../user_guide/index` and {doc}`../reference/modules/index`. + +```{toctree} +--- +caption: Getting Started +maxdepth: 2 +hidden: true +--- + +spmis_installation +social_installation +farmer_installation +``` \ No newline at end of file diff --git a/docs/getting_started/social_installation.md b/docs/getting_started/social_installation.md new file mode 100644 index 000000000..a4f473203 --- /dev/null +++ b/docs/getting_started/social_installation.md @@ -0,0 +1,36 @@ +--- +myst: + html_meta: + "title": "OpenSPP Module Installation Guide" + "description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry" + "keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry" +--- + +# Social Registry installation + +**OpenSPP Social Registry Base / spp_base_social_registry** + +The {doc}`OpenSPP Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information. + +**What's included:** +- Unified beneficiary database across programs +- Advanced deduplication and data quality management +- Dynamic registration and needs assessment +- Inter-program data sharing and coordination +- Household composition and relationship tracking +- Socioeconomic data collection and analysis +- Data privacy and access control mechanisms + +**Installation steps:** + +1. Navigate to the **Apps** menu. +2. In the Apps menu, search for {doc}`spp_base_social_registry ` or "OpenSPP Social Registry Base" +3. Click the **Activate** button to install the module and its dependencies +4. Restart OpenSPP after installing the module: + ```bash + sudo systemctl restart openspp + ``` + +**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. + +Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs. diff --git a/docs/getting_started/spmis_installation.md b/docs/getting_started/spmis_installation.md new file mode 100644 index 000000000..b4c812976 --- /dev/null +++ b/docs/getting_started/spmis_installation.md @@ -0,0 +1,42 @@ +--- +myst: + html_meta: + "title": "OpenSPP Module Installation Guide" + "description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry" + "keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry" +--- + +# SP-MIS installation + +**OpenSPP SPMIS Base / spp_base_spmis** + +The OpenSPP Social Protection Management Information System ({doc}`OpenSPP SP-MIS <../overview/products/sp_mis>`) configuration provides comprehensive functionality for managing social protection programs. This setup is ideal for organizations running cash transfers, social assistance programs, or humanitarian interventions. + +**What's included:** +- Registry management for individuals and groups +- Program cycles and beneficiary enrollment +- Eligibility determination and targeting +- Entitlement calculation and management +- Payment processing integration + +**Installation steps:** + +1. Navigate to the **Apps** menu. +2. In the Apps menu, search for {doc}`spp_base_spmis ` or "OpenSPP SPMIS Base" + +![Searching for SPP Base module in Apps](module_installation/02-spp_base01.jpg) + +3. Click the **Activate** button to install the module. This will also install all its dependencies, providing a complete SP-MIS foundation. + +![SPP Base module installation screen](module_installation/03-spp_base2.jpg) + +4. Restart OpenSPP after installing the module: + ```bash + sudo systemctl restart openspp + ``` + +**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart. + +Once installed, you will see the "Registry" application in your Odoo dashboard, which is the main entry point for the OpenSPP system. + +![SPP Base module successfully installed](module_installation/04-spp_base3.jpg) diff --git a/docs/overview/index.md b/docs/overview/index.md index 16d834b50..2131617a1 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -18,29 +18,27 @@ OpenSPP offers three specialized configurations designed for different social pr :gutter: 2 ::::{grid-item-card} [SP-MIS](products/sp_mis.md) -:link: products/sp_mis.md +:link: products/sp_mis :link-type: doc Social Protection Management Information System for comprehensive program delivery including cash transfers, conditional assistance, and humanitarian interventions. :::: ::::{grid-item-card} [Social Registry](products/social_registry.md) -:link: products/social_registry.md +:link: products/social_registry :link-type: doc Centralized beneficiary database that serves as a single source of truth across multiple programs, reducing duplication and enabling better coordination. :::: ::::{grid-item-card} [Farmer Registry](products/farmer_registry.md) -:link: products/farmer_registry.md +:link: products/farmer_registry :link-type: doc Agricultural-focused platform combining farm data, land management, and social protection for rural development and climate resilience programs. :::: ::::: -{doc}`Explore all products → ` - ## Understand core capabilities OpenSPP delivers comprehensive social protection through modular features that work together seamlessly: diff --git a/docs/overview/products/farmer_registry.md b/docs/overview/products/farmer_registry.md index cbb9f6688..97d6909f5 100644 --- a/docs/overview/products/farmer_registry.md +++ b/docs/overview/products/farmer_registry.md @@ -43,7 +43,7 @@ The **OpenSPP Farmer Registry** is a modular digital platform designed to be a s ## Next Step -The OpenSPP Farmer Registry is an open-source product, built and supported by the OpenSPP community. It can be downloaded from XX +The OpenSPP Farmer Registry is an open-source product, built and supported by the OpenSPP community. Read more about {doc}`installing OpenSPP Farmer Registry <../../getting_started/farmer_installation>`. ## OpenSPP modules included in the OpenSPP Farmer Registry @@ -68,4 +68,4 @@ The following modules are included in the OpenSPP Farmer Registry product: ## Expanding the Farmer Registry -The OpenSPP-based Farmer Registry contains everything that is necessary to set up a foundational Farmer Registry. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more on XX \ No newline at end of file +The OpenSPP-based Farmer Registry contains everything that is necessary to set up a foundational Farmer Registry. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more about {doc}`module installation <../../getting_started/module_installation>`. \ No newline at end of file diff --git a/docs/overview/products/index.md b/docs/overview/products/index.md index 129000c6e..a3f0f5110 100644 --- a/docs/overview/products/index.md +++ b/docs/overview/products/index.md @@ -12,13 +12,13 @@ OpenSPP offers three product configurations, each designed for specific social p ## Available configurations -**{doc}`SP-MIS `**: A Social Protection Management Information System for running complete social programs. +**{doc}`OpenSPP SP-MIS `**: A Social Protection Management Information System for running complete social programs. It can manage the entire lifecycle from beneficiary enrollment through payment disbursement and is ideal for cash transfers, humanitarian aid, and social assistance programs. -**{doc}`Social Registry `**: A centralized database of individuals and households that serves multiple social programs. +**{doc}`OpenSPP Social Registry `**: A centralized database of individuals and households that serves multiple social programs. It can provide a single source of truth across interventions, reducing duplication and improving coordination between programs. -**{doc}`Farmer Registry `**: A specialized registry for agricultural programs that bridges farming and social protection. It enables targeted agricultural interventions, input distribution, and climate-smart agriculture support for rural communities. +**{doc}`OpenSPP Farmer Registry `**: A specialized registry for agricultural programs that bridges farming and social protection. It enables targeted agricultural interventions, input distribution, and climate-smart agriculture support for rural communities. ```{toctree} diff --git a/docs/overview/products/social_registry.md b/docs/overview/products/social_registry.md index b90ccf053..f9125ccc5 100644 --- a/docs/overview/products/social_registry.md +++ b/docs/overview/products/social_registry.md @@ -39,7 +39,7 @@ The **OpenSPP Social Registry** is a digital platform that helps governments and ## Next Step -The OpenSPP Social Registry is an open-source product, built and supported by the OpenSPP community. It can be downloaded from XX +The OpenSPP Social Registry is an open-source product, built and supported by the OpenSPP community. Read more about {doc}`installing OpenSPP Social Registry <../../getting_started/social_installation>`. ## OpenSPP modules included in the OpenSPP Social Registry @@ -57,4 +57,4 @@ The following modules are included in the OpenSPP Social Registry product: ## Expanding the Social Registry -The OpenSPP-based Social Registry contains everything that is necessary to set up a foundational Social Registry. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more on XX +The OpenSPP-based Social Registry contains everything that is necessary to set up a foundational Social Registry. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more about {doc}`module installation <../../getting_started/module_installation>`. diff --git a/docs/overview/products/sp_mis.md b/docs/overview/products/sp_mis.md index b5f457c81..9788e4bc3 100644 --- a/docs/overview/products/sp_mis.md +++ b/docs/overview/products/sp_mis.md @@ -5,7 +5,7 @@ myst: "description": "OpenSPP SP-MIS product configuration for comprehensive social protection program management from enrollment to payment" "keywords": "OpenSPP, SP-MIS, social protection, management information system, beneficiary management, payments" --- -# OpenSPP SP-MIS (Social Protection Management Information System) +# OpenSPP SP-MIS *A digital system to manage the full lifecycle of social protection programs* The **OpenSPP Social Protection Management Information System (SP-MIS)** is a comprehensive platform designed to manage the entire lifecycle of a social protection program. It supports both routine and emergency interventions, whether cash or in-kind, and empowers citizens through secure, verifiable credentials. @@ -48,7 +48,7 @@ The **OpenSPP Social Protection Management Information System (SP-MIS)** is a co ## Next Step -The OpenSPP SP-MIS is an open-source product, built and supported by the OpenSPP community. It can be downloaded from XX +The OpenSPP SP-MIS is an open-source product, built and supported by the OpenSPP community. Read more about {doc}`installing OpenSPP SP-MIS <../../getting_started/spmis_installation>`. ## OpenSPP modules included in the OpenSPP SP-MIS: @@ -71,4 +71,4 @@ The following modules are included in the OpenSPP SP-MIS product: ## Expanding the SPMIS -The OpenSPP-based SPMIS contains everything that is necessary to set up a foundational SPMIS. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more on XX +The OpenSPP-based SPMIS contains everything that is necessary to set up a foundational SPMIS. It can however be expanded with additional functionalities to perfectly suit the specific needs, read more about {doc}`module installation <../../getting_started/module_installation>`. From 733a67a11deaba41457dcbfc5f1921f92d45a896 Mon Sep 17 00:00:00 2001 From: celine lewerentz <36752902+celinenilla@users.noreply.github.com> Date: Thu, 2 Oct 2025 19:48:09 +0700 Subject: [PATCH 2/3] Update docs/getting_started/social_installation.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- docs/getting_started/social_installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/social_installation.md b/docs/getting_started/social_installation.md index a4f473203..649b6216d 100644 --- a/docs/getting_started/social_installation.md +++ b/docs/getting_started/social_installation.md @@ -24,7 +24,7 @@ The {doc}`OpenSPP Social Registry <../overview/products/social_registry>` config **Installation steps:** 1. Navigate to the **Apps** menu. -2. In the Apps menu, search for {doc}`spp_base_social_registry ` or "OpenSPP Social Registry Base" +2. In the Apps menu, search for {doc}`spp_base_social_registry ` or "OpenSPP Social Registry Base" 3. Click the **Activate** button to install the module and its dependencies 4. Restart OpenSPP after installing the module: ```bash From fcf6dd32bc11fa9dcadcec6f20b185300614eb2e Mon Sep 17 00:00:00 2001 From: celine lewerentz <36752902+celinenilla@users.noreply.github.com> Date: Thu, 2 Oct 2025 19:48:24 +0700 Subject: [PATCH 3/3] Update docs/getting_started/spmis_installation.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- docs/getting_started/spmis_installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/spmis_installation.md b/docs/getting_started/spmis_installation.md index b4c812976..bdae679cb 100644 --- a/docs/getting_started/spmis_installation.md +++ b/docs/getting_started/spmis_installation.md @@ -22,7 +22,7 @@ The OpenSPP Social Protection Management Information System ({doc}`OpenSPP SP-MI **Installation steps:** 1. Navigate to the **Apps** menu. -2. In the Apps menu, search for {doc}`spp_base_spmis ` or "OpenSPP SPMIS Base" +2. In the Apps menu, search for {doc}`spp_base_spmis ` or "OpenSPP SPMIS Base" ![Searching for SPP Base module in Apps](module_installation/02-spp_base01.jpg)