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

Refactor HTML and JavaScript so projects and projects-check pages can share the same files #4960

Closed
10 tasks done
Tracked by #4850 ...
roslynwythe opened this issue Jul 17, 2023 · 5 comments · Fixed by #5978
Closed
10 tasks done
Tracked by #4850 ...
Assignees
Labels
Complexity: Large Feature: Refactor HTML Feature: Refactor JS / Liquid Page is working fine - JS / Liquid needs changes to become consistent with other pages p-feature: Projects-check We use this page to check to make sure that teams are using the Technology section correctly role: front end Tasks for front end developers size: 2pt Can be done in 7-12 hours

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Jul 17, 2023

Dependencies

Overview

We need to refactor the HTML and JavaScript for the Projects and Projects-Check pages, so that both pages share the same HTML and JavaScript files. The differences in filter options between the two pages will be implemented by adding conditional logic in JavaScript based on the current page URL.

Details

  1. The difference between the Projects page and the Projects-Check pages is that the Projects-Check page has only the Technologies, Languages, and Tools filter options, in order to enable testing.
  2. As time has passed and the Projects page has been developed, the JavaScript code in particular has diverged between the Projects and Projects-Check pages and some unintended differences have been observed in the Projects page.

Action Items

  • In the IDE, modify _pages/projects-check.html so that it includes current-projects.html instead of current-projects-check.html. As a result of this change, the projects-check page will reference the same HTML include and same JavaScript as the projects page.
  • Examine the differences in JavaScript between /assets/js/current-projects-check.js and /assets/js/current-projects.js. For each difference, determine if the difference is required to implement the distinct filter options required on the Projects-Check page.
    • If the difference is required, add conditional logic in the JavaScript to implement the desired behavior in the Projects Check page
    • If the difference is not required, do nothing
  • Confirm that the appearance and behavior of the projects-check page matches that of the projects page except for the filter selection
    • Confirm that if more than 8 categories exist in a filter section, only 8 are displayed but a "View All" link is displayed.
    • Confirm that as filters are applied, filter tags appear under the heading "Applied FIlters" and clicking the tags clears the filters.
    • Confirm that if more than 8 categores exist in both the Technology and Language (and Tools?) groups, it should be possible to view all the filters in both groups at once.

Resources/Instructions

@roslynwythe roslynwythe added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing Complexity: Medium role: front end Tasks for front end developers p-feature: Projects-check We use this page to check to make sure that teams are using the Technology section correctly Feature: Refactor JS / Liquid Page is working fine - JS / Liquid needs changes to become consistent with other pages Feature: Refactor HTML and removed Complexity: Missing Feature Missing This label means that the issue needs to be linked to a precise feature label. size: missing labels Jul 17, 2023
@ExperimentsInHonesty
Copy link
Member

We think this is feasible, so this issue will get rewritten to be a large, get it done issue. But it will also the following dependencies

@roslynwythe roslynwythe changed the title Feasibility: Refactor projects-check page to share HTML and JavaScript with projects page Refactor projects-check page to share HTML and JavaScript with projects page Jul 18, 2023
@roslynwythe roslynwythe changed the title Refactor projects-check page to share HTML and JavaScript with projects page Refactor HTML and JavaScript so projects and projects-check pages can share the same files Jul 18, 2023
@roslynwythe roslynwythe added Complexity: Large size: 3pt Can be done in 13-18 hours Draft Issue is still in the process of being created and removed Complexity: Medium ready for product size: 1 pt labels Jul 18, 2023
@ExperimentsInHonesty ExperimentsInHonesty added the Dependency An issue is blocking the completion or starting of another issue label Jul 23, 2023
@t-will-gillis t-will-gillis 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 Sep 14, 2023
@t-will-gillis
Copy link
Member

t-will-gillis commented Sep 14, 2023

@roslynwythe roslynwythe added Ready for Prioritization and removed Draft Issue is still in the process of being created ready for dev lead Issues that tech leads or merge team members need to follow up on labels Oct 13, 2023
@roslynwythe roslynwythe added size: 2pt Can be done in 7-12 hours and removed size: 3pt Can be done in 13-18 hours labels Oct 23, 2023
@jphamtv jphamtv self-assigned this Dec 5, 2023
Copy link

github-actions bot commented Dec 5, 2023

Hi @jphamtv, 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 :)

@jphamtv
Copy link
Member

jphamtv commented Dec 5, 2023

Availability: Monday-Friday 12–2 PM, 8–10 PM (PST)
Estimated ETA: 12/11/23

@jphamtv
Copy link
Member

jphamtv commented Dec 9, 2023

PR created #5978

Hi @roslynwythe - FYI I didn’t delete _includes/current-projects-check.html and assets/js/current-projects-check.js files after refactoring. Just mentioning it here in case they should be removed after the pull request is approved and merged. I didn't see an action item to remove them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large Feature: Refactor HTML Feature: Refactor JS / Liquid Page is working fine - JS / Liquid needs changes to become consistent with other pages p-feature: Projects-check We use this page to check to make sure that teams are using the Technology section correctly role: front end Tasks for front end developers size: 2pt Can be done in 7-12 hours
Projects
4 participants