Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Edit content field and remove type field from yml credit files #2775

Closed
85 of 86 tasks
SAUMILDHANKAR opened this issue Feb 13, 2022 · 9 comments
Closed
85 of 86 tasks

Edit content field and remove type field from yml credit files #2775

SAUMILDHANKAR opened this issue Feb 13, 2022 · 9 comments
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue epic P-Feature: Credit https://www.hackforla.org/credits/ role: front end Tasks for front end developers size: 2pt Can be done in 7-12 hours Status: Updated No blockers and update is ready for review
Milestone
y. Excellent level

Comments

@SAUMILDHANKAR
Copy link
Member

SAUMILDHANKAR commented Feb 13, 2022 •
edited by jdingeman
Loading

Dependency

Overview

As a developer, I want to edit the content field and remove the type field from all the credits' yml files 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.

To incorporate this, the following will be implemented: the content field will be edited to content-type and the type field will be removed from each of the issues mentioned in the action items below. The issues will be created using the Credits file template: Edit content field and remove type field. Once the issue is created the information will be updated in the following Google Spreadsheet. Tech Leads will take a look at the issue before adding the ready for milestone label on each issue and the issue numbers to the Dependency section above.

The process for a developer to follow when writing an issue for this epic:

  • Locate the yml file in the credits directory website/_data/internal/credits
  • Change the content and type fields in the respective yml files

Action Items

  • Write issues and add to the Dependency section above. See instructions in Google Spreadsheet.
  • Once all the issues in the Dependency section are checked off and closed, use the search function in your IDE to check the following for the .yml files in _data/internal/credits:
    • There is no content: field in any of the .yml files in _data/internal/credits. (If you are using VSCode as your IDE, you can search for content: and restrict the search by filling in the "files to include" field with _data\internal\credits. Other IDEs may have similar search capabilities.)
      • If you find any content: fields in any of the .yml files in _data/internal/credits, list the .yml file(s) you found them in in a new comment below.
    • There is no type: field in any of the .yml files in _data/internal/credits. If you see any content-type: image in your search, that is okay.
      • If you find any type: fields in any of the .yml files in _data/internal/credits, list the .yml file(s) you found them in in a new comment below.
  • After you do the searches above,
    • If you find no content: nor type: fields in any of the .yml files in _data/internal/credits, then close this issue.
    • If you find any content: or type: fields in any of the .yml files in _data/internal/credits,
      • Then reach out to the merge team and technical leads with the list of .yml files that had content: or type: fields and ask them to help you write issues to fix what you found.

Resources/Instructions

Credits Page
Credits file template: Edit content field and remove type field
Google spreadsheet for tracking issue creation progress
Location of yml files in the credits directory website/_data/internal/credits
@SAUMILDHANKAR SAUMILDHANKAR added role: front end Tasks for front end developers Complexity: Large P-Feature: Credit https://www.hackforla.org/credits/ size: 13+pt Must be broken down into smaller issues epic labels Feb 13, 2022
@github-actions

This comment was marked as outdated.

Sign in to view
@SAUMILDHANKAR SAUMILDHANKAR mentioned this issue Feb 13, 2022
Open
17 tasks
@SAUMILDHANKAR SAUMILDHANKAR changed the title Standardize all yml files used on the credits page Optimize all yml files used on the credits page Feb 13, 2022
@JessicaLucindaCheng JessicaLucindaCheng mentioned this issue Feb 13, 2022
Open
@SAUMILDHANKAR SAUMILDHANKAR added this to the z. Excellent level milestone Feb 13, 2022
JessicaLucindaCheng added a commit that referenced this issue Feb 14, 2022
@JessicaLucindaCheng
Update Credits file template: Edit content field and remove type field
fcaf4ae 
Included this line in the template "This issue is tracked in the epic #2775."
@JessicaLucindaCheng JessicaLucindaCheng mentioned this issue Feb 14, 2022
Closed
6 tasks
@SAUMILDHANKAR SAUMILDHANKAR mentioned this issue Feb 16, 2022
Open
12 tasks
This was referenced Feb 19, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@JessicaLucindaCheng JessicaLucindaCheng mentioned this issue Feb 19, 2022
Closed
3 tasks
@github-actions github-actions bot added the 2 weeks inactive An issue that has not been updated by an assignee for two weeks label Apr 15, 2022
@SAUMILDHANKAR SAUMILDHANKAR added To Update ! No update has been provided and removed 2 weeks inactive An issue that has not been updated by an assignee for two weeks labels Apr 16, 2022
@JessicaLucindaCheng

This comment was marked as resolved.

Sign in to view
@JessicaLucindaCheng JessicaLucindaCheng added Status: Updated No blockers and update is ready for review Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 1pt Can be done in 4-6 hours size: 2pt Can be done in 7-12 hours and removed To Update ! No update has been provided Complexity: Large size: 13+pt Must be broken down into smaller issues size: 1pt Can be done in 4-6 hours labels Apr 19, 2022
@JessicaLucindaCheng

This comment was marked as outdated.

Sign in to view
@JessicaLucindaCheng

This comment was marked as outdated.

Sign in to view
@JessicaLucindaCheng JessicaLucindaCheng added the Dependency An issue is blocking the completion or starting of another issue label May 5, 2022
@clayton1111 clayton1111 mentioned this issue Jun 23, 2022
Closed
luiderek added a commit to luiderek/hfla-website that referenced this issue Nov 1, 2022
@luiderek
edit content field, removed type field from yml credits hackforla#2775
5b2c0d2
@luiderek luiderek mentioned this issue Nov 1, 2022
Closed
@Adastros Adastros mentioned this issue Dec 6, 2022
Closed
17 tasks
@jdingeman jdingeman added ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Dependency An issue is blocking the completion or starting of another issue labels Apr 12, 2023
@jdingeman
Copy link
Member

Moving to New Issue Approval since all dependencies have been satisfied

@jdingeman
Copy link
Member

Checked via VS code and can confirm there are no more content: or type: fields in _data/internal/credits

@jdingeman jdingeman removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue epic P-Feature: Credit https://www.hackforla.org/credits/ role: front end Tasks for front end developers size: 2pt Can be done in 7-12 hours Status: Updated No blockers and update is ready for review
Projects
P: HfLA Website: Project Board
Archived in project
Milestone
y. Excellent level
Development

Successfully merging a pull request may close this issue.

Changed from Content to Content-Type clayton1111/website
6 participants
@SAUMILDHANKAR @greylaw89 @JessicaLucindaCheng @ExperimentsInHonesty @jdingeman @Providence-o