Merge pull request #65 from OpenSPP/various-fixes-in-docs-edwin

Various fixes in docs edwin

Author: gonzalesedwin1123

docs/community/contributing.md

@@ -160,7 +160,6 @@ Python 3.10 should be used to build the documentation. You can install it using
 following the instructions on the [pyenv GitHub page](https://github.com/pyenv/pyenv).
 
 ```bash
-cd docs
 pip install -r requirements.txt
 make html
 ```
@@ -205,6 +204,7 @@ To make it easier for other contributors to work with your project, update the f
 Commit and push your changes to a remote, and submit a pull request against [`openspp/documentation`](https://github.com/openspp/documentation/compare).
 
 (authors-guide-label)=
+-->
 
 # Authors guide
 
@@ -221,9 +221,10 @@ Use `sphinx-autobuild` to view changes in the browser while you edit documentati
 make livehtml
 ```
 
-You can open a browser at http://127.0.0.1:8000/ to preview the documentation.
+You can open a browser at http://127.0.0.1:8050/ to preview the documentation.
 
 
+<!-- Commented this section out, this whole commented section is all from the old documentation version. unless there are relevant information 
 (authors-quality-checks-label)=
 
 ## Quality checks

docs/community/index.md

@@ -13,7 +13,6 @@ This section contains information about the OpenSPP project, community interacti
 - {doc}`code_of_conduct`
 - {doc}`license`
 - {doc}`security_reporting`
-- {doc}`support`
 - {doc}`release_management`
 - {doc}`module_lifecycle_development_status`
 - {doc}`module_lifecycle_maintainer_role`
@@ -27,7 +26,6 @@ contributing
 code_of_conduct
 license
 security_reporting
-support
 release_management
 module_lifecycle_development_status
 module_lifecycle_maintainer_role

docs/community/module_lifecycle_development_status.rst

@@ -1,16 +1,7 @@
----
-review-status: needs-review
-review-date: 2025-06-04
-reviewer: migration-script
-migration-notes: "Added during 2025 documentation reorganization"
----
-
 *****************************************************
 Modules Maturity Levels and Development Status Policy
 *****************************************************
 
-Introduction
-============
 The requirements to merge code into OpenSPP projects depend on the module's
 maturity level.
 

docs/community/module_lifecycle_maintainer_role.rst

@@ -1,17 +1,7 @@
----
-review-status: needs-review
-review-date: 2025-06-04
-reviewer: migration-script
-migration-notes: "Added during 2025 documentation reorganization"
----
-
 *****************************************
 Module Lifecycle - Maintainer Role Policy
 *****************************************
 
-
-Introduction
-============
 A Maintainer is responsible to ensure the coordination of specific addon
 modules in order to ensure the quality and consistency of the
 contributions. For a particular repository, this could be one, a few, or

docs/developer_guide/developer_mode.md

@@ -35,8 +35,6 @@ Additional modes are available for developers: `?debug=assets` enables the [asse
 
 ## Locate the developer mode tools
 
----
-
 The user can access the developer mode tools by clicking on the _Open Developer Tools_ button or the bug icon located in the OpenSPP header, after activating developer mode.
 
 ![OpenSPP displays the console page and the debug icon.](developer_mode/3.png "Overview of a console page and the debug icon being shown in Odoo.")

docs/developer_guide/module_development/areas.md

@@ -57,12 +57,12 @@ A working sample module for the described scenario can be accessed at the provid
 
 The key steps in module development are as follows:
 
-### Step 1: Create the Module Scaffold
+### Create the Module Scaffold
 
 Start by creating a new directory for your module (e.g., `spp_custom_area`) and populate it
 with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
 
-### Step 2: Define Module Manifest
+### Define Module Manifest
 
 Create a manifest file that includes the proper dependencies and data files:
 
@@ -89,7 +89,7 @@ Create a manifest file that includes the proper dependencies and data files:
 }
 ```
 
-### Step 3: Extend the Area Model
+### Extend the Area Model
 
 Create a Python file named `area.py` that extends the `spp.area` model and add it to `models/__init__.py`:
 
@@ -119,7 +119,7 @@ class SPPArea(models.Model):
     ], string="Population Source", default="census")
 ```
 
-### Step 4: Create View Extensions
+### Create View Extensions
 
 Create a new file called `views/area_views.xml` in the module and add it to the manifest file:
 
@@ -179,7 +179,7 @@ Create a new file called `views/area_views.xml` in the module and add it to the
 </odoo>
 ```
 
-### Step 5: Add Security Access (Optional)
+### Add Security Access (Optional)
 
 If you introduce new models, add access rights. For simple field additions, this is not required. Example:
 
@@ -192,7 +192,7 @@ access_spp_your_custom_model_admin,spp.your.custom.model.admin,spp_area_custom.m
 - **`g2p_registry_base.group_g2p_registrar`** for Registrar Access
 - **`g2p_registry_base.group_g2p_admin`** for Admin Access.
 
-### Step 6: Add Custom Area Types (Optional)
+### Add Custom Area Types (Optional)
 
 Create `data/area_kind_data.xml` to add custom area types:
 
@@ -206,7 +206,7 @@ Create `data/area_kind_data.xml` to add custom area types:
 </odoo>
 ```
 
-### Step 7: Adding Computed Fields, Constrains, and Validations (Optional)
+### Adding Computed Fields, Constrains, and Validations (Optional)
 
 On your `models/area.py` you can add computed fields, constrains, and validations:
 
@@ -249,7 +249,7 @@ from odoo.exceptions import ValidationError
 ```
 Then add the custom computed field to the `area_views.xml` file
 
-### Step 8: Install and Test
+### Install and Test
 
 1. Install or upgrade the module through the Apps menu.
 2. Test the new fields in the area forms and lists
@@ -262,5 +262,4 @@ The following screenshot shows the added population fields in the newly develope
 
 For more information on extending OpenSPP modules, refer to:
 - [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
-- [OpenSPP Documentation](https://docs.openspp.org/)
 - [Area Management Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_area_base)

docs/developer_guide/module_development/audit.md

@@ -54,12 +54,12 @@ In this example, we customize the audit rule to include an `active` flag, allowi
 
 A working sample module is available at [this link](https://github.com/OpenSPP/documentation_code/tree/main/howto/developer_guides/customizations/spp_audit_log_custom).
 
-### Step 1: Create the Module Scaffold
+### Create the Module Scaffold
 
 Start by creating a new directory for your module (e.g., `spp_audit_log_custom`) and populate it
 with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
 
-### Step 2: Define Module Manifest
+### Define Module Manifest
 
 Create a manifest file with the correct dependencies and data files:
 
@@ -87,7 +87,7 @@ Create a manifest file with the correct dependencies and data files:
 }
 ```
 
-### Step 3: Extend the Audit Rule Model
+### Extend the Audit Rule Model
 
 Create `models/spp_audit_rule.py` and update `models/__init__.py`:
 
@@ -103,7 +103,7 @@ class CustomAuditRule(models.Model):
     )
 ```
 
-### Step 4: Create View Extensions
+### Create View Extensions
 
 Create `views/spp_audit_rule_views.xml` and add it to the manifest:
 
@@ -122,7 +122,7 @@ Create `views/spp_audit_rule_views.xml` and add it to the manifest:
 </odoo>
 ```
 
-### Step 5: Add Security Access (Optional)
+### Add Security Access (Optional)
 
 If you introduce new models, add access rights. For simple field additions, this is not required. Example:
 
@@ -134,7 +134,7 @@ access_custom_spp_audit_rule,custom.spp.audit.rule,spp_audit_log.model_spp_audit
 - Group ID: **`g2p_registry_base.group_g2p_registrar`** for Registrar Access
 - Group ID: **`g2p_registry_base.group_g2p_admin`** for Admin Access.
 
-### Step 6: Add Preconfigured Rules (Optional)
+### Add Preconfigured Rules (Optional)
 
 Seed rules using `data/audit_rule_data.xml` and the `spp.audit.rule.create_rules` helper:
 
@@ -153,7 +153,7 @@ Seed rules using `data/audit_rule_data.xml` and the `spp.audit.rule.create_rules
 
 For parent/child rules (requires `spp_audit_post`), also pass `parent_rule_name` and `connecting_field_name`.
 
-### Step 7: Install and Test
+### Install and Test
 
 1. Install or upgrade the module through the Apps menu.
 2. Create or update records in the configured models (e.g., Individual or Group Registry).
@@ -169,7 +169,6 @@ For parent/child rules (requires `spp_audit_post`), also pass `parent_rule_name`
 
 For more information on extending OpenSPP modules, refer to:
 - [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
-- [OpenSPP Documentation](https://docs.openspp.org/)
 - Audit module sources:
   - [`spp_audit_log`](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_audit_log)
   - [`spp_audit_post`](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_audit_post)

docs/developer_guide/module_development/change_requests.md

@@ -55,12 +55,12 @@ spp_change_request_add_children_demo/
 
 ## Step-by-Step Guide
 
-### Step 1: Create the Module Scaffold
+### Create the Module Scaffold
 
 Start by creating a new directory for your module (e.g., `spp_change_request_custom_type`) and populate it
 with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
 
-### Step 2: Define the Manifest (`__manifest__.py`)
+### Define the Manifest (`__manifest__.py`)
 
 The manifest file declares your module's metadata and dependencies. It's crucial to list all the modules your
 CR type will interact with. For our "Add Child/Member" example, the dependencies are:
@@ -97,7 +97,7 @@ CR type will interact with. For our "Add Child/Member" example, the dependencies
 
 Your dependencies will vary based on the data you need to access and modify.
 
-### Step 3: Create the Change Request Models
+### Create the Change Request Models
 
 This is the heart of your module. You'll create a new model that holds the specific data for your change
 request type.
@@ -220,7 +220,7 @@ request type.
             return selection
     ```
 
-### Step 4: Create the User Interface (Views)
+### Create the User Interface (Views)
 
 Define the form view for your custom CR type.
 
@@ -310,7 +310,7 @@ Define the form view for your custom CR type.
         sequence="10"/>
     ```
 
-### Step 5: Define Data Files
+### Define Data Files
 
 Use XML data files to configure aspects of your CR type.
 
@@ -358,7 +358,7 @@ Use XML data files to configure aspects of your CR type.
   </odoo>
   ```
 
-### Step 6: Set Up Security
+### Set Up Security
 
 Grant users access to your new model in security/ir.model.access.csv. At a minimum, you need to provide access
 to the base user group.
@@ -369,7 +369,7 @@ id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
 access_spp_change_request_add_children_user,spp.change.request.add.children.user,model_spp_change_request_add_children,base.group_user,1,1,1,1
 ```
 
-### Step 7: Install and Test
+### Install and Test
 
 1. Install or upgrade the module through the Apps menu.
 2. Create a new change request.
@@ -383,6 +383,5 @@ Always start with a clear definition of the data you need to collect and the sys
 
 For more information on extending OpenSPP modules, refer to:
 - [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
-- [OpenSPP Documentation](https://docs.openspp.org/)
 - [Change Request Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_change_request)
 - [OpenSPP Change Request Demo: Add Child/Member Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_change_request_add_children_demo)

docs/developer_guide/module_development/cycles.md

@@ -51,11 +51,11 @@ spp_cycle_manager_fixed_interval/
 
 ## Step-by-Step Guide
 
-### Step 1: Create the Module Scaffold
+### Create the Module Scaffold
 
 Start by creating a new directory for your module (e.g., `spp_cycle_manager_fixed_interval`) and populate it with the basic Odoo module files and the directory structure shown above.
 
-### Step 2: Define the Manifest (`__manifest__.py`)
+### Define the Manifest (`__manifest__.py`)
 
 The manifest file declares your module's metadata and dependencies. Our cycle manager depends on `g2p_programs` and `spp_programs` for the base manager framework.
 
@@ -84,7 +84,7 @@ The manifest file declares your module's metadata and dependencies. Our cycle ma
 }
 ```
 
-### Step 3: Create the Cycle Manager Model
+### Create the Cycle Manager Model
 
 This is the core of your module. You will create a new model that inherits from the default cycle manager and overrides its behavior.
 
@@ -110,7 +110,7 @@ This is the core of your module. You will create a new model that inherits from
             return start_date + relativedelta(months=6, days=-1)
     ```
 
-### Step 4: Register the New Manager
+### Register the New Manager
 
 To make OpenSPP aware of your new manager, you must add it to the list of available cycle managers.
 
@@ -133,7 +133,7 @@ To make OpenSPP aware of your new manager, you must add it to the list of availa
             return selection
     ```
 
-### Step 5: Create the User Interface
+### Create the User Interface
 
 Create a form view for your manager. Since we are inheriting from the default manager, we can also inherit its view and modify it to hide the fields that are no longer relevant (like the recurrence rules).
 
@@ -159,7 +159,7 @@ Create a form view for your manager. Since we are inheriting from the default ma
 </record>
 ```
 
-### Step 6: Extend the Program Creation Wizard
+### Extend the Program Creation Wizard
 
 To improve user experience, add a selection to the "Create Program" wizard so users can choose your new manager from the start.
 
@@ -245,7 +245,7 @@ To improve user experience, add a selection to the "Create Program" wizard so us
     </record>
     ```
 
-### Step 7: Set Up Security
+### Set Up Security
 
 Grant users access to your new model in `security/ir.model.access.csv`.
 
@@ -256,7 +256,7 @@ g2p_cycle_manager_fixed_interval_admin,Cycle Manager Fixed Interval Admin Access
 g2p_cycle_manager_fixed_interval_program_manager,Cycle Manager Fixed Interval Program Manager Access,spp_cycle_manager_fixed_interval.model_g2p_cycle_manager_fixed_interval,g2p_programs.g2p_program_manager,1,1,1,0
 ```
 
-### Step 8: Install and Test
+### Install and Test
 
 1.  Install or upgrade the module through the Apps menu.
 2.  Navigate to **Programs** and click **Create Program**.
@@ -268,5 +268,4 @@ g2p_cycle_manager_fixed_interval_program_manager,Cycle Manager Fixed Interval Pr
 
 For more information on extending OpenSPP modules, refer to:
 - [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
-- [OpenSPP Documentation](https://docs.openspp.org/)
 - [OpenSPP Programs Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_programs)