ER: Find all the places that Github should be GitHub and fix

[ExperimentsInHonesty]

Dependencies (Child Issues)

• replace Github with GitHub in website/redirections/github.md #7110
• replace Github with GitHub in communities-of-practice.html #7111
• Replace Github with GitHub in _data/navigation/social.yml #7112
• Replace Github with GitHub in _data/internal/communities/ui-ux.yml #7113
• Replace Github with GitHub in _data/internal/communities/engineering.yml #7115
• Replace Github with GitHub in _data/internal/communities/project-management.yml #7117
• Replace Github with GitHub in pages/getting-started.html #7118
• Replace Github with GitHub in _projects/ems-triage-tracker.md #7413
• Replace Github with GitHub in _projects/tech-work-experience.md #7414
• Replace Github with GitHub in _data/internal/communities/ops.yml #7415
• Replace Github with GitHub in _data/internal/communities/data-science.yml #7416
• Replace github with GitHub in github-actions/utils/post-issue-comment.js #7417
• Replace Github with GitHub in _guide-pages/2FA.html #7418
• Replace Github with GitHub in _sass/components/_guides.scss #7419
• Replace github with GitHub in _sass/components/_communities-of-practice.scss #7420
• Replace Github with GitHub in github-actions/trigger-issue/add-missing-labels-to-issues/add-labels-template.md #7421
• Replace Github with GitHub in assets/js/utility/api-events.js #7422
• Replace Github with GitHub in github-actions/trigger-schedule/list-inactive-members/get-contributors-data.js #7423
• Replace Github with GitHub in CONTRIBUTING.md Table of Contents 1.4.c #7438
• Replace Github with GitHub in CONTRIBUTING.md Section 1.4 #7439
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.e #7440
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.f i #7441
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.f ii #7442
• Replace Github with GitHub in CONTRIBUTING.md Section 4.2.b #7443
• Replace Github with GitHub in assets/js/wins.js makecards #7494
• Replace Github with GitHub in assets/js/wins.js updateOverlay #7495
• Replace Github with GitHub in _data/internal/toolkitresources.yml #8390
• Replace Github with GitHub in feature-homepage-launch/_data/navigation/social.yml #8508
• To do: Issues for Code.js and wins.js, which are linked to the Wins Form

Emergent Requirement - Problem

GitHub is a company name and should only be in lowercase (github) when in a URL, variable or directory name (where the variables or directories are all lowercase).

Details

There are 180 files with some form of github in it.

Issue you discovered this emergent requirement in

• Update the GitHub resource name for the Access the Data Project #4685

Date discovered

2024-01-25

Did you have to do something temporarily

• YES
• NO

Who was involved

@ExperimentsInHonesty

What happens if this is not addressed

• If it's public facing, it's unprofessional not to fix it.
• if it's in our non-public facing code, it's best practices to use it consistently as intended

Resources

• 180 files in our repo with some form of the name github in it
  • I reviewed all the instances, and divided them up into could, be careful, and must.

Examples of locations that could be changed

• website/github-actions/utils/format-comment.js

  Line 7 in 3c7c90e

  * @returns {String} - returns a formatted comment to be posted on github

• website/github-actions/utils/post-issue-comment.js

  Line 2 in 3c7c90e

  * Posts a comment on github

• website/github-actions/trigger-schedule/github-data/contributors-data.js

  Line 78 in 3c7c90e

  // Since Github only allows to fetch max 100 items per request, we need to 'flip' pages

• website/pages/wins/wins-share-form.html

  Line 464 in 3c7c90e

  //github photo permission

• website/_sass/components/_guides.scss

  Line 249 in 3c7c90e

  /* Populates an empty div for Users with no Github Link */

• website/assets/js/utility/api-events.js

  Line 36 in 3c7c90e

  // If a project doesn't have an hflaWebsiteUrl, redirect to the project's Github page

Example of locations that could be changed, but it might break some logic.

• website/redirections/github.md

  Line 4 in 3c7c90e

  title: Github

• website/pages/communities-of-practice.html

  Line 82 in 3c7c90e

  title="{{community[1].name}} Github Repo">

• website/_data/navigation/social.yml

  Line 31 in 3c7c90e

  - name: Github

• website/_data/internal/communities/ui-ux.yml

  Line 43 in 3c7c90e

  - name: Github

• website/_data/internal/communities/engineering.yml

  Line 38 in 3c7c90e

  - name: Github

• website/_data/internal/communities/project-management.yml

  Line 26 in 3c7c90e

  - name: Github

• website/_data/internal/toolkitresources.yml

  Line 13 in 3c7c90e

  - title: Github

Examples of locations it must be changed

• website/_guide-pages/github-issues.html

  Line 35 in 3c7c90e

  <h5>An effective Hack for LA Github issue includes the following components:</h5>

• website/pages/getting-started.html

  Line 101 in 3c7c90e

  <li class="g-s-list">Receive access to the Google Drive and Github repository by sending a Slack message of your Github username and Gmail address to a CoP lead. <img class="info-icon" src="assets/images/getting-started/information.png" alt="">

Recommended Action Items

• Make 2 issue templates in comments that will work for all the following types of changes, so that each issue is easy to make
• Review each potential change and decide if It's something that can be changed
  • without risk, in which case it's a good first issue
    • Examples of locations that could be changed
    • Examples of locations it must be changed
  • might have risk and will need to be tested, in case it's a medium issue and will need to specify that the assignee will have to devise and document what tests they intend to do, so that when the PR is reviewed, the merge team can sign off that the change was tested adequately.
    • Example of locations that could be changed, but it might break some logic.
• move this issue to the questions column and add the ready for merge team label with the following note in a comment
• make issues - see Dependencies section above

Potential solutions [draft]