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.

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

Update toolkit yml files to include a new fields #3431

Merged

Conversation

tunglinn
Copy link
Member

@tunglinn tunglinn commented Jul 27, 2022

Fixes #3357

What changes did you make and why did you make them ?

In all the files in /_guide-pages and in the file /_data/internal/toolkitresources.yml

  • changed category to practice-area, provider-link to resource-url provider-link is now three different fields depending on the state of the guide-page: resource-url-completed, resource-url-wip, resource-url-depreciated
  • added tools, contributors, recommended-by
  • deleted short-description, link-svg (this also required some changes in /pages/toolkit.html)
  • for _guide-pages, changed status to work in progress, completed, or depreciated

In /_includes/guide-card.html

  • changed logic for displaying guide cards links
  • changed "coming soon" to "work in progress", "work in progress" will be linked to resource-url-wip
  • added logic to display description only if it's less than 210 characters, otherwise it'll display short description

In /pages/toolkit.html

  • removed external-resource-container (otherwise the external resource cards would be centered, take a look at this comment)

In /_sass/components/_toolkit.scss

  • deleted external-resource-container
  • changed grid-template-columns for {bp-below-desktop} so that it'll display 2 cards max and not be centered if there's only 1 card
  • consolidated the duplicate classes of .resource-svg-icon and .toolkit-info-container

Overall, changes were made to add/update card fields and make sure the website does not change unless specified.
For the field information, check this comment and others in the issue.

The wiki templates can be found under File Templates in the Wiki.

Purpose is to implement new design/features for the Toolkit page.

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

Visuals before changes are applied

image

Visuals after changes are applied

image

@github-actions
Copy link

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b tunglinn-update-toolkit-yml-3357 gh-pages
git pull https://github.com/tunglinn/website.git update-toolkit-yml-3357

@github-actions github-actions bot added P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours Complexity: Medium Status: Updated No blockers and update is ready for review labels Jul 27, 2022
@Zak234 Zak234 self-requested a review July 27, 2022 02:17
@Zak234 Zak234 requested a review from poorvi4 July 27, 2022 02:21
@poorvi4
Copy link
Member

poorvi4 commented Jul 27, 2022

Availability: 7/28-7/30
ETA: 6 hours

@Zak234
Copy link
Contributor

Zak234 commented Jul 27, 2022

ETA:7/27
Availability: Anytime

@Zak234
Copy link
Contributor

Zak234 commented Jul 28, 2022

I seem to be having some issues with VS Code which will delay my review.

@arpitapandya arpitapandya self-requested a review July 28, 2022 20:40
@arpitapandya
Copy link
Member

Availability: 6 Hours
ETA: EOD 2022-07-29

Copy link
Contributor

@Zak234 Zak234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be a problem with the text formatting in the Toolkit. Kathryn, Sarah, Arpita and I all tested it and got the same result. This is what it looked like:
Screen Shot 2022-07-29 at 4 28 39 AM
Screen Shot 2022-07-29 at 4 29 04 AM
I believe the issue may be due to the changes in _toolkit.scss.

This reverts commit that fixes lint error by deleting the lines that
caused errors.
@tunglinn
Copy link
Member Author

Reverted the last commit. The branch should look normal now. I'll have to fix the lint errors, but don't know how without causing those weird formatting issue.

@poorvi4
Copy link
Member

poorvi4 commented Jul 31, 2022

Yup, the text formatting looks normal now. Can't say much on how to resolve the lint issues as I'm not too familiar with it.

Zak234
Zak234 previously requested changes Aug 1, 2022
Copy link
Contributor

@Zak234 Zak234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be another problem. When testing for tablets, the toolkit looks like this which I do not believe is desirable. I'm not sure what is causing the linter issue either, so I'll see if I can find someone who will help.
Screen Shot 2022-08-01 at 2 02 55 PM

@tunglinn
Copy link
Member Author

tunglinn commented Aug 2, 2022

@Zak234 How do you test for other types (i.e. tablet, phone, etc)?

@Zak234
Copy link
Contributor

Zak234 commented Aug 3, 2022

Right click the page and click inspect. Then in the inspect window click the toggle device toolbar button, it looks like this:
Screen Shot 2022-08-03 at 11 52 11 AM
and is in the top left corner of the inspect screen. Then go to the new toolbar and click dimensions. There should be a dropdown menu with a bunch of different device's screen dimensions. We usually use IPhone 12 for mobile and Ipad mini for tablet.

@tunglinn
Copy link
Member Author

tunglinn commented Aug 4, 2022

I might have to ask the design team how they want the tablet "External Resources" title to be formatted because right now, it is the same as guides.

Like this

image

The changes I made makes External Resources filterable by practice areas (Development, Design, etc). If there's only 1 resource, you get there undesirable formatting.
The current site doesn't filter for External Resources, so all three were being shown on each practice area tab which never causes the odd formatting.

@Zak234
Copy link
Contributor

Zak234 commented Aug 5, 2022

I'm not sure exactly what is causing the issue. I think it may just be due to there only being one project card as opposed to two under the External Resources which messes with the spacing. I'm pretty sure this is the case as when put into mobile view, which only has one project card under External Resources, the HFLA site has the same weird formatting.

@tunglinn
Copy link
Member Author

tunglinn commented Aug 9, 2022

Talked to Bonnie. The Guides and External Resources heading on tablet should not be centered. I will adjust the code for that.

More additions to this issue will be discussed on Friday at Guides meeting and commented in #3357.

Copy link
Member

@blulady blulady left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Tung!!
I sat down and looked at the linter issues and it looks like the linter is angry about some duplicative code in _sass/components/_toolkit.scss. Particularly .resource-svg-icons which is defined on line 83, 168, and 188. It is also upset about .toolkit-info-container defined on line 89, 101, and 193. The last one it is complaining about is h3 on lines 93 and 194.

@arpitapandya arpitapandya removed their request for review August 13, 2022 21:54
@tunglinn
Copy link
Member Author

I'll be MIA for the next 3 days, picked up some extra shifts. I'll add the additional functionalities and fix the lint issues on Monday.

@tunglinn
Copy link
Member Author

I've updated the first pull request comment to reflect the new changes. Pushed new commits, will fix lint issues after.

@tunglinn tunglinn requested review from blulady and Zak234 August 23, 2022 23:16
blulady
blulady previously approved these changes Aug 24, 2022
Copy link
Member

@blulady blulady left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request comes from the correct branch and goes into the correct branch. It has a linked issue that the PR addresses. In all of the _guide-pages and the toolkitresources.yml: the category has been changed to practice area and the following fields have been created tools, contributors, source, recommended-by, changed status to work in progress/resource-url-wip/resource-url-completed. Changed Guide pages' status to work in progress/completed/depreciated.
In guid-card.html changed logic for displaying guide card links, Changed Guide pages with status of coming soon to work in progress. Added logic to display description only if it's less than 210 characters, otherwise it'll display short description.
In toolkit.html the external-resource-container was deleted and the cards are not centered.
In _toolkit.scss that container was also removed and changed to display 2 cards max and not be centered. I did notice in Nest Hub Max view that there were three but it still looked good. And the classes of .resource-svg-icon and .toolkit-info-container were consolidated.
The toolkit yml files have been updated to include new fields like the linked issue wanted and the Toolkit files template reflects those changes.
In the browser it looks good and previous issues have been resolved.
Good Job!!

@kathrynsilvaconway kathrynsilvaconway self-requested a review August 28, 2022 03:40
@kathrynsilvaconway
Copy link
Member

ETA: End of Day on 8/31
Availability: 2 Hours

Copy link
Member

@kathrynsilvaconway kathrynsilvaconway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tunglinn Great work on this rather involved issue. All of your changes look good. The only issue I have is this stray line of code I'm seeing locally at the bottom of the toolkit page. If you remove that, we'll get it merged right away. Thanks for all your hard work on this one.

image

@tunglinn
Copy link
Member Author

tunglinn commented Aug 30, 2022

@kathrynsilvaconway I don't see this visual when I run the branch locally. I'll be at tonight's meeting to hopefully resolve this with you.

@arpitapandya
Copy link
Member

ETA: EOD 2022-09-05
Availability: 6hrs

@arpitapandya arpitapandya self-requested a review September 6, 2022 02:56
Copy link
Member

@arpitapandya arpitapandya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tunglinn If you check in _pages/toolkit.html. Comment out first the Line 57, 58, 88, 120, 123, 152 and then delete them (coming from because the linter was angry earlier and has left effect. Will help to resolve the conflicts you're having as @kathrynsilvaconway mentioned. It will help to get the PR merged as you did such a great job and changes are correct!!

PS: you won't see these lines because linter won't allow to add them on GitHub, but they're when you open the text-editor and so do on website.

@tunglinn
Copy link
Member Author

tunglinn commented Sep 6, 2022

I fixed the merge conflict, which was due to a recent refactoring of the toolkit.html file.

@arpitapandya I fixed the Lint issue before and the check is successful. Which Lint issue were you referring to?

@arpitapandya
Copy link
Member

arpitapandya commented Sep 6, 2022

I fixed the merge conflict, which was due to a recent refactoring of the toolkit.html file.

@arpitapandya I fixed the Lint issue before and the check is successful. Which Lint issue were you referring to?

When I picked up this PR to review there was a merge conflict in toolkit.html, and I found there was the lines of which @kathrynsilvaconway mentioned with the red markers. I think those were because of few lines were overwritten because somebody might have worked on the same file. I was seeing 143 lines of code in that file when I was reviewing but now that you just pushed commit, Everything seems to be fixed and there's 91 lines of code in toolkit.html. I also don't see the console error with .js which I was seeing earlier. Everything looks clean now and doesn't break anything now so I would approve this.

Copy link
Member

@kathrynsilvaconway kathrynsilvaconway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @tunglinn !

@kathrynsilvaconway kathrynsilvaconway dismissed Zak234’s stale review September 9, 2022 00:43

Dismissing this review in order to get this PR merged. All changes look good and issues have been addressed.

@kathrynsilvaconway kathrynsilvaconway merged commit 4655bf1 into hackforla:gh-pages Sep 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours Status: Updated No blockers and update is ready for review
Projects
Development

Successfully merging this pull request may close these issues.

Update toolkit yml files to include a new fields
6 participants