Skip to content

Commit 9d46c15

Browse files
authored
repo sync
2 parents 3bcef63 + d7eb248 commit 9d46c15

22 files changed

Lines changed: 32 additions & 32 deletions

contributing/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ If a staging deployment is pending for more than 5-10min, try the following:
2727
2. If that doesn't work, trigger a new staging deployment by pushing an empty commit on the command line:
2828

2929
```
30-
$ git commit --allow-empty -m'empty commit to redeploy staging'
30+
$ git commit --allow-empty -m 'empty commit to redeploy staging'
3131
```
3232

3333
### CI stalled or stuck
3434
:yellow_heart: If tests are stuck yellow for more than an hour, rerun CI by pushing an empty commit on the command line:
3535

3636
```
37-
$ git commit --allow-empty -m'empty commit to rerun CI'
37+
$ git commit --allow-empty -m 'empty commit to rerun CI'
3838
```
3939

4040
## Troubleshooting failed deployments and CI

data/glossaries/external.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
- term: commit
129129
description: >-
130130
A commit, or "revision", is an individual change to a file (or set of
131-
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
131+
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
132132
commit message which is a brief description of what changes were made.
133133
- term: commit author
134134
description: The user who makes the commit.
@@ -140,7 +140,7 @@
140140
description: Also known as SHA. A 40-character checksum hash that identifies the commit.
141141
- term: commit message
142142
description: >-
143-
Short, descriptive text that accompanys a commit and communicates the change
143+
Short, descriptive text that accompanies a commit and communicates the change
144144
the commit is introducing.
145145
- term: compare branch
146146
description: >-
@@ -406,9 +406,9 @@
406406
convention and is not required.
407407
- term: master
408408
description: >-
409-
The default branch in many Git repositories. By default, when you create
410-
a new Git repository on the command line a branch called `master` is created.
411-
Many tools now use an alternative name for the default branch. For example,
409+
The default branch in many Git repositories. By default, when you create
410+
a new Git repository on the command line a branch called `master` is created.
411+
Many tools now use an alternative name for the default branch. For example,
412412
when you create a new repository on GitHub the default branch is called `main`.
413413
- term: Members graph
414414
description: A repository graph that shows all the forks of a repository.
@@ -458,7 +458,7 @@
458458
- term: notification
459459
description: >-
460460
Updates, delivered by either the web or email depending on your settings,
461-
that give you information about the activites you're interested in.
461+
that give you information about the activities you're interested in.
462462
- term: OAuth App
463463
description: >-
464464
A third-party application that uses access tokens rather than passwords to

data/glossaries/internal.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
- term: CPU
102102
description: Central processing unit.
103103
- term: credential helper
104-
description: A program that stores and fets Git credentials.
104+
description: A program that stores and fetches Git credentials.
105105
- term: creole
106106
description: >-
107107
A lightweight markup language, aimed at being a common markup language for
@@ -683,7 +683,7 @@
683683
made but not yet committed.
684684
- term: WYSIWYG
685685
description: >-
686-
What You See Is What You Get. An acryonym meaning the text on the screen
686+
What You See Is What You Get. An acronym meaning the text on the screen
687687
looks exactly as it will when it's rendered.
688688
- term: XenServer
689689
description: A virtualization platform.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
| Priority | Description | Examples |
22
| :---: | --- | --- |
33
| {% 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> |
4-
| {% 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> |
4+
| {% 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> |
55
| {% 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> |
66
| {% 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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@
256256
- automation
257257
- title: Distribute funding in free and open source projects
258258
description: Continuous Distribution of funding to project contributors and dependencies
259-
languages: 'Python, Docerfile, Shell, Ruby'
259+
languages: 'Python, Dockerfile, Shell, Ruby'
260260
href: protontypes/libreselery
261261
tags:
262262
- sponsors
@@ -273,7 +273,7 @@
273273
- pull request
274274
- title: Codeowner validator
275275
description: Ensures the correctness of your GitHub CODEOWNERS file, supports public and private GitHub repositories and also GitHub Enterprise installations
276-
languages: 'Go, Shell, Makefile, Docerfile'
276+
languages: 'Go, Shell, Makefile, Dockerfile'
277277
href: mszostok/codeowners-validator
278278
tags:
279279
- codeowners

includes/search-form.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77

88
<form class="mb-0">
99
<div id="search-input-container" aria-hidden="true">
10-
<!-- Aloglia instantsearch.js will add a search input here -->
10+
<!-- Algolia instantsearch.js will add a search input here -->
1111
</div>
1212
</form>

javascripts/search.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ const resultTemplate = (item) => {
5353
</div>
5454
`
5555

56-
// Santize the link's href attribute using the DOM API to prevent XSS
56+
// Sanitize the link's href attribute using the DOM API to prevent XSS
5757
const fragment = document.createRange().createContextualFragment(html)
5858
fragment.querySelector('a').setAttribute('href', item.modifiedURL)
5959
const div = document.createElement('div')
@@ -69,7 +69,7 @@ export default function () {
6969
const opts = {
7070

7171
// https://www.algolia.com/apps/ZI5KPY1HBE/dashboard
72-
// This API key is public. There's also a private API key for writing to the Aloglia API
72+
// This API key is public. There's also a private API key for writing to the Algolia API
7373
searchClient: algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f'),
7474

7575
// There's an index for every version/language combination

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// This module takes cheerio page object and divides it into sections
22
// using H1,h2,h3 heading elements as section delimiters. The text
3-
// that follows each heading becomes the content of the searh record.
3+
// that follows each heading becomes the content of the search record.
44

55
const { chain } = require('lodash')
66
const urlPrefix = 'https://docs.github.com'

lib/algolia/sync.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ module.exports = async function syncAlgoliaIndices (opts = {}) {
4646

4747
console.log(`Building indices for ${opts.language || 'all languages'} and ${opts.version || 'all versions'}.\n`)
4848

49-
// Exlude WIP pages, hidden pages, index pages, etc
49+
// Exclude WIP pages, hidden pages, index pages, etc
5050
const indexablePages = await findIndexablePages()
5151

5252
// Build and validate all indices

lib/get-applicable-versions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ function getApplicableVersions (frontmatterVersions, filepath) {
2020
// enterprise-server: '>=2.19'
2121
// enterprise-cloud: '*'
2222
// private-instances: '*'
23-
// ^ where each key correponds to a plan
23+
// ^ where each key corresponds to a plan
2424
Object.entries(frontmatterVersions)
2525
.forEach(([plan, planValue]) => {
2626
// for each plan (e.g., enterprise-server), get matching versions from allVersions object

0 commit comments

Comments
 (0)