website Enhance GHA: Update VMRS data to fetch required data

Dependency

[x] #7524

Overview

We are currently storing excess data in vrms_data.json. We need to store only necessary data to make the website work. See Resources/Instructions for required data.

Details

Currently, all data fetched from the VRMS API is being saved. This means we are exposing unnecessary information to end users. We should only update required information and delete everything else in order to ensure data privacy, protection & security. Required data under resources

Action Items

[x] Read and understand Hack for LA's GitHub Actions Architecture wiki
[x] Create a new folder in github-actions/trigger-schedule named vrms-data
- [x] In that new folder create a new file named filter-vrms-data.js
[x] Write the code required to filter the vrms data & save it to _data/external/vrms_data.json
[ ] Integrate the new file with the "Update VMRS data" workflow triggered by .github/workflows/vrms-data.yml
[ ] Test the workflow in your repo and demonstrate that your solution works.
[ ] Test that all pages that rely on vrms_data.json are unchanged

Resources/Instructions

This issue was initiated by #6145
Hack for LAs GitHub Actions
Required data specified in this issue: https://github.com/hackforla/website/issues/7524
Pages that use vrms_data.json
- https://www.hackforla.org/projects/311-data (any project page like this) has event data
- https://www.hackforla.org/events/ has event data
- https://www.hackforla.org/project-meetings
Files used by "Update VMRS data" workflow"
- vrms-data.yml
- vrms_data.json

Sep 27 '24 04:09 FamousHero

@FamousHero What is missing from this is the instruction to test the pages that the data appears on

Pages project data event data appears on
- https://www.hackforla.org/projects/311-data (any project page like this) has event data
- https://www.hackforla.org/events/ has event data
- https://www.hackforla.org/project-meetings

Sep 27 '24 21:09 ExperimentsInHonesty

Hi @FamousHero, 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 :)

Sep 27 '24 21:09 HackforLABot

@bonniewolfe Added an extra test to check that site is unchanged afterwards & linked the related pages in Resources/Instructions

Sep 28 '24 02:09 FamousHero

@t-will-gillis will look at the method you are using and approve or give notes

Sep 29 '24 18:09 ExperimentsInHonesty

Hey @FamousHero Thanks for taking care of this- this is looking great so far. Here are a couple of notes/suggestions/discussion topics:

I feel that this should be bumped up from size: 2pt- I think it’s at least a size: 5pt job. Thoughts?
The “Overview” ends with ‘…See’- was there something additional here?
I would consider being more direct about this being a GitHub Actions issue, for example adding “GHA” to the title, something like: 'Refactor GHA “Update VRMS data” to fetch required data'
In the “Action Items”, I agree with each of the steps and the file structure you want created.
I think it would be good to consider starting the “Action Items” by having the dev refer to the Hack for LA’s GitHub Actions for guidance from the start. The reason for this is that although there are many workable ways to write the code, I think we want to nudge the dev into using a similar framework as we use in all of our other GHAs (that is Hack for LA’s “GitHub Actions Architecture” as the document states) because this makes our lives easier when reviewing, editing, troubleshooting, etc.
I might reorder the bullet points and place the ‘…“Update VRMS data” workflow’ as the first point, but if you keep the order, I would still note that the workflow is triggered from the vrms-data.yml file, and that the .yml is calling the filter-vrms-data.js file.
One other thing, I like to give the links within the text for the files to be worked, i.e. vrms-data.yml Some others like to use footnotes and put the links in the “Resources/Instructions”.

Hope this is useful. Let me know if you would like to discuss anything

Sep 30 '24 03:09 t-will-gillis

Hi @t-will-gillis, I agree with all the notes give and have included them in the ER. Please feel free to let me know if I left anything out or if there's any other change you'd like.

Oct 03 '24 23:10 FamousHero

Hi @FamousHero Great- thanks for making the changes.

Oct 04 '24 04:10 t-will-gillis

Hi @santisecco, 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 :)

May 06 '25 20:05 HackforLABot

i. Availability: Tuesdays & Friday-Sunday ii. ETA: 3-4 weeks

May 06 '25 20:05 santiseccovidal

@santisecco

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.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "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 Questions/In Review column of the Project Board 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. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, May 13, 2025 at 12:05 AM PST.}

May 16 '25 07:05 HackforLABot

Investigating the use of VRMS across the codebase. This is important to understand how filtering the data can affect the different components of the website and our workflows.

May 16 '25 19:05 santiseccovidal

Keys used from the vrms-data.json file:

name
date
startTime
endTime
projectStatus
project.name
project.githubIdentifier
project.location
project.githubUrl
project.slackUrl
project.googleDriveUrl
createdDate
hflaWebsiteUrl
description

May 22 '25 22:05 santiseccovidal

So to recognize which parts of the website's information come from the Markdown or vrms-data.json I've analyzed several files. This is not very clear to me. I'm working on it. For example toolkit.js seems to use data from vrms but it doesn't, it uses data that comes from the Markdowns like tdm-calculator.md

Edit: this is a fundamental read that should have been posted in the issue's resources https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture

May 23 '25 18:05 santiseccovidal

Related issue. https://github.com/hackforla/website/issues/7524#event-17083151254