Skip to content

Migrate Wins Data: Create both AF and KVF data structure #2145

@Aveline-art

Description

@Aveline-art

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 than our current one. For this issue, we will create a new file with a more specific format for our repo in preparation for a data migration. This issue is part of a series that aims to migrate us to the more specific format.

Action Items

  • Read the resources/instructions below to understand your task.
  • Ask the project director for permissions to view the apps script.
  • Learn how the apps script generate the AF file in our code base.
  • Have the code generate the KVF version in addition to the AF version. (if possible!)
    • To follow best data practices, in this KVF version, make sure that only data that is used is generated. If any data is not needed, do not include that data.
  • Write instructions in this issue on how to clean up the code to stop generating the AF version.
  • As part of the PR for this issue, change the current KVF file to the newly generated KVF file.
  • Release dependency on Migrate Wins Data: Migrating from AF to KVF data structure #2146

Resources/Instructions

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 1.

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions