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

Replace Github with GitHub in assets/js/wins.js updateOverlay #7495

Open
6 of 7 tasks
Tracked by #7664
daras-cu opened this issue Sep 19, 2024 · 12 comments · May be fixed by #7897
Open
6 of 7 tasks
Tracked by #7664

Replace Github with GitHub in assets/js/wins.js updateOverlay #7495

daras-cu opened this issue Sep 19, 2024 · 12 comments · May be fixed by #7897
Assignees
Labels
Complexity: Medium P-Feature: Wins Page https://www.hackforla.org/wins/ 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

Comments

@daras-cu
Copy link
Member

daras-cu commented Sep 19, 2024

Overview

We need to replace instances of Github and github with GitHub so that we display the company name correctly, and test the changes to ensure the behavior and appearance of any and all related webpages are unchanged.

Action Items

  • Open assets/js/wins.js in your IDE
  • In function updateOverlay(i) change
  			makeIcon(data[i][github_url], overlayIcons, 'github-icon', '/assets/images/wins-page/icon-github-small.svg', 'Github profile for ' + data[i][name]);

to

  			makeIcon(data[i][github_url], overlayIcons, 'github-icon', '/assets/images/wins-page/icon-github-small.svg', 'GitHub profile for ' + data[i][name]);
  • Find all the files that are connected to this change. (e.g., if its a yml or md file, what files or scripts use the data stored in that file). And document briefly how they work together.
  • Define where you expect the change to show up on the website (e.g., the footer of the website). Can be on multiple pages
  • Write a test procedure, in a comment, and then use it to test the change. Include a link to this comment in your PR.
  • Add/commit changes then create a PR as usual. Document the test procedure in the Pull Request.

Resources

Merge Team

@daras-cu daras-cu added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Medium P-Feature: Wins Page https://www.hackforla.org/wins/ size: 1pt Can be done in 4-6 hours labels Sep 19, 2024
@daras-cu daras-cu added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Sep 19, 2024
@ExperimentsInHonesty ExperimentsInHonesty added ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization labels Sep 24, 2024
@izma-mujeeb izma-mujeeb self-assigned this Sep 25, 2024
@izma-mujeeb izma-mujeeb moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Sep 25, 2024
@HackforLABot

This comment has been minimized.

@izma-mujeeb izma-mujeeb removed their assignment Oct 1, 2024
@izma-mujeeb izma-mujeeb moved this to Prioritized backlog in P: HfLA Website: Project Board Oct 1, 2024
@Kle012 Kle012 self-assigned this Oct 1, 2024
@Kle012 Kle012 moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Oct 1, 2024
@HackforLABot HackforLABot moved this from In progress (actively working) to New Issue Approval in P: HfLA Website: Project Board Oct 1, 2024
@HackforLABot

This comment has been minimized.

@HackforLABot

This comment has been minimized.

@HackforLABot HackforLABot moved this from Prioritized backlog to New Issue Approval in P: HfLA Website: Project Board Dec 5, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to ERs and epics that are ready to be turned into issues in P: HfLA Website: Project Board Jan 21, 2025
@ExperimentsInHonesty ExperimentsInHonesty moved this from ERs and epics that are ready to be turned into issues to Prioritized backlog in P: HfLA Website: Project Board Jan 21, 2025
@DrAcula27 DrAcula27 self-assigned this Jan 21, 2025
@HackforLABot

This comment has been minimized.

@DrAcula27 DrAcula27 moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Jan 22, 2025
@DrAcula27
Copy link
Member

Availability: Weekday afternoons (2pm–5pm Pacific)

ETA: 31 January

@HackforLABot HackforLABot added the To Update ! No update has been provided label Jan 31, 2025
@HackforLABot
Copy link
Contributor

@DrAcula27

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 (optional): "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 Questions/In Review column of the Project Board 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. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

You are receiving this comment because your last comment was before Monday, January 27, 2025 at 11:04 PM PST.

@DrAcula27
Copy link
Member

DrAcula27 commented Feb 1, 2025

Progress: see checked boxes in issue.
Blockers: see question in next comment.
Availability: weekdays from 2pm to 6pm pacific time
ETA: 7 Feb, 2025

@DrAcula27 DrAcula27 added Status: Updated No blockers and update is ready for review and removed To Update ! No update has been provided labels Feb 1, 2025
@DrAcula27 DrAcula27 moved this from In progress (actively working) to Questions / In Review in P: HfLA Website: Project Board Feb 1, 2025
@DrAcula27
Copy link
Member

DrAcula27 commented Feb 1, 2025

Questions

  1. Should I also change every instance of Github or github in assets/js/wins.js where GitHub is mentioned in text (i.e., not as a variable name)?
    • Currently, I have Github or github changed to GitHub on lines 12, 13, 28, and 509 (the requested change)
  2. If I should keep the change from Github to GitHub on lines 12 and 13:
    • 12 const github_url = "Github URL (optional)"
    • 13 const github_permission = "Could we use your Github profile picture next to your story?"
    • then that will affect 2 more files:
      • _data/external/_wins-data.json
      • google-apps-scripts/wins-form-responses/Code.js
    • and I will need to change every instance of Github to GitHub in these two files.
    • otherwise, no other files need to change.
  3. If I do make these changes, and then update the other files, I don't think any testing will need to be done.

@DrAcula27 DrAcula27 added the Status: Help Wanted Internal assistance is required to make progress label Feb 1, 2025
@DrAcula27
Copy link
Member

DrAcula27 commented Feb 1, 2025

Expected changes

  • I don't expect to see any visual changes to the website, UNLESS I get the go-ahead to change the instances of Github to GitHub on lines 12 and 13 of assets/js/wins.js and the listed affected files in my comment above.
    • If I do, I expect the second page of the Share your wins with us! Google form to change in these two lines:
      • Github URL (optional)GitHub URL (optional)
      • Could we use your Github profile picture next to your story?Could we use your GitHub profile picture next to your story?

@daras-cu
Copy link
Member Author

daras-cu commented Feb 6, 2025

Hi @DrAcula27,

  1. You do not need to change the other instances of Github in this file, only the one within the specified function. As you noted, changing the other instances would also affect other files, so they will be done in a separate issue. Hopefully this addresses 2 and 3 too.
    Also regarding your expected changes, you're correct there should be no visual changes on the website from changing the specified instance of Github. However, the changes do show up in the HTML for the Wins page as alt text for the github-icon class, so you may want to write a test procedure for reviewers to follow so they can verify the changes there.
    Hope this helps, and sorry for the wait!

@DrAcula27
Copy link
Member

Thank you @daras-cu for the reply!

  • I will only change the instance of Github on line 509 and write out that test in a following comment.
  • ETA: still 7 Feb 2025, thanks for answering in time to keep me on schedule 😄

@DrAcula27 DrAcula27 removed the Status: Help Wanted Internal assistance is required to make progress label Feb 6, 2025
@DrAcula27 DrAcula27 moved this from Questions / In Review to In progress (actively working) in P: HfLA Website: Project Board Feb 6, 2025
@DrAcula27
Copy link
Member

Expected Changes - Revised

  • Since I only need to change one instance of the word Github to GitHub in assets/js/wins.js (on line 509), there will be no immediate visual changes to the website.
  • However, the alt text in the HTML for the Wins page will be updated from Github profile for <name> to GitHub profile for <name>

Testing Procedure for Expected Changes

  1. Follow the HfLA procedure for reviewing a PR until you get to the step where you have the live version of the site (https://www.hackforla.org) open next to your local version (running in a Docker container).
  2. In both instances of the website, click on the Wins button in the navbar.
  3. Open your browser's developer tools:
    • Firefox: right click > Inspect > ensure the Inspector tab is active
    • Chrome: right click > Inspect > ensure the Elements tab is active
  4. CTRL + Shift + C to activate the option to Select an element in the page to inspect it
  5. Click on the GitHub icon in the top-right corner of a few of the contributors' cards (or all of them if you feel like it!) to automatically scroll to that element in the Inspector (Firefox) or Elements (Chrome) tab of your browser's developer tools.
  6. Once that element is highlighted, check that the alt attribute of the img element housing the GitHub icon says GitHub profile for <name>, NOT Github profile for <name>.
  7. Continue with the rest of the review PR steps to finish, and thank you!

@DrAcula27 DrAcula27 linked a pull request Feb 6, 2025 that will close this issue
5 tasks
@HackforLABot HackforLABot removed the Status: Updated No blockers and update is ready for review label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium P-Feature: Wins Page https://www.hackforla.org/wins/ 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
Projects
Status: In progress (actively working)
Development

Successfully merging a pull request may close this issue.

7 participants