improve index file of getting started

anthonymarkQA · anthonymarkQA · commit f3b90532f076 · 2025-09-01T12:05:36.000+08:00
added internal links to installation guide and module installation for users to easily start setup
diff --git a/docs/community/contributing.md b/docs/community/contributing.md
@@ -12,14 +12,14 @@ the community, and are grateful for the time and effort that people put into imp
 
 ## Code of Conduct
 
-We expect all contributors to the OpenSPP project to adhere to our [Code of Conduct](code_of_conduct.md).
+We expect all contributors to the OpenSPP project to adhere to our {doc}`code_of_conduct`.
 This document outlines the standards of behavior that we expect from all members of the community, and
 provides guidance on how to report any incidents of misconduct.
 
 ## Did you find a bug?
 
 - **Do not open up a GitHub issue if the bug is a security vulnerability in OpenSPP**, and instead follow the
-  [security disclosure policy](security_report).
+ {doc}`security_reporting`.
 
 - **Ensure the bug was not already reported** by searching on GitHub under
   [Issues](https://github.com/openspp/documentation/issues).
diff --git a/docs/community/support.md b/docs/community/support.md
@@ -2,7 +2,7 @@
 review-status: needs-review
 review-date: 2025-06-04
 reviewer: migration-script
-migration-notes: "hidden for now. need to confirm if this is to be displayed"
+migration-notes: "hidden for now. for batch 2 documentation
 ---
 
 # Support Model
diff --git a/docs/developer_guide/setup.md b/docs/developer_guide/setup.md
@@ -9,7 +9,7 @@ migration-notes: "Added during 2025 documentation reorganization"
 
 ## OpenSPP Docker Setup Using Doodba
 
-This technique utilizes Docker, simplifying the installation of Odoo and its dependencies, with the added benefits offered by Doodba.
+Docker simplifies the installation of Odoo and its dependencies, with the added benefits offered by Doodba.
 
 ### Prerequisites
 
diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md
@@ -11,6 +11,9 @@ migration-notes: "Added during 2025 documentation reorganization"
 
 This overview of how OpenSPP's documentation is organized will help you know where to look for certain things:
 
+
+- {doc}`installation_deb` offers a detailed, step-by-step guide for installing OpenSPP using Debian-based packages. It covers system requirements, installation procedures, initial configuration, and troubleshooting tips to ensure a smooth setup process.
+- {doc}`module_installation` offers a comprehensive, step-by-step guide for configuring OpenSPP after the initial installation. It explains how to install additional modules, customize features, and optimize your setup for specific needs.
 - {doc}`../overview/index` provides high-level information about OpenSPP's features, concepts, and use cases for decision makers and new users.
 - {doc}`../user_guide/index` provides practical, task-oriented instructions for using OpenSPP's features in day-to-day operations for administrators and end-users.
 - {doc}`../developer_guide/index` provides technical information and instructions for developers who need to customize, extend, integrate with, or contribute to OpenSPP.
diff --git a/docs/index.md b/docs/index.md
@@ -15,7 +15,7 @@ OpenSPP was created to support the improvement and growth of effective social pr
 
 OpenSPP is an open-source, modular and highly interoperable platform. The platform offers four main products: SP-MIS - a comprehensive management information system - plus a Social Registry, a Farmer Registry and a Disability Registry.
 
-OpenSPP is a Digital Public Good. It is built on more than 60 open-source modules, and leverages and contributes to other open-source projects including OpenG2P, MOSIP, OpenCRVS, Odoo, Payment Hub EE, ID PASS, CommCare, Metabase and OpenFn
+OpenSPP is a Digital Public Good. It is built on more than 60 open-source modules, and leverages and contributes to other open-source projects including OpenG2P, MOSIP, OpenCRVS, Odoo, Payment Hub EE, ID PASS, CommCare, Metabase and OpenFn.
 
 ## SP-MIS
 
@@ -31,10 +31,6 @@ The Social Registry is a repository for the storage and management of data for p
 
 The Farmer Registry stores and manages farm holding and farm owner data, supporting coordination between the social and agricultural sectors. It supports mass registrations and regular updates, and integrates data from Geographic Information Systems, national ID and CRVS.
 
-## Disability Registry
-
-The Disability Registry is an organized database for systematically recording and managing information about individuals with disabilities within a specific population or geographic area. It contains important information to facilitate services and assistance for people with disabilities, including access to social protection programs. **OpenSPP is set to release its open-source Disability Registry in the second quarter of 2024**.
-
 ## Guiding principles
 
 Our guiding principles are informed by the Digital Public Goods Standard and the Principles for Digital Development.
@@ -53,8 +49,8 @@ OpenSPP is currently in development, and everything is evolving rapidly thanks t
 :maxdepth: 3
 :hidden: true
 
-overview/index
 getting_started/index
+overview/index
 user_guide/index
 developer_guide/index
 reference/index
diff --git a/docs/user_guide/administration/import_areas.md b/docs/user_guide/administration/import_areas.md
@@ -23,7 +23,7 @@ By the end of this tutorial, you should understand the purpose and process of pr
 
 ## Process
 
-To access the area import feature, you must log in to OpenSPP with a user account with the **System Admin** role since the functionality is not included for other roles. Learn how to set up roles and accounts in [Administrating role-based access](https://docs.openspp.org/tutorial/user_guides/administrating_role_based_access.html).
+To access the area import feature, you must log in to OpenSPP with a user account with the **System Admin** role since the functionality is not included for other roles. Learn how to set up roles and accounts in {doc}`user_access`
 
 ### Understand the Data Structure
 
diff --git a/docs/user_guide/pos_usage.md b/docs/user_guide/pos_usage.md
@@ -16,8 +16,8 @@ To utilise this feature, you need the following:
 - Make sure that both modules **OpenSPP POS: ID Redemption** and **OpenSPP POS** are installed and activated.
 - Have existing individual records in your registry, either by creating records manually or importing records into OpenSPP.
 - Have an access role either as **Operations Admin** or **POS operator** to perform tasks in the POS Application.
-- Have an access role as an **Operations Admin** or **Administrator** to perform tasks in OpenSPP. Learn more about this in the guide [Administrating role-based access](https://docs.openspp.org/tutorial/user_guides/administrating_role_based_access.html)
-- Have an existing cycle with beneficiaries and entitlements generated on a program. Learn more about this in the guide. [Create a social protection program](https://docs.openspp.org/tutorial/user_guides/create_social_protection_program.html)
+- Have an access role as an **Operations Admin** or **Administrator** to perform tasks in OpenSPP. Learn more about this in the guide {doc}`administration/user_access`
+- Have an existing cycle with beneficiaries and entitlements generated on a program. Learn more about this in the guide {doc}`program_management/create_program`
 
 ## Objective
 
@@ -87,7 +87,7 @@ You may now select the new Cash payment method for a Point of sale. Navigate to
 
 #### Group Point of sales by area
 
-In order to group Point of sales by area, make sure you have areas already existing in your OpenSPP instance. Learn more about importing areas in the guide [Import area](https://docs.openspp.org/tutorial/user_guides/import_areas.html). From the sidebar, navigate to **Point of Sale**, select **Configuration** and click **Point of Sales**. Select the Point of sale you wish to manage and assign by clicking an area from the dropdown **Area**.
+In order to group Point of sales by area, make sure you have areas already existing in your OpenSPP instance. Learn more about importing areas in the guide {doc}`administration/import_areas`. From the sidebar, navigate to **Point of Sale**, select **Configuration** and click **Point of Sales**. Select the Point of sale you wish to manage and assign by clicking an area from the dropdown **Area**.
 
 ![](point_of_sales/point_of_sales_select_area.png)
 
diff --git a/docs/user_guide/program_management/configure_entitlements.md b/docs/user_guide/program_management/configure_entitlements.md
@@ -11,24 +11,16 @@ This tutorial describes the steps of configuring cash entitlements when selected
 
 ## Prerequisites
 
-- Have an access role as an **Operations Admin** or **Administrator**. Learn more about this in the guide [Administrating role-based access](https://docs.openspp.org/tutorial/user_guides/administrating_role_based_access.html#)
+- Have an access role as an **Operations Admin** or **Administrator**. Learn more about this in the guide {doc}`../administration/user_access`
 - Install and activate the module: **OpenSPP Cash Entitlement** on your OpenSPP instance as **Administrator**.
-- Create a Program or have an already existing program. Learn more about this in the guide [Create a social protection program](https://docs.openspp.org/tutorial/user_guides/create_social_protection_program.html)
+- Create a Program or have an already existing program. Learn more about this in the guide {doc}`create_program`.
 
 ## Objective
 
 After completing this guide, you will be able to learn how to configure cash entitlements and edit existing cash entitlement configuration.
 
 ## Process
 
-### Verify installed module
-
-To be able to configure cash entitlements, you have to make sure the necessary module is installed and activated on your OpenSPP instance, you can verify this by logging in to your OpenSPP instance as Administrator, go to **Apps** and search for **OpenSPP Cash Entitlement**.
-
-![](configure_cash_entitlements/1.png)
-
-After successfully activating, the **Activate** button should disappear and it should display **Learn more** as the remaining button.
-
 ### Configure the Entitlement Manager
 
 It is possible to configure cash entitlements either during creation of the program or after, both options are explained below.
diff --git a/docs/user_guide/program_management/create_cycle.md b/docs/user_guide/program_management/create_cycle.md
@@ -87,13 +87,13 @@ A popup should appear. Make the necessary changes and then click **Save**.
 
 ![](create_program_cycle_prepare_entitlements/12.png)
 
-See Tutorial - [Configure cash entitlements](https://docs.openspp.org/tutorial/user_guides/configure_cash_entitlements.html) to learn more on configuring cash entitlements.
+See Tutorial {doc}`configure_entitlements` to learn more on configuring cash entitlements.
 
 Please note that changes you made into the following fields are only applied to newly prepared entitlements.
 
 ### Creating Cycle
 
-A cycle can only be created under a program. If you do not have any existing programs yet, you may refer to this document [Create a social protection program](https://docs.openspp.org/tutorial/user_guides/create_social_protection_program.html).
+A cycle can only be created under a program. If you do not have any existing programs yet, you may refer to this document {doc}`create_program`.
 
 Select an existing program from the program table list. You will be directed to the screen below. Click **Create New Cycle** to generate a cycle for the program.
 
@@ -157,7 +157,7 @@ Please note that enabling Auto-approve entitlements in the program’s **Cycle m
 
 ![](create_program_cycle_prepare_entitlements/25.png)
 
-If entitlements were not auto approved successfully. It could be that the [Allocate funds](https://docs.openspp.org/tutorial/user_guides/allocate_funds.html) for the program are insufficient or missing. See the documentation Allocate funds for more details.
+If entitlements were not auto approved successfully. It could be that the funds for the program are insufficient or missing. See the documentation {doc}`allocate_funds` for more details.
 
 ### Approving Entitlements
 
diff --git a/docs/user_guide/registry_management/import_export_registrant_data.md b/docs/user_guide/registry_management/import_export_registrant_data.md
@@ -121,7 +121,7 @@ OpenSPP displays different types of error messages on the import page when encou
 
 #### Error: "No matching records found"
 
-Some fields require values that are predefined in OpenSPP, such as the **category\_id** field. Setting a value in this column that does not match the values found in OpenSPP will return an error message. This error will be similar to the screenshot provided below.  
+Some fields require values that are predefined in OpenSPP, such as the **category_id** field. Setting a value in this column that does not match the values found in OpenSPP will return an error message. This error will be similar to the screenshot provided below.  
 ![](import_export_registrant_data/import_users_errors_found.png)
 
 To resolve this type of error, only type in values that are defined in OpenSPP, in this case for **category_id**, you can navigate to **Registry**, then click **Configuration**, and after that, select **Registrant Tags**. You should see the list of the defined **Tags**. You may use any of the listed values for **category_id**, or alternatively, add a new registrant tag.
