website icon indicating copy to clipboard operation
website copied to clipboard

Published 20 hours ago • verified publisher icon hackforla

Edit content field and remove type field from yml credit files

Open SAUMILDHANKAR opened this issue 3 years ago • 7 comments

Dependency

  • [x] #2633
  • [x] #2791
  • [x] #2792
  • [x] #2793
  • [x] #2794
  • [x] #2795
  • [x] #2796
  • [x] #2797
  • [x] #2798
  • [x] #2799
  • [x] #2800
  • [x] #2804
  • [x] #2810
  • [x] #2805
  • [x] #2806
  • [x] #2811
  • [x] #2808
  • [x] #2807
  • [x] #2816
  • [x] #2812
  • [x] #2820
  • [x] #2813
  • [x] #2815
  • [x] #2809
  • [x] #2817
  • [x] #2818
  • [x] #2814
  • [x] #2821
  • [x] #2822
  • [ ] #2823
  • [x] #2824
  • [x] #2825
  • [x] #2830
  • [x] #2831
  • [x] #2826
  • [x] #2827
  • [x] #2829
  • [x] #2828
  • [x] #2832
  • [ ] #2833
  • [x] #2834
  • [x] #2836
  • [x] #2842
  • [ ] #2843
  • [x] #2844
  • [x] #2845
  • [x] #2846
  • [x] #2847
  • [ ] #2848
  • [ ] #2849
  • [x] #2850
  • [ ] #2851
  • [ ] #2852
  • [ ] #2853
  • [ ] #2855
  • [ ] #2856
  • [x] #2876
  • [x] #2877
  • [ ] #2860
  • [ ] #2873
  • [ ] #2874
  • [x] #2875
  • [ ] #2857
  • [ ] #2858
  • [ ] #2859
  • [x] #2878
  • [ ] #2863
  • [ ] #2864
  • [ ] #2865
  • [ ] #2861
  • [ ] #2866
  • [ ] #2867
  • [ ] #2868
  • [ ] #2869
  • [ ] #2870
  • [ ] #2871

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

  • [x] 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 avatar Feb 13 '22 08:02 SAUMILDHANKAR

Hi @SAUMILDHANKAR.

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:

github-actions[bot] avatar Feb 13 '22 08:02 github-actions[bot]

All the issues for this epic have been written and prioritized.

JessicaLucindaCheng avatar Mar 19 '22 04:03 JessicaLucindaCheng

  • Progress: All the issues have been written but now I need to add a dependency to all the issues.
  • Blockers: Still a little confused as to what to do with this epic, especially with additional action items.
  • Availability: Not sure.
  • ETA: Tue, April 12, 2022

JessicaLucindaCheng avatar Apr 01 '22 22:04 JessicaLucindaCheng

@SAUMILDHANKAR, @JessicaLucindaCheng

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, April 12, 2022 at 12:20 AM PST.

github-actions[bot] avatar Apr 15 '22 07:04 github-actions[bot]

Progress: All the issues have been written and prioritized but now I need to add a release dependency to all the issues. Blockers: None Availability: 6 hours ETA: Tue, April 19, 2022

JessicaLucindaCheng avatar Apr 16 '22 20:04 JessicaLucindaCheng

Progress: All the issues have been written and prioritized but now I need to add a release dependency to all the issues. I have added release dependency to some of the issues already but just need to finish the rest. Blockers: None Availability: 6 hours ETA: Sun, May 1, 2022

JessicaLucindaCheng avatar Apr 24 '22 15:04 JessicaLucindaCheng

Progress: All the issues have been written and prioritized and a release dependency Action Item has been added to all the issues. All the issues are now ready to be worked on. Blockers: None Availability: 6 hours ETA: Wed, May 4, 2022

JessicaLucindaCheng avatar May 05 '22 01:05 JessicaLucindaCheng

Moving to New Issue Approval since all dependencies have been satisfied

jdingeman avatar Apr 12 '23 01:04 jdingeman

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

jdingeman avatar Apr 13 '23 23:04 jdingeman