repo sync

contributing/troubleshooting.md

@@ -27,14 +27,14 @@ If a staging deployment is pending for more than 5-10min, try the following:
 2. If that doesn't work, trigger a new staging deployment by pushing an empty commit on the command line:
 
 ```
-$ git commit --allow-empty -m'empty commit to redeploy staging'
+$ git commit --allow-empty -m 'empty commit to redeploy staging'
 ```
 
 ### CI stalled or stuck
 :yellow_heart: If tests are stuck yellow for more than an hour, rerun CI by pushing an empty commit on the command line:
 
 ```
-$ git commit --allow-empty -m'empty commit to rerun CI'
+$ git commit --allow-empty -m 'empty commit to rerun CI'
 ```
 
 ## Troubleshooting failed deployments and CI

data/glossaries/external.yml

@@ -128,7 +128,7 @@
 - term: commit
   description: >-
     A commit, or "revision", is an individual change to a file (or set of
-    files). When you make a commit to save your work, Git creates a unique ID (a.k.a. the "SHA" or "hash") that allows you to keep record of the specific changes commited along with who made them and when. Commits usually contain a
+    files). When you make a commit to save your work, Git creates a unique ID (a.k.a. the "SHA" or "hash") that allows you to keep record of the specific changes committed along with who made them and when. Commits usually contain a
     commit message which is a brief description of what changes were made.
 - term: commit author
   description: The user who makes the commit.
@@ -140,7 +140,7 @@
   description: Also known as SHA. A 40-character checksum hash that identifies the commit.
 - term: commit message
   description: >-
-    Short, descriptive text that accompanys a commit and communicates the change
+    Short, descriptive text that accompanies a commit and communicates the change
     the commit is introducing.
 - term: compare branch
   description: >-
@@ -406,9 +406,9 @@
     convention and is not required.
 - term: master
   description: >-
-    The default branch in many Git repositories. By default, when you create 
-    a new Git repository on the command line a branch called `master` is created. 
-    Many tools now use an alternative name for the default branch. For example, 
+    The default branch in many Git repositories. By default, when you create
+    a new Git repository on the command line a branch called `master` is created.
+    Many tools now use an alternative name for the default branch. For example,
     when you create a new repository on GitHub the default branch is called `main`.
 - term: Members graph
   description: A repository graph that shows all the forks of a repository.
@@ -458,7 +458,7 @@
 - term: notification
   description: >-
     Updates, delivered by either the web or email depending on your settings,
-    that give you information about the activites you're interested in.
+    that give you information about the activities you're interested in.
 - term: OAuth App
   description: >-
     A third-party application that uses access tokens rather than passwords to

data/glossaries/internal.yml

@@ -101,7 +101,7 @@
 - term: CPU
   description: Central processing unit.
 - term: credential helper
-  description: A program that stores and fets Git credentials.
+  description: A program that stores and fetches Git credentials.
 - term: creole
   description: >-
     A lightweight markup language, aimed at being a common markup language for
@@ -683,7 +683,7 @@
     made but not yet committed.
 - term: WYSIWYG
   description: >-
-    What You See Is What You Get. An acryonym meaning the text on the screen
+    What You See Is What You Get. An acronym meaning the text on the screen
     looks exactly as it will when it's rendered.
 - term: XenServer
   description: A virtualization platform.

data/reusables/support/ghae-priorities.md

@@ -1,6 +1,6 @@
 | Priority | Description | Examples |
 | :---: | --- | --- |
 | {% data variables.product.support_ticket_priority_urgent %} - Sev A | {% data variables.product.product_name %} is inaccessible or failing entirely, and the failure directly impacts the operation of your business.<br/><br/>_After you file a support ticket, reach out to {% data variables.contact.github_support %} via phone._ | <ul><li>Errors or outages that affect core Git or web application functionality for all users</li><li>Severe network or performance degradation for majority of users</li><li>Full or rapidly filling storage</li><li>Known security incidents or a breach of access</li></ul> |
-| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. | <ul><li>Performance degradation that reduces productivity for many users</li><li>Reduced redundancy concerns from failures or service degradation</li><li>Production-impacting bugs or errors</li><li>{% data variables.product.product_name %} configuraton security concerns</li></ul> |
+| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. | <ul><li>Performance degradation that reduces productivity for many users</li><li>Reduced redundancy concerns from failures or service degradation</li><li>Production-impacting bugs or errors</li><li>{% data variables.product.product_name %} configuration security concerns</li></ul> |
 | {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} is experiencing limited or moderate issues and errors with {% data variables.product.product_name %}, or you have general concerns or questions about the operation of {% data variables.product.product_name %}. | <ul><li>Advice on using {% data variables.product.prodname_dotcom %} APIs and features, or questions about integrating business workflows</li><li>Issues with user tools and data collection methods</li><li>Upgrades</li><li>Bug reports, general security questions, or other feature related questions</li> |
 | {% data variables.product.support_ticket_priority_low %} - Sev D| {% data variables.product.product_name %} is functioning as expected, however, you have a question or suggestion about {% data variables.product.product_name %} that is not time-sensitive, or does not otherwise block the productivity of your team. | <ul><li>Feature requests and product feedback</li><li>General questions on overall configuration or use of {% data variables.product.product_name %}</li><li>Notifying {% data variables.contact.github_support %} of any planned changes</li></ul> |

data/variables/action_code_examples.yml

@@ -256,7 +256,7 @@
     - automation
 - title: Distribute funding in free and open source projects
   description: Continuous Distribution of funding to project contributors and dependencies
-  languages: 'Python, Docerfile, Shell, Ruby'
+  languages: 'Python, Dockerfile, Shell, Ruby'
   href: protontypes/libreselery
   tags:
     - sponsors
@@ -273,7 +273,7 @@
     - pull request
 - title: Codeowner validator
   description: Ensures the correctness of your GitHub CODEOWNERS file, supports public and private GitHub repositories and also GitHub Enterprise installations
-  languages: 'Go, Shell, Makefile, Docerfile'
+  languages: 'Go, Shell, Makefile, Dockerfile'
   href: mszostok/codeowners-validator
   tags:
     - codeowners

includes/search-form.html

@@ -7,6 +7,6 @@
 
 <form class="mb-0">
   <div id="search-input-container" aria-hidden="true">
-    <!-- Aloglia instantsearch.js will add a search input here -->
+    <!-- Algolia instantsearch.js will add a search input here -->
   </div>
 </form>

javascripts/search.js

@@ -53,7 +53,7 @@ const resultTemplate = (item) => {
     </div>
   `
 
-  // Santize the link's href attribute using the DOM API to prevent XSS
+  // Sanitize the link's href attribute using the DOM API to prevent XSS
   const fragment = document.createRange().createContextualFragment(html)
   fragment.querySelector('a').setAttribute('href', item.modifiedURL)
   const div = document.createElement('div')
@@ -69,7 +69,7 @@ export default function () {
   const opts = {
 
     // https://www.algolia.com/apps/ZI5KPY1HBE/dashboard
-    // This API key is public. There's also a private API key for writing to the Aloglia API
+    // This API key is public. There's also a private API key for writing to the Algolia API
     searchClient: algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f'),
 
     // There's an index for every version/language combination

lib/algolia/parse-page-sections-into-records.js

@@ -1,6 +1,6 @@
 // This module takes cheerio page object and divides it into sections
 // using H1,h2,h3 heading elements as section delimiters. The text
-// that follows each heading becomes the content of the searh record.
+// that follows each heading becomes the content of the search record.
 
 const { chain } = require('lodash')
 const urlPrefix = 'https://docs.github.com'

lib/algolia/sync.js

@@ -46,7 +46,7 @@ module.exports = async function syncAlgoliaIndices (opts = {}) {
 
   console.log(`Building indices for ${opts.language || 'all languages'} and ${opts.version || 'all versions'}.\n`)
 
-  // Exlude WIP pages, hidden pages, index pages, etc
+  // Exclude WIP pages, hidden pages, index pages, etc
   const indexablePages = await findIndexablePages()
 
   // Build and validate all indices

lib/get-applicable-versions.js

@@ -20,7 +20,7 @@ function getApplicableVersions (frontmatterVersions, filepath) {
   //   enterprise-server: '>=2.19'
   //   enterprise-cloud: '*'
   //   private-instances: '*'
-  // ^ where each key correponds to a plan
+  // ^ where each key corresponds to a plan
   Object.entries(frontmatterVersions)
     .forEach(([plan, planValue]) => {
       // for each plan (e.g., enterprise-server), get matching versions from allVersions object

lib/page.js

@@ -57,7 +57,7 @@ class Page {
       this.raw = this.raw.replace(': verdadero', ': true')
     }
 
-    // parse fronmatter and save any errors for validation in the test suite
+    // parse frontmatter and save any errors for validation in the test suite
     const { content, data, errors: frontmatterErrors } = frontmatter(this.raw, { filepath: this.fullPath })
     this.frontmatterErrors = frontmatterErrors
 

lib/redirects/get-old-paths-from-permalink.js

@@ -42,7 +42,7 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
     .replace(`/enterprise/${latest}`, '/enterprise'))
 
   // create old path /enterprise/foo from current path /enterprise/user/foo
-  // this supports old developer paths like /enteprise/webhooks with no /user in them
+  // this supports old developer paths like /enterprise/webhooks with no /user in them
   if (currentPath.includes('/enterprise/')) {
     oldPaths.add(currentPath
       .replace('/user/', '/'))

lib/redirects/permalinks.js

@@ -48,7 +48,7 @@ module.exports = function generateRedirectsForPermalinks (permalinks, redirectFr
     })
   })
 
-  // filter for uniqe entries only
+  // filter for unique entries only
   Object.entries(redirects).forEach(([oldPath, newPath]) => {
     if (oldPath === newPath) delete redirects[oldPath]
   })

lib/redirects/precompile.js

@@ -61,7 +61,7 @@ module.exports = function precompileRedirects (pageList, pageMap) {
     }
 
     // given a developer route like `/enterprise/2.19/v3/activity`,
-    // add a veriation like `/enterprise/2.19/user/v3/activity`;
+    // add a variation like `/enterprise/2.19/user/v3/activity`;
     // we need to do this because all links in content get rewritten
     // by lib/rewrite-local-links to include `/user`
     if (developerRoute.includes('/enterprise/')) {
@@ -72,7 +72,7 @@ module.exports = function precompileRedirects (pageList, pageMap) {
     }
 
     // given a developer route like `/v3/gists/comments`,
-    // add a veriation like `/free-pro-team@latest/v3/gists/comments`;
+    // add a variation like `/free-pro-team@latest/v3/gists/comments`;
     // again, we need to do this because all links in content get rewritten
     if (!developerRoute.startsWith('/enterprise/')) {
       const developerRouteWithVersion = slash(path.join(nonEnterpriseDefaultVersion, developerRoute))

middleware/trigger-error.js

@@ -4,5 +4,5 @@ module.exports = async function triggerError (req, res, next) {
   // prevent this from being used in production
   if (process.env.NODE_ENV === 'production') return next()
 
-  throw new Error('OH NOEZ')
+  throw new Error('Intentional error')
 }

script/README.md

@@ -290,7 +290,7 @@ This script finds all Heroku staging apps and pings them to make sure they're al
 
 ### [`prevent-pushes-to-main.js`](prevent-pushes-to-main.js)
 
-This script is intended to be used as a git "prepush" hook. If the current branch is main, it will exit unsuccesfully and prevent the push.
+This script is intended to be used as a git "prepush" hook. If the current branch is main, it will exit unsuccessfully and prevent the push.
 
 ---
 

script/enterprise-server-releases/create-graphql-files.js

@@ -47,7 +47,7 @@ if (!fs.existsSync(newSchemaFile)) {
   process.exit(1)
 }
 
-// the other files are objects with vers3091iuions as keys, so we need to require them
+// the other files are objects with versions as keys, so we need to require them
 const previewsFile = path.join(graphqlStaticDir, 'previews.json')
 const changesFile = path.join(graphqlStaticDir, 'upcoming-changes.json')
 const objectsFile = path.join(graphqlStaticDir, 'prerendered-objects.json')

script/graphql/utils/process-schemas.js

@@ -348,7 +348,7 @@ module.exports = async function processSchemas (idl, previewsPerVersion) {
   // add non-schema scalars and sort all scalars alphabetically
   data.scalars = sortBy(data.scalars.concat(externalScalars), 'name')
 
-  // sort all the types alphebatically
+  // sort all the types alphabetically
   data.queries.connections = sortBy(data.queries.connections, 'name')
   data.queries.fields = sortBy(data.queries.fields, 'name')
   data.mutations = sortBy(data.mutations, 'name')

script/prevent-pushes-to-main.js

@@ -5,7 +5,7 @@ const { execSync } = require('child_process')
 // [start-readme]
 
 // This script is intended to be used as a git "prepush" hook.
-// If the current branch is main, it will exit unsuccesfully and prevent the push.
+// If the current branch is main, it will exit unsuccessfully and prevent the push.
 
 // [end-readme]
 

script/prevent-translation-commits.js

@@ -13,7 +13,7 @@ require('dotenv').config()
 // Ignore this hook in GitHub Actions workflows
 if (process.env.CI) process.exit()
 
-// Allow this hook to be overriden with an enviroment variable
+// Allow this hook to be overriden with an environment variable
 if (process.env.ALLOW_TRANSLATION_COMMITS) process.exit()
 
 const { execSync } = require('child_process')

stylesheets/tables.scss

@@ -4,7 +4,7 @@
   font-size: 90%;
   width: 100%;
   /* We want to keep table-layout: auto so that column widths dynamically adjust;
-  otherwise entries get needlessly smushed into narrow columns. As a workaround,
+  otherwise entries get needlessly squashed into narrow columns. As a workaround,
   we use javascripts/wrap-code-terms.js to prevent some reference table content
   from expanding beyond the horizontal boundaries of the parent element. */
   table-layout: auto;

tests/rendering/server.js

@@ -106,7 +106,7 @@ describe('server', () => {
   test('renders a 500 page when errors are thrown', async () => {
     const $ = await getDOM('/_500')
     expect($('h1').text()).toBe('Ooops!')
-    expect($('code').text().startsWith('Error: OH NOEZ')).toBe(true)
+    expect($('code').text().startsWith('Error: Intentional error')).toBe(true)
     expect($('code').text().includes(path.join('node_modules', 'express', 'lib', 'router'))).toBe(true)
     expect($.text().includes('Still need help?')).toBe(true)
     expect($.res.statusCode).toBe(500)