rodekruis / IBF-system

Tools required to trigger, manage and execute the Red Cross Early Action Protocols for natural disasters.
https://ibf.510.global
Apache License 2.0
12 stars 15 forks source link

[Task] Rethink how we update layer and indicator popup text #1566

Open gulfaraz opened 1 week ago

gulfaraz commented 1 week ago

Who is your contact person for this task?

@gulfaraz

User Story

The workflow to update layer and indicator popup involves multiple files - an excel file, a json for indicators, and a json for layers.

The intention behind this workflow is that design and data will own and can change the copy on IBF. As per the instructions in the README, the ownership of maintaining these files fall on the devs.

To allow this conversion between xlsx and json files, there are two scripts - _add-info-popup-xlsx-columns.js and _convert-layer-info-popup-xlsx-to-json.js. Which also need to be maintained by devs.

As a dev I would like to reduce the number of files to own and maintain.

### **What needs to be done**
- [ ] Evaluate the existing setup - we ignored the workflow in this issue https://github.com/rodekruis/Anticipatory-Action/issues/644
- [ ] If we decide to continue using the existing setup - then update the [excel file](https://github.com/rodekruis/IBF-system/blob/9d52bfe02a687165e73fddc4b68aab343cb89792/services/API-service/src/scripts/json/layer-popup-info.xlsx) to avoid the present discrepancies introduced in PRs https://github.com/rodekruis/IBF-system/pull/1561 https://github.com/rodekruis/IBF-system/pull/1563 https://github.com/rodekruis/IBF-system/pull/1562
- [ ] if we decide to remove the xlsx workflow - then remove excel file, [_add-info-popup-xlsx-columns.js](https://github.com/rodekruis/IBF-system/blob/9d52bfe02a687165e73fddc4b68aab343cb89792/services/API-service/src/scripts/json/_add-info-popup-xlsx-columns.js) and [_convert-layer-info-popup-xlsx-to-json.js](https://github.com/rodekruis/IBF-system/blob/9d52bfe02a687165e73fddc4b68aab343cb89792/services/API-service/src/scripts/json/_convert-layer-info-popup-xlsx-to-json.js)
### **Acceptance Criteria**
- [ ] Decision is documented 
- [ ] Follow-up actions are taken

Additional context

This issue is created as a result of a discussion in IBF Dev Chat between @jannisvisser and @gulfaraz which concluded with,

To avoid the discrepancy between excel and json, let's use the json until we find a process that works.