Identify which pages call Tools data from each project

[Sebster3]

Overview

To ensure consistency with surrounding data, we need to update the formatting of tools in each project's frontmatter to a YAML array. To safely propagate this change, we must identify which pages reference the tools frontmatter data in each project's markdown file in the _projects folder.

Details

We're going to format the tools data like the technologies data, so that we can reuse some existing code. To do this safely, we need to identify which files need updating.

Action Items

• Observe the existing syntax of the front matter block inside many of the markdown files in the _projects folder and find the tools variable. As an example, access-the-data.md includes tools in its frontmatter.
• Identify which pages make a reference to, or otherwise query, the tools data stored in the project files, and then trace to the base file with the logic for displaying the data. Examples include but are not limited to:
  • Projects Page and related files:
    • current-projects.html
    • current-projects.js
  • Projects Check Page and related files
    • current-projects-check.html
    • current-projects-check.js
  • project.html page- used in individual project pages
• Document your findings in a Google Doc in the "HackForLA.org" Google Drive
  • Document how those pages and related file(s) make use of the tools data.
  • Document the effects to the current pages when the tools data is saved as a yml list, then
  • Document the necessary changes that must be made to each page and the related file(s) to ensure that the current implementation and rendering are not broken when the formatting of the data changes.
    This will require careful analysis of the current code which uses the tools data to ensure it does not break when provided an array of data instead of a single string.
  • Link the Doc in the Resources/Instructions section below.
• Discuss your findings with the dev lead(s) and PM(s).

For Merge Team/Tech Leads/PMs:

• When this issue is complete, release the dependency on Create new issues to refactor each page & files using Tools data #4776, move that issue from "Ice Box" to "New Issue Approval", and add ready for dev lead label.

Resources/Instructions

• Markdown Frontmatter
• Project files: _projects
• Add link here to the document identifying each page that: uses the Tools data, and what changes need to be made

[github-actions]

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

[ronaldpaek]

i. Availability: 6/11 - 6/13
ii. ETA: Not sure when I will finish, am I never done a task this big, 6/13, if not hopefully the next week will check in and ask for help if I run any blockers

[github-actions]

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

[ronaldpaek]

1. 6/13/23
2. 6/13/23

Hello I am not sure how to proceed, I made a google docs, but not 100% if I wrote this correctly and not sure how to upload it to hack4la google drive and where to place it.

https://docs.google.com/document/d/1IEazMdDmDd86SUoQEBduKCsfOgUBnEZQKOM_ZPBnrCI/edit?usp=sharing

[github-actions]

Hi @t-will-gillis, 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 :)

[ronaldpaek]

@t-will-gillis tagging you, please let me know what I should do, I wasn't sure how to create a PR for this

[t-will-gillis]

Hey @ronaldpaek - your report looks great! It identifies:

• the 17 +/- markdown files in the /_projects/ folder that include the tools data,
• the proposed refactoring of the code in the project.html file to use the newly formatted tools,
• the proposed refactoring of the code in the current-projects.js file to use the newly formatted tools, and
• the proposed refactoring of the code in the current-projects-check.js file to use the newly formatted tools.

I am closing this issue as completed, and releasing the dependency on the next issue. Thank you for your work on this issue!