website
website copied to clipboard
Edit content field and remove type field from idea.yml credits file
Prerequisite
- Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page.
- Please make sure you have read our Hack for LA Contributing Guide before you claim/start working on an issue.
Overview
As a developer, I want to edit the content field and remove the type field from a credit's yml file so that redundant code is removed and the code is easier to understand.
Details
Currently, in each credit's yml file, there is a content
field and a type
field, which contains similar information. Since the fields are redundant, we decided to remove the type
field.
Also, we changed the content
field to the content-type
field to make it clearer what its purpose is. The possible values for content-type
field are image, video, or audio; other types of content can be added if necessary. In the future, this will allow developers a way to differentiate easily between different types of content in order to show each credit's media file correctly on the website.
Action Items
For the file _data/internal/credits/idea.yml
, do the following:
- [ ] Change line 5 for the content field from
tocontent: icon
content-type: image
- [ ] Remove line 12 for the type field
type: icon
- [ ] Once the pull request associated with this issue is approved and merged, please update and edit epic #2775 by
- [ ] Checking off the dependency for this issue
- [ ] If all dependencies are checked off, please move issue #2775 to the New Issue Approval column and remove the Dependency label
Resources/Instructions
- This issue is tracked in the epic #2775.
File and Code links you will need to work on this issue
-
Directory to find the page in once you have it in your IDE:
_data/internal/credits/idea.yml
-
Click on the links below to see the source file code: https://github.com/hackforla/website/blob/7164ec247825adca279d4fd99fa52895335badbb/_data/internal/credits/idea.yml#L5 https://github.com/hackforla/website/blob/7164ec247825adca279d4fd99fa52895335badbb/_data/internal/credits/idea.yml#L12
Hi @tamara-snyder.
Good job adding the required labels for this issue. The merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.
Additional Resources:
Hi @Skydodle, 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 :)
ETA: end of day on 10/22 availability: Fri to Sat, will try to finish this on Wed 10/19 if not then latest 10/22 EOD