Skip to content

docs(spp_farmer_registry_demo,spp_mis_demo_v2): sync descriptions with code #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emjay0921 wants to merge 5 commits into
base: 19.0
Choose a base branch
from
+987 −492
Open

docs(spp_farmer_registry_demo,spp_mis_demo_v2): sync descriptions with code #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
70fc379
docs(spp_farmer_registry_demo,spp_mis_demo_v2): sync descriptions wit…
emjay0921 Mar 23, 2026
ae5a754
docs(spp_farmer_registry_demo,spp_mis_demo_v2): add generated READMEs
emjay0921 Mar 23, 2026
f2baecc
docs(spp_case_demo,spp_grm_demo): sync descriptions with code
emjay0921 Mar 23, 2026
911d085
docs(spp_case_demo,spp_grm_demo): add generated READMEs
emjay0921 Mar 23, 2026
e7a23dd
docs(spp_mis_demo_v2): remove stale README.md, fix USE_CASES.md
emjay0921 Mar 23, 2026
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
42 changes: 25 additions & 17 deletions spp_case_demo/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

=================================
OpenSPP Case Management Demo Data
=================================

..
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:83c38ef565ee03dd1e3a2d245f7e6fd1be8908369371180c89a39e3f7948ae36
!! source digest: sha256:291fcbc81ab3ed04474dce0f58442d85243a386f198970d0993de7e77d96f6f8
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
Expand All @@ -24,16 +28,20 @@ OpenSPP Case Management Demo Data

Demo data generator for Case Management system. Creates realistic cases
with intervention plans, home visits, progress notes, and service
referrals. Includes 9 fixed demo stories for training and sales demos,
plus configurable random case generation for volume testing.
referrals. Includes 9 fixed demo stories plus 3 background cases for
training and sales demos, and configurable volume case generation using
Faker for locale-aware random data (non-deterministic — each run
produces different results).

Key Capabilities
~~~~~~~~~~~~~~~~

- Generate 9 fixed demo stories with predictable personas and case
progressions for consistent training scenarios
- Create random volume cases with configurable distribution percentages
for plans, visits, notes, and closures
progressions for consistent training scenarios, plus 3 background
cases (Fernandez Intake Pending, Johnson Assessment, Kim Case Closed)
for variety
- Create random volume cases using Faker (non-seeded) with configurable
distribution percentages for plans, visits, notes, and closures
- Link generated cases to existing registrants or create standalone
cases
- Backdate case records and related activities to simulate realistic
Expand All @@ -50,15 +58,15 @@ Key Capabilities
Key Models
~~~~~~~~~~

+-----------------------------+----------------------------------------+
| Model | Description |
+=============================+========================================+
| ``spp.case.demo.generator`` | Core logic for configuring and |
| | generating demo data |
+-----------------------------+----------------------------------------+
| ``spp.case.demo.wizard`` | Wizard interface for demo data |
| | generation (inherits generator) |
+-----------------------------+----------------------------------------+
+-----------------------------+---------------------------------------+
| Model | Description |
+=============================+=======================================+
| ``spp.case.demo.generator`` | Core logic for configuring and |
| | generating demo data |
+-----------------------------+---------------------------------------+
| ``spp.case.demo.wizard`` | Wizard interface for demo data |
| | generation (inherits generator) |
+-----------------------------+---------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down Expand Up @@ -165,4 +173,4 @@ Current maintainers:

This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_case_demo>`_ project on GitHub.

You are welcome to contribute.
You are welcome to contribute.
6 changes: 3 additions & 3 deletions spp_case_demo/readme/DESCRIPTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Demo data generator for Case Management system. Creates realistic cases with intervention plans, home visits, progress notes, and service referrals. Includes 9 fixed demo stories for training and sales demos, plus configurable random case generation for volume testing.
Demo data generator for Case Management system. Creates realistic cases with intervention plans, home visits, progress notes, and service referrals. Includes 9 fixed demo stories plus 3 background cases for training and sales demos, and configurable volume case generation using Faker for locale-aware random data (non-deterministic — each run produces different results).

### Key Capabilities

- Generate 9 fixed demo stories with predictable personas and case progressions for consistent training scenarios
- Create random volume cases with configurable distribution percentages for plans, visits, notes, and closures
- Generate 9 fixed demo stories with predictable personas and case progressions for consistent training scenarios, plus 3 background cases (Fernandez Intake Pending, Johnson Assessment, Kim Case Closed) for variety
- Create random volume cases using Faker (non-seeded) with configurable distribution percentages for plans, visits, notes, and closures
- Link generated cases to existing registrants or create standalone cases
- Backdate case records and related activities to simulate realistic timelines over configurable day ranges
- Create intervention plans with multiple interventions across case lifecycle stages
Expand Down
54 changes: 32 additions & 22 deletions spp_case_demo/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>OpenSPP Case Management Demo Data</title>
<title>README.rst</title>
<style type="text/css">

/*
Expand Down Expand Up @@ -360,27 +360,36 @@
</style>
</head>
<body>
<div class="document" id="openspp-case-management-demo-data">
<h1 class="title">OpenSPP Case Management Demo Data</h1>
<div class="document">


<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
</a>
<div class="section" id="openspp-case-management-demo-data">
<h1>OpenSPP Case Management Demo Data</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:83c38ef565ee03dd1e3a2d245f7e6fd1be8908369371180c89a39e3f7948ae36
!! source digest: sha256:291fcbc81ab3ed04474dce0f58442d85243a386f198970d0993de7e77d96f6f8
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_case_demo"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
<p>Demo data generator for Case Management system. Creates realistic cases
with intervention plans, home visits, progress notes, and service
referrals. Includes 9 fixed demo stories for training and sales demos,
plus configurable random case generation for volume testing.</p>
referrals. Includes 9 fixed demo stories plus 3 background cases for
training and sales demos, and configurable volume case generation using
Faker for locale-aware random data (non-deterministic — each run
produces different results).</p>
<div class="section" id="key-capabilities">
<h1>Key Capabilities</h1>
<h2>Key Capabilities</h2>
<ul class="simple">
<li>Generate 9 fixed demo stories with predictable personas and case
progressions for consistent training scenarios</li>
<li>Create random volume cases with configurable distribution percentages
for plans, visits, notes, and closures</li>
progressions for consistent training scenarios, plus 3 background
cases (Fernandez Intake Pending, Johnson Assessment, Kim Case Closed)
for variety</li>
<li>Create random volume cases using Faker (non-seeded) with configurable
distribution percentages for plans, visits, notes, and closures</li>
<li>Link generated cases to existing registrants or create standalone
cases</li>
<li>Backdate case records and related activities to simulate realistic
Expand All @@ -396,11 +405,11 @@ <h1>Key Capabilities</h1>
</ul>
</div>
<div class="section" id="key-models">
<h1>Key Models</h1>
<h2>Key Models</h2>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
<col width="43%" />
<col width="57%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Model</th>
Expand All @@ -420,7 +429,7 @@ <h1>Key Models</h1>
</table>
</div>
<div class="section" id="configuration">
<h1>Configuration</h1>
<h2>Configuration</h2>
<p>After installing:</p>
<ol class="arabic simple">
<li>Navigate to <strong>Case Management &gt; Configuration &gt; Generate Demo Data</strong></li>
Expand All @@ -440,14 +449,14 @@ <h1>Configuration</h1>
</ol>
</div>
<div class="section" id="ui-location">
<h1>UI Location</h1>
<h2>UI Location</h2>
<ul class="simple">
<li><strong>Menu</strong>: Case Management &gt; Configuration &gt; Generate Demo Data</li>
<li><strong>Generated Cases</strong>: View results in Case Management &gt; Cases</li>
</ul>
</div>
<div class="section" id="security">
<h1>Security</h1>
<h2>Security</h2>
<table border="1" class="docutils">
<colgroup>
<col width="68%" />
Expand All @@ -466,7 +475,7 @@ <h1>Security</h1>
</table>
</div>
<div class="section" id="demo-stories">
<h1>Demo Stories</h1>
<h2>Demo Stories</h2>
<p>When “Include Demo Stories” is enabled, generates 9 fixed personas:</p>
<ul class="simple">
<li><strong>Santos Family Support</strong>: Complete case lifecycle from intake to
Expand All @@ -489,7 +498,7 @@ <h1>Demo Stories</h1>
</ul>
</div>
<div class="section" id="dependencies">
<h1>Dependencies</h1>
<h2>Dependencies</h2>
<p><tt class="docutils literal">spp_demo</tt>, <tt class="docutils literal">spp_case_base</tt>, <tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">faker</tt> (Python)</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
Expand All @@ -503,23 +512,23 @@ <h1>Dependencies</h1>
</ul>
</div>
<div class="section" id="bug-tracker">
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_case_demo%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
<div class="section" id="authors">
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
<ul class="simple">
<li>OpenSPP.org</li>
</ul>
</div>
<div class="section" id="maintainers">
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
<p>Current maintainers:</p>
<p><a class="reference external image-reference" href="https://github.com/jeremi"><img alt="jeremi" src="https://github.com/jeremi.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/gonzalesedwin1123"><img alt="gonzalesedwin1123" src="https://github.com/gonzalesedwin1123.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/emjay0921"><img alt="emjay0921" src="https://github.com/emjay0921.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_case_demo">OpenSPP/OpenSPP2</a> project on GitHub.</p>
Expand All @@ -528,5 +537,6 @@ <h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
</div>
</div>
</div>
</div>
</body>
</html>
Loading
Loading