docs(config_guide): add area management, GIS, and hazard management guides#134
docs(config_guide): add area management, GIS, and hazard management guides#134emjay0921 wants to merge 2 commits intov2-in-progress-3from
Conversation
…configuration guides
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for Area Management, GIS Configuration, and Hazard Management. The feedback highlights a terminology mismatch in hazard severity levels and inconsistent field labels for area names. It also provides suggestions for clarifying HDX dataset identifiers and fixing grammatical errors.
| | **Damage Level Threshold** | Minimum damage for eligibility: Any, Moderate+, Severe+, Critical | | ||
| | **Emergency Mode** | Enable relaxed compliance (e.g., skip training attendance) | | ||
|
|
||
| ### Damage thresholds | ||
|
|
||
| | Threshold | Who qualifies | | ||
| |-----------|--------------| | ||
| | **Any** | All registrants with any recorded impact | | ||
| | **Moderate+** | Registrants with moderate, severe, or critical damage | | ||
| | **Severe+** | Only registrants with severe or critical damage | | ||
| | **Critical** | Only registrants with critical-level damage | |
There was a problem hiding this comment.
There is a significant terminology mismatch between this guide and the overview.md file regarding hazard severity and damage levels. The overview.md (Line 81) defines the severity scale as Minor, Moderate, Severe, Major, Catastrophic. However, this guide uses Moderate+, Severe+, and Critical as thresholds. Specifically, 'Critical' is not defined in the overview, while 'Major' and 'Catastrophic' are missing here. This inconsistency will confuse implementers setting up eligibility rules.
|
|
||
| | Field | What it means | | ||
| |-------|---------------| | ||
| | **Draft Name** | Display name (translatable) | |
There was a problem hiding this comment.
The field label Draft Name appears inconsistent with the rest of the documentation, which typically uses Name (e.g., line 92 in this file, and lines 71, 81 in hdx_integration.md). If the UI label is simply 'Name', please update this table. If 'Draft Name' is the actual UI label, it would be helpful to clarify its purpose compared to a standard name field.
|
|
||
| **Where do I find the HDX Dataset ID?** | ||
|
|
||
| Go to [data.humdata.org](https://data.humdata.org), search for your country + "administrative boundaries", and look for datasets tagged "cod-ab". The dataset ID is in the URL. |
There was a problem hiding this comment.
Clarifying that the HDX Dataset ID is the slug at the end of the URL would be very helpful for implementers to identify the correct value.
| Go to [data.humdata.org](https://data.humdata.org), search for your country + "administrative boundaries", and look for datasets tagged "cod-ab". The dataset ID is in the URL. | |
| Go to [data.humdata.org](https://data.humdata.org), search for your country + "administrative boundaries", and look for datasets tagged "cod-ab". The dataset ID is the slug at the end of the URL (e.g., philippines-administrative-levels-0-3). |
|
|
||
| **Can I link a program to multiple incidents?** | ||
|
|
||
| Currently, one program links to one incident. For multi-incident response, create separate programs or use a broader eligibility criteria. |
There was a problem hiding this comment.
Grammar issue: 'a broader eligibility criteria' should be 'broader eligibility criteria' or 'a broader eligibility criterion', as 'criteria' is the plural form of 'criterion'.
| Currently, one program links to one incident. For multi-incident response, create separate programs or use a broader eligibility criteria. | |
| Currently, one program links to one incident. For multi-incident response, create separate programs or use broader eligibility criteria. |
…d names - Fix severity levels: Level 3 is "Significant" (not "Severe"), Level 4 is "Severe" (not "Major") to match actual code - Fix damage threshold labels to match actual selection values: "Any Damage Level", "Moderate and Above", "Severe and Above", "Critical/Totally Damaged Only"
|
1 participant
Why is this change needed?
Adds configuration guides for geographic and spatial features: area management, GIS, and hazard management.
How was the change implemented?
config_guide/area_management/(index.md, overview.md, hdx_integration.md) — hierarchy, types, HDX COD setupconfig_guide/gis/(index.md, overview.md, data_layers.md, report_templates.md) — color schemes, data layers, reportsconfig_guide/hazard_management/(index.md, overview.md, program_linking.md) — categories, incidents, program linkingRelated links
https://projects.acn.fr/projects/acn-eng/work_packages/827