hackforla / website

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

Use VRMS data to update the meeting times on the CoP page #7072

Open del9ra opened 2 weeks ago

del9ra commented 2 weeks ago

Overview

We need to automate the update of meeting times on the Communities of Practice page [^1] in a similar way as we do on the Events [^2] and individual project pages using VRMS data. Currently each CoP project is manually updated in the yml files under _data/internal/communities ^3.

Action Items

Resources/Instructions

[^1]: Communities of Practice (CoP) page [^2]: Events page

github-actions[bot] commented 2 weeks ago

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

t-will-gillis commented 2 weeks ago

Hi @del9ra - looks good!

Here are some things you might consider:

In most locations, you are using backticks around files and directories (e.g., communities-of-practice.js). I think this looks good and it would be good to continue doing that for _data/internal/communities in “Overview” and assets/js/utility/vrms-events.js and communities-of-practice.html in “Actions Items”. For the bullet “Take a look at this code…”, for consistency you could reference assets/js/project.js[^6] and then footnote the link. For consistency, in places where a full path link is shown it might be better to show the shortened path- for example you could display Footnote 5 in the same way as Footnote 3.

In the “Overview”, the way the that the CoP meeting times need to be updated won’t match exactly the “Events” page, and in the “Action Items” you refer to each project’s page using VRMS data. I think it would be clearer to say that we need to automate the times “…in a similar way as we do on the Events and individual project pages using VRMS data.” Also, on the last sentence you could say that “Currently, each CoP project is manually updated…”

Since you mention the “Events” page in the “Overview”, for one of the “Action Items” bullets it would make sense to reference how the files for the “Events” page extract and use data from vrms_data.json. (maybe combined into the second bullet ?) Finally, in “Resources/Instructions”, there should be a reference back to the ER or Epic that prompted this one.

Thanks for taking this on!

roslynwythe commented 2 weeks ago

Hi @del9ra - thank you for writing this issue. Here are a few comments:

del9ra commented 2 weeks ago

Hi @del9ra - thank you for writing this issue. Here are a few comments:

  • Remove the label "Issue Making: Level 2" since this isssue does not create issues.
  • Remove the label "size: 0.5 pt" and add a label with a larger size. I usually specifiy 2 pt for large issues
  • under Resources/Instructions, on the line that specifies the issue number of the ER, please add a "-" at the beginning of the line; then GitHub will generate a nice link with the issue title
  • In the ER, please add a reference to this issue
  • @t-will-gillis @ExperimentsInHonesty Should add an Action Item to remove the meeting-times key value pair from the CoP yml files to avoid redundant data?
  • @t-will-gillis @ExperimentsInHonesty In terms of formatting, should we specify that the resulting CoP page should maintain the same appearance/formatting?

Thank you for your feedback and thorough review! I’ve implemented the changes you suggested.

ExperimentsInHonesty commented 2 weeks ago

Current state

https://www.hackforla.org/events/ 7:00 pm - 8:00 pm Community of Practice: Data Science All 7:00 pm - 8:00 pm 311 Data All

https://www.hackforla.org/communities-of-practice Data Science CoP shows Meeting Times: Mondays 7:00-8:00 pm PT

https://www.hackforla.org/projects/311-data Wed 7:00 pm - 8:00 pm All

Future state for the CoP page

Meeting Times: Mondays 7:00 pm - 8:00 pm PT

roslynwythe commented 1 week ago

@delaradaryaei please note Bonnie's comment above detailing the desired appearance for the meeting times on the CoP page. Also please add an Action Item to remove the meeting-times key from the CoP yml files.

del9ra commented 1 week ago

@delaradaryaei please note Bonnie's comment above detailing the desired appearance for the meeting times on the CoP page. Also please add an Action Item to remove the meeting-times key from the CoP yml files.

I don't see the difference between the current state and the future state for the CoP page. Could you please specify the difference? The only difference I see is the way we retrieve meeting times: either from YAML files or from VRMS data. I added a new Action Item as you said.