-
-
Notifications
You must be signed in to change notification settings - Fork 847
Closed
Labels
Complexity: LargeFeature: Refactor JS / LiquidPage is working fine - JS / Liquid needs changes to become consistent with other pagesPage is working fine - JS / Liquid needs changes to become consistent with other pagesp-feature: Projects-checkWe use this page to check to make sure that teams are using the Technology section correctlyWe use this page to check to make sure that teams are using the Technology section correctlyrole: back end/devOpsTasks for back-end developersTasks for back-end developersrole: front endTasks for front end developersTasks for front end developerssize: 2ptCan be done in 7-12 hoursCan be done in 7-12 hoursstatus: UpdatedNo blockers and update is ready for reviewNo blockers and update is ready for reviewtime sensitiveNeeds to be worked on by a particular timeframeNeeds to be worked on by a particular timeframe
Milestone
Description
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
_projectsfolder and find thetoolsvariable. As an example, access-the-data.md includestoolsin its frontmatter. - Identify which pages make a reference to, or otherwise query, the
toolsdata 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:
- Projects Check Page and related files
- 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
toolsdata. - Document the effects to the current pages when the
toolsdata 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 thetoolsdata 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.
- Document how those pages and related file(s) make use of the
- 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 leadlabel.
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Complexity: LargeFeature: Refactor JS / LiquidPage is working fine - JS / Liquid needs changes to become consistent with other pagesPage is working fine - JS / Liquid needs changes to become consistent with other pagesp-feature: Projects-checkWe use this page to check to make sure that teams are using the Technology section correctlyWe use this page to check to make sure that teams are using the Technology section correctlyrole: back end/devOpsTasks for back-end developersTasks for back-end developersrole: front endTasks for front end developersTasks for front end developerssize: 2ptCan be done in 7-12 hoursCan be done in 7-12 hoursstatus: UpdatedNo blockers and update is ready for reviewNo blockers and update is ready for reviewtime sensitiveNeeds to be worked on by a particular timeframeNeeds to be worked on by a particular timeframe
Type
Projects
Status
Done