Skip to content
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.

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

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

Closed
9 tasks done
Aveline-art opened this issue Aug 20, 2021 · 10 comments
Closed
9 tasks done

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

Aveline-art opened this issue Aug 20, 2021 · 10 comments
Assignees
Labels
Complexity: Large P-Feature: Wins Page https://www.hackforla.org/wins/ role: back end/devOps Tasks for back-end developers size: missing Status: Updated No blockers and update is ready for review

Comments

@Aveline-art
Copy link
Member

Aveline-art commented Aug 20, 2021

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.

@github-actions github-actions bot added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing labels Aug 20, 2021
@Aveline-art Aveline-art added P-Feature: Wins Page https://www.hackforla.org/wins/ role: back end/devOps Tasks for back-end developers Complexity: Large Dependency An issue is blocking the completion or starting of another issue Ready for Prioritization and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing Dependency An issue is blocking the completion or starting of another issue labels Aug 20, 2021
@Aveline-art Aveline-art changed the title Migrate Wins Data: Moving from AF to KVF data structure Migrate Wins Data: Create both AF and KVF data structure Aug 20, 2021
@Aveline-art Aveline-art added the time sensitive Needs to be worked on by a particular timeframe label Sep 1, 2021
@ExperimentsInHonesty
Copy link
Member

@Aveline-art Is this required in order for the page to show up on the new homepage design. If it is the milestone will be higher. please let me know and then re-add the ready for milestone label.

@Aveline-art
Copy link
Member Author

Aveline-art commented Sep 5, 2021

@ExperimentsInHonesty This is not required for the homepage redesign (HPR), technically. For the HPRe, I had made a new static file (this file is not updated in real time) with the correctly formatted data, so as long as the HPRe wins card do not need the latest wins updates, then we are good.

@Aveline-art Aveline-art added Ready for Prioritization and removed time sensitive Needs to be worked on by a particular timeframe labels Sep 5, 2021
@macho-catt macho-catt self-assigned this Sep 5, 2021
@macho-catt
Copy link
Member

macho-catt commented Sep 6, 2021

Progress: Got access to google app script
Blockers: N/A
Availability: 5 hours
ETA: 2 weeks
Pictures: N/A

@macho-catt
Copy link
Member

macho-catt commented Sep 9, 2021

Progress: I have a working prototype of creating a KVF from google app script and updating a github repo. This can be implemented pretty easily.

Blockers: How to implement our API key in Google App Script #1980

@github-actions github-actions bot added the Status: Updated No blockers and update is ready for review label Sep 10, 2021
@macho-catt
Copy link
Member

Same as last week.

Progress: I have a working prototype of creating a KVF from google app script and updating a github repo. This can be implemented pretty easily.

Blockers: How to implement our API key in Google App Script #1980. I have a demo tonight to present during the backend meeting.

@github-actions
Copy link

@macho-catt

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, September 21, 2021 at 12:02 AM PST.

@github-actions github-actions bot added To Update ! No update has been provided and removed Status: Updated No blockers and update is ready for review labels Sep 24, 2021
@macho-catt macho-catt removed the To Update ! No update has been provided label Sep 24, 2021
@macho-catt
Copy link
Member

Progress: I have a working prototype of creating a KVF from google app script and updating a github repo. This can be implemented pretty easily.

Blockers: Need to write documentation for #1980 then implement the change for token

@macho-catt
Copy link
Member

Blockers: Need to finish documentation for #1980, then transfer wins responses to admin drive

@github-actions github-actions bot added Status: Updated No blockers and update is ready for review and removed Status: Updated No blockers and update is ready for review labels Oct 1, 2021
@github-actions
Copy link

github-actions bot commented Oct 8, 2021

@macho-catt

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, October 5, 2021 at 12:02 AM PST.

@github-actions github-actions bot added the To Update ! No update has been provided label Oct 8, 2021
@macho-catt macho-catt added Status: Updated No blockers and update is ready for review and removed To Update ! No update has been provided labels Oct 8, 2021
@macho-catt
Copy link
Member

This is completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large P-Feature: Wins Page https://www.hackforla.org/wins/ role: back end/devOps Tasks for back-end developers size: missing Status: Updated No blockers and update is ready for review
Projects
Development

No branches or pull requests

4 participants