Skip to content

Commit 945ddee

Browse files
committed
Fixing some syntax
1 parent 2c4d179 commit 945ddee

6 files changed

Lines changed: 9 additions & 14 deletions

File tree

docs/developer_guide/api_usage/dci_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ myst:
99
# DCI API
1010

1111
OpenSPP provides a RESTful API that adheres to the Digital Convergence Initiative (DCI) specification.
12-
This API enables authorized external systems to securely search and synchronize with OpenSPP's registry data, promoting interoperability with other digital public infrastructure components like a Civil Registration and Vital Statistics (:term:`CRVS`) system.
12+
This API enables authorized external systems to securely search and synchronize with OpenSPP's registry data, promoting interoperability with other digital public infrastructure components like a Civil Registration and Vital Statistics ({term}`CRVS`) system.
1313

1414
## Prerequisites
1515

docs/developer_guide/integrations/dci.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ myst:
99
# Digital Convergence Initiative
1010

1111
In the rapidly evolving landscape of digital public infrastructure (DPI), the principle of interoperability stands as an important foundation for building efficient, inclusive, and sustainable systems in a country.
12-
This article delves into how OpenSPP implemented APIs outlined in the [DCI Interface Standards v1.0](https://standards.spdci.org/standards/standards-for-interoperability-interfaces/structure-and-versioning-of-the-standards) under Registry to enable interoperability with other systems such as :term:`CRVS`.
12+
This article delves into how OpenSPP implemented APIs outlined in the [DCI Interface Standards v1.0](https://standards.spdci.org/standards/standards-for-interoperability-interfaces/structure-and-versioning-of-the-standards) under Registry to enable interoperability with other systems such as {term}`CRVS`.
1313

1414
The implementation can be categorized into two sections where OpenSPP operates as the client and OpenSPP operates as the server.
1515
Note that currently OpenSPP has only completed the sync implementation.
1616

1717
## Server implementation
1818

19-
This section focuses on utilizing OpenSPP as the source of truth for :term:`beneficiary` information where OpenSPP acts as the server.
20-
Such integration allows OpenSPP to seamlessly interact with other critical systems by providing data, thereby enhancing data exchange and operational :term:`efficiency`.
19+
This section focuses on utilizing OpenSPP as the source of truth for {term}`beneficiary` information where OpenSPP acts as the server.
20+
Such integration allows OpenSPP to seamlessly interact with other critical systems by providing data, thereby enhancing data exchange and operational {term}`efficiency`.
2121
The following steps elaborate how the module can be configured.
2222

2323
### Deployment and installation
@@ -64,7 +64,7 @@ The following steps elaborate how the module can be configured.
6464

6565
This section focuses on utilizing another registry as the source for truth to get beneficiary information that can then be utilized in OpenSPP.
6666

67-
This section focuses on utilizing another registry as the source for truth to get :term:`beneficiary` information.
67+
This section focuses on utilizing another registry as the source for truth to get {term}`beneficiary` information.
6868
The following steps elaborate how the module can be configured to fetch data where OpenSPP acts as the client.
6969

7070
### 2.1 Deployment and Installation

docs/developer_guide/integrations/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Here, you will find detailed instructions and best practices for:
1818

1919
- {doc}`esignet`: Discover how to integrate eSignet as an identity provider, allowing users to authenticate into OpenSPP using their MOSIP-based digital identity.
2020

21-
- {doc}`oidc`: Follow our guide to configure Keycloak as an :term:`OIDC` provider for OpenSPP, enabling single sign-on (SSO) for a secure and streamlined user authentication experience.
21+
- {doc}`oidc`: Follow our guide to configure Keycloak as an {term}`OIDC` provider for OpenSPP, enabling single sign-on (SSO) for a secure and streamlined user authentication experience.
2222

2323
```{toctree}
2424
:maxdepth: 2

docs/developer_guide/integrations/oidc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To align with corporate branding, you can customize the login page by adding a c
6161

6262
### Existing users
6363

64-
For users that already existed before the :term:`OIDC`-integration was configured, there is a need for them to go through the reset password process.
64+
For users that already existed before the {term}`OIDC`-integration was configured, there is a need for them to go through the reset password process.
6565
This is because the password is not stored in Odoo, but in Keycloak.
6666
Depending on the configuration, the user may have to perform 2FA setup.
6767

docs/developer_guide/module_development/entitlements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ myst:
99
# Program entitlements
1010

1111
In OpenSPP, program benefits are defined and calculated through a flexible system called **Entitlement Managers**.
12-
An Entitlement Manager is a self-contained component that defines the logic for how much a :term:`beneficiary` is entitled to receive in a given program cycle.
12+
An Entitlement Manager is a self-contained component that defines the logic for how much a {term}`beneficiary` is entitled to receive in a given program cycle.
1313
This allows for creating reusable and complex benefit calculation rules that can be easily attached to any program.
1414

1515
This guide will walk you through creating a custom Entitlement Manager module from scratch.

docs/reference/modules/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11

2-
# OpenSPP modules index
3-
4-
```{warning}
5-
6-
**Work in Progress**: This document is actively being developed and updated. Content may be incomplete or subject to change.
7-
```
2+
# OpenSPP modules
83

94
## SPP modules
105

0 commit comments

Comments
 (0)