Skip to content

Commit 3b89ed8

Browse files
Merge branch 'main' into patch-1
2 parents dd229d1 + 1588f50 commit 3b89ed8

4,444 files changed

Lines changed: 2405280 additions & 157031 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Codespaces environment for docs.github.com
2+
// For format details, see https://aka.ms/vscode-remote/devcontainer.json
3+
{
4+
"name": "docs.github.com",
5+
"service": "container-doc",
6+
"settings": {
7+
"terminal.integrated.shell.linux": "/bin/bash",
8+
"cSpell.language": ",en"
9+
},
10+
// Install pre-requisites, and start to serve docs.github.com locally
11+
"postCreateCommand": "npm install && npm start",
12+
"forwardPorts": [4000],
13+
// Visual Studio Code extensions which help authoring for docs.github.com.
14+
"extensions": [
15+
"yzhang.markdown-all-in-one",
16+
"streetsidesoftware.code-spell-checker"
17+
]
18+
}

.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.md]
11+
trim_trailing_whitespace = false

.env.example

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
ALGOLIA_API_KEY=
22
ALGOLIA_APPLICATION_ID=
33
ALLOW_TRANSLATION_COMMITS=
4-
EARLY_ACCESS_HOSTNAME=
5-
EARLY_ACCESS_SHARED_SECRET=
6-
GITHUB_TOKEN=

.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

.eslintrc.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
commonjs: true,
5+
es2020: true,
6+
node: true
7+
},
8+
parser: 'babel-eslint',
9+
extends: [
10+
'eslint:recommended',
11+
'standard'
12+
],
13+
parserOptions: {
14+
ecmaVersion: 11
15+
},
16+
rules: {
17+
},
18+
overrides: [
19+
{
20+
files: [
21+
'**/tests/**/*.js'
22+
],
23+
env: {
24+
jest: true
25+
}
26+
}
27+
]
28+
}

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ package.json @github/docs-engineering
2020
# Site Policy
2121
/content/github/site-policy/ @github/site-policy-admins
2222

23+
# Content strategy
24+
/contributing/content-markup-reference.md @github/product-docs-content-strategy
25+
/contributing/content-style-guide.md @github/product-docs-content-strategy
26+
2327
# Make sure that Octokit maintainers get notified about changes
2428
# relevant to the Octokit libraries (https://github.com/octokit)
2529
/content/rest/reference @github/octokit-maintainers

.github/ISSUE_TEMPLATE/improve-existing-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ labels:
77
assignees: ''
88
---
99
<!--
10-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
1111
-->
1212

1313
<!--
1414
For questions, ask in Discussions: https://github.com/github/docs/discussions
1515
16-
Before you file an issue read the:
16+
Before you file an issue read the:
1717
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
1818
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
1919

.github/ISSUE_TEMPLATE/improve-the-site.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ assignees: ''
77
---
88

99
<!--
10-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
1111
-->
1212

1313
<!--
1414
For questions, ask in Discussions: https://github.com/github/docs/discussions
1515
16-
Before you file an issue read the:
16+
Before you file an issue read the:
1717
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
1818
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
1919

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ Thanks again!
2222

2323
### Check off the following:
2424
- [ ] All of the tests are passing.
25-
- [ ] I have reviewed my changes in staging.
25+
- [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**)
2626
- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
2727
- [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/usr/bin/env node
2+
3+
const fs = require('fs')
4+
const core = require('@actions/core')
5+
const eventPayload = JSON.parse(fs.readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8'))
6+
7+
// This workflow-run script does the following:
8+
// 1. Gets an array of labels on a PR.
9+
// 2. Finds one with the relevant Algolia text; if none found, exits early.
10+
// 3. Gets the version substring from the label string.
11+
12+
const labelText = 'sync-english-index-for-'
13+
const labelsArray = eventPayload.pull_request.labels
14+
15+
// Exit early if no labels are on this PR
16+
if (!(labelsArray && labelsArray.length)) {
17+
process.exit(0)
18+
}
19+
20+
// Find the relevant label
21+
const algoliaLabel = labelsArray
22+
.map(label => label.name)
23+
.find(label => label.startsWith(labelText))
24+
25+
// Exit early if no relevant label is found
26+
if (!algoliaLabel) {
27+
process.exit(0)
28+
}
29+
30+
// Given: sync-english-index-for-enterprise-server@3.0
31+
// Returns: enterprise-server@3.0
32+
const versionToSync = algoliaLabel.split(labelText)[1]
33+
34+
// Store the version so we can access it later in the workflow
35+
core.setOutput('versionToSync', versionToSync)
36+
process.exit(0)

0 commit comments

Comments
 (0)