hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
300 stars 750 forks source link

Google Apps Script: Migrate Wins Data - Stop generation of AF file #2147

Open Aveline-art opened 3 years ago

Aveline-art commented 3 years ago

Dependency

Overview

As a developer, to turn the wins card into a reusable component, we must first be able to generate a wins-data.json file of a more specific format. This issue is part of a series that aims to migrate us to the more specific format.

Action Items

Resources/Instructions

wins-page

KVF = is an array of objects AF = is an array of arrays

Currently we have two json files for wins: _wins-data.json and wins-data.json. The former will henceforth be called KVF (for key-value file) and AF (for array file). AF is generated daily from a script on google while KVF appears to be an older, dysfunc version. The format in the KVF version, however, is much friendlier to formatting in liquid syntax. Therefore, we need to incrementally port our codebase to use the KVF version of the data and remove the AF version we currently use. This will be done in multiple steps:

  1. Have the apps script generate both AF and KVF version.
  2. Migrate all uses of AF to KVF.
  3. Have the apps script stop generating the AF version.
  4. Delete the AF version from our repo since it is now unused.

For this issue, we are doing step 3. [^1]:Wins Apps Script Development Guide - see draft

github-actions[bot] commented 1 year ago

Hi @roslynwythe, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

roslynwythe commented 1 year ago

i. Availability - 6 to midnight 11/2, 10 am - 2 pm and 4-7 pm on 11/3 ii. ETA EOD 11/3 (assuming I am granted access to the Google Apps Scripts on 11/2)

roslynwythe commented 1 year ago
roslynwythe commented 8 months ago

This issue should be rewritten with instructions regarding the new development strategy, similar to #4035. The code change is simple but the setup and testing process is much more complex so I advise this should be Complexity: Medium