Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ Welcome to the OpenSPP overview section. This section provides high-level inform

- {doc}`features/index`
- {doc}`use_cases/index`
- {doc}`case_studies/index`
- {doc}`concepts/index`
- {doc}`poc_and_pilot`

- {doc}`concepts/index`
<!-- - {doc}`case_studies/index` -->

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve maintainability and reduce clutter, it's better to remove this commented-out link to case_studies/index rather than leaving it in the file. If this page is planned to be re-introduced soon, a ticket or issue should be created to track that work.



```{toctree}
Expand All @@ -24,7 +23,6 @@ Welcome to the OpenSPP overview section. This section provides high-level inform

features/index
use_cases/index
case_studies/index
concepts/index
poc_and_pilot
concepts/index
```
1 change: 1 addition & 0 deletions docs/overview/use_cases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ This section provides entry points for OpenSPP's main use cases.
farmer_registry
social_registry
sp_mis
social-protection-management-information-system

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This new entry social-protection-management-information-system appears to be redundant. The sp_mis entry on the line above already covers the 'Social Protection Management Information System' topic. Furthermore, this new entry points to a file that doesn't seem to exist in the repository, which will likely break the documentation build. Please remove this line.

```
2 changes: 0 additions & 2 deletions docs/user_guide/administration/email_gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Email Gateway Configuration

## Introduction

The Email Gateway in OpenSPP allows the platform to both send and receive emails, automating key communication and data entry tasks.
- **Outgoing Emails (SMTP):** Used for sending system notifications, user invitations, password resets, and other communications from OpenSPP to users and beneficiaries.
- **Incoming Emails (IMAP/POP):** Used to automatically create or update records in OpenSPP from a dedicated mailbox. For example, an email sent to a specific address could automatically generate a grievance ticket or a change request.
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/administration/hardware_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Hardware integration

## Introduction

Hardware integration is a key feature of OpenSPP, allowing for the integration of hardware devices to improve the {term}`efficiency` and {term}`effectiveness` of {term}`social protection` programs. Currently, OpenSPP supports two types of hardware integrations:

**Document scanner through FTP**: This integration allows for the automated scanning and uploading of documents, such as {term}`beneficiary` {term}`identification` documents or proof of income, directly into the OpenSPP platform. This reduces the need for manual data entry and improves the accuracy and timeliness of data.
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/administration/import_areas.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Import area

## Introduction

In this tutorial, you will learn how to prepare and import area data into OpenSPP using an Excel workbook.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/administration/inventory_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Inventory Configuration

## Introduction

OpenSPP's In-Kind and Basket Entitlement modules leverage Odoo's powerful Inventory application to manage the distribution of goods and services to beneficiaries. To ensure these modules function correctly, specific features within the Inventory settings must be activated.

This guide provides a step-by-step process for enabling two critical inventory features:
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/administration/service_points.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Setting up service points

## Introduction

A service point is a virtual or physical location where individuals can receive or access their social protection services and benefits. Setting up service points is crucial for entitlement delivery to ensure that services and benefits are delivered to the recipients correctly. In this tutorial, you will learn how to set up service points.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/administration/user_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Administrating role-based access

## Introduction

User Access Management is a key component of OpenSPP that enables program administrators to control and manage user access to the platform's features and data. With OpenSPP's role-based access control system, administrators can define different levels of access for individual users or groups, ensuring that only authorized users have access to specific data and features.

There are different dimensions to access rights in OpenSPP, including access to specific app features and access to specific data or subsets of data (for example, data related to a specific location). By defining these access rights, administrators can make sure that users are able to perform their roles and responsibilities effectively while minimizing the risk of data breaches or unauthorized access.
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/consent_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Consent management

## Introduction

Consent management is an essential component of {term}`social protection` programs that deal with {term}`personal data`. In order to protect the privacy of {term}`beneficiaries` and ensure that their personal information is being used and shared appropriately, it is important to obtain their consent for data processing and sharing.

OpenSPP provides a built-in consent management system that enables program administrators to manage and track consent from beneficiaries. With OpenSPP's consent management, administrators can easily obtain, store, and manage consent from beneficiaries for data processing and sharing.
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/grievance_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Grievance Redressal Management

## Introduction

Grievance management is an important aspect of {term}`social protection` programs, as it provides a mechanism for {term}`beneficiaries` to report and resolve complaints or issues related to program implementation. In OpenSPP, we have developed a built-in grievance management system to help program administrators effectively manage and resolve grievances in a timely and efficient manner.

Content available soon.
2 changes: 0 additions & 2 deletions docs/user_guide/pos_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Point of Sales

## Introduction

In this Tutorial, you will learn about the POS feature; covering configuration, creating Point of sales and setting it by area.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/allocate_funds.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Allocate funds

## Introduction

This tutorial covers the step-by-step procedure on how to allocate funds for a project.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/configure_entitlements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Configure cash entitlements

## Introduction

This tutorial describes the steps of configuring cash entitlements when selected as Entitlement manager.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/create_cycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Create Cycles & Prepare Entitlements

## Introduction

In this tutorial, you will learn the process of configuring, creating, and approving cycles and preparing entitlements in OpenSPP.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/create_program.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Creating a Program

## Introduction

This tutorial offers a comprehensive, step-by-step guide for establishing a social protection program using the OpenSPP platform. It is designed to assist users in configuring programs according to specific objectives and operational requirements.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/enrol_beneficiaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Enrol beneficiaries

## Introduction

In this tutorial, you will learn the process of enrolling beneficiaries in OpenSPP. Accurate beneficiary enrolment ensures that the right individuals or groups receive the intended benefits.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/program_management/using_geotargeting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ migration-notes: "Added during 2025 documentation reorganization"
---
# Geotargeting

## Introduction

Use geotargeting to increase accuracy and {term}`effectiveness` in {term}`social protection` program enrollment. Geotargeting identifies potential {term}`beneficiaries`' locations, letting program administrators accurately target {term}`outreach` efforts, deliver {term}`benefits` to those in need, and reduce {term}`fraud` and leakage risks.

OpenSPP's built-in geotargeting capabilities allow program administrators to locate potential beneficiaries based on location and streamline the enrollment process, ensuring eligible individuals get necessary benefits.
Expand Down
3 changes: 1 addition & 2 deletions docs/user_guide/registry_management/dms.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ migration-notes: "Added during 2025 documentation reorganization"
---

# Document Management System

## Introduction

In this tutorial, you will learn how to use the Document Management System feature in OpenSPP.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/registry_management/identity_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Configure ID and generate QR code

## Introduction

This guide offers a comprehensive, step-by-step overview for Operations Admins and Administrators on the process of configuring identification **ID** credentials and generating corresponding QR codes within OpenSPP. It details the procedures for creating and managing ID types, assigning unique IDs to individuals or groups, and generating printable documents embedded with scannable QR codes.

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Import and Export Registrant Data

## Introduction

This guide offers a comprehensive, step-by-step overview of the process for exporting registrant data from OpenSPP. It details the procedures, configurable options, and considerations available to system administrators, including how to use the export functionality to prepare files for re-import into OpenSPP.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/registry_management/register_individual.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Register new individual

## Introduction

This guide provides a comprehensive, step-by-step overview for authorized users on the process of registering new entities within the OpenSPP platform. It details the procedures for manually creating individual and group records, as well as the method for associating existing individuals as members of a group.

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Setting up Farmer Registry

## Introduction

This guide provides step-by-step instructions for installing the Farmer Registry module in OpenSPP and configuring it to generate sample farmer data. The module extends OpenSPP with features for farmer registration and management.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/registry_management/using_change_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Change Requests

## Introduction

This guide explains how to update registrant information in OpenSPP using the Change Request module. The process follows a defined workflow, requiring users with specific roles to initiate and validate requests. Permission-based access and thorough documentation help ensure data accuracy and reliable operations.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions docs/user_guide/registry_management/using_event_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ migration-notes: "Added during 2025 documentation reorganization"

# Event Data

## Introduction

In OpenSPP, Event Data provides a flexible mechanism to record and track specific, significant occurrences related to registrants over time. This functionality enhances the system's capacity to capture a chronological history of changes and actions without directly modifying the main registrant profile.

### Overview of Event Data Functionality
Expand Down