Skip to content

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

New issue
New issue
Closed
Closed
Edit content field and remove type field from yml credit files#2775
Labels
Complexity: SmallTake this type of issues after the successful merge of your second good first issueP-Feature: Credithttps://www.hackforla.org/credits/epicrole: front endTasks for front end developerssize: 2ptCan be done in 7-12 hoursstatus: UpdatedNo blockers and update is ready for review
Milestone
y. Excellent level
@SAUMILDHANKAR

Description

@SAUMILDHANKAR
SAUMILDHANKAR
opened on Feb 13, 2022

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Complexity: SmallTake this type of issues after the successful merge of your second good first issueP-Feature: Credithttps://www.hackforla.org/credits/epicrole: front endTasks for front end developerssize: 2ptCan be done in 7-12 hoursstatus: UpdatedNo blockers and update is ready for review

    Type

    No type

    Projects

    P: HfLA Website: Project Board

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions