Merge branch 'main' of github.com:github/docs-internal into hidden-docs-alt
This commit is contained in:
4
.github/CODEOWNERS
vendored
4
.github/CODEOWNERS
vendored
@@ -20,6 +20,10 @@ package.json @github/docs-engineering
|
||||
# Site Policy
|
||||
/content/github/site-policy/ @github/site-policy-admins
|
||||
|
||||
# Content strategy
|
||||
/contributing/content-markup-reference.md @github/product-docs-content-strategy
|
||||
/contributing/content-style-guide.md @github/product-docs-content-strategy
|
||||
|
||||
# Make sure that Octokit maintainers get notified about changes
|
||||
# relevant to the Octokit libraries (https://github.com/octokit)
|
||||
/content/rest/reference @github/octokit-maintainers
|
||||
|
||||
@@ -28,7 +28,7 @@ To generate a private key:
|
||||
{% data reusables.user-settings.developer_settings %}
|
||||
{% data reusables.user-settings.github_apps %}
|
||||
{% data reusables.user-settings.modify_github_app %}
|
||||
5. In "Private keys," click **Generate a private key**.
|
||||
5. In "Private keys", click **Generate a private key**.
|
||||

|
||||
6. You will see a private key in PEM format downloaded to your computer. Make sure to store this file because GitHub only stores the public portion of the key.
|
||||
|
||||
|
||||
@@ -1046,7 +1046,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
|
||||
|
||||
Key | Type | Description
|
||||
----|------|-------------
|
||||
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
||||
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted.</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
|
||||
@@ -25,6 +25,7 @@ With issue and pull request search terms, you can:
|
||||
- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat`
|
||||
- Filter issues and pull requests by assignee: `state:open type:issue assignee:octocat`
|
||||
- Filter issues and pull requests by label: `state:open type:issue label:"bug"`
|
||||
- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat`
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
|
||||
For issues, you can also use search to:
|
||||
|
||||
@@ -111,6 +111,7 @@ Library name | Repository
|
||||
|
||||
Library name | Repository
|
||||
|---|---|
|
||||
**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi)
|
||||
**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub)
|
||||
**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas)
|
||||
**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py)
|
||||
|
||||
@@ -12,6 +12,7 @@ These guidelines are specific to GitHub’s documentation. For general style que
|
||||
- [Code blocks](#code-blocks)
|
||||
- [Commands](#commands)
|
||||
- [Examples](#examples)
|
||||
- [Indentation](#indentation)
|
||||
- [Headers](#headers)
|
||||
- [Images](#images)
|
||||
- [Alt text](#alt-text)
|
||||
@@ -129,6 +130,21 @@ schedule:
|
||||
- cron: "40 19 * * *"
|
||||
```
|
||||
|
||||
### Indentation
|
||||
|
||||
In YAML examples, such as actions and workflow files, use two spaces to indent lines within nested lists and block sequences.
|
||||
|
||||
- **Use:**
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: ${{ matrix.python }}
|
||||
```
|
||||
|
||||
## Headers
|
||||
|
||||
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
If you need help with anything related to workflow configuration, such as syntax, {% data variables.product.prodname_dotcom %}-hosted runners, or building actions, look for an existing topic or start a new one in the [{% data variables.product.prodname_gcf %}'s {% data variables.product.prodname_actions %} board](https://github.community/c/github-actions).
|
||||
If you need help with anything related to workflow configuration, such as syntax, {% data variables.product.prodname_dotcom %}-hosted runners, or building actions, look for an existing topic or start a new one in the [{% data variables.product.prodname_gcf %}'s {% data variables.product.prodname_actions %} category](https://github.community/c/code-to-cloud/github-actions/41).
|
||||
|
||||
If you have feedback or feature requests for {% data variables.product.prodname_actions %}, share those in the {% data variables.contact.contact_feedback_actions %}.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ You need an access token to publish, install, and delete packages. You can use a
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
To authenticate using a {% data variables.product.prodname_actions %} workflow:
|
||||
- For package registries (`PACKAGE-REGISTRY.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`), you can use a `GITHUB_TOKEN`.
|
||||
- For package registries (`PACKAGE-REGISTRY.pkg.github.com`), you can use a `GITHUB_TOKEN`.
|
||||
- For the container registry (`ghcr.io/OWNER/IMAGE-NAME`), you must use a personal access token.
|
||||
{% else %}
|
||||
To authenticate to {% data variables.product.prodname_registry %} using a {% data variables.product.prodname_actions %} workflow, you must use `GITHUB_TOKEN`.
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<svg class="arrow ml-1" width="14px" height="8px" viewBox="0 0 14 8" xml:space="preserve" fill="none" stroke="#1277eb"><path d="M1,1l6.2,6L13,1"></path></svg>
|
||||
</summary>
|
||||
|
||||
<div class="nav-dropdown position-md-absolute bg-white rounded-1 px-4 py-3 top-7 box-shadow-large" style="z-index: 6; width: 210px;">
|
||||
<div class="nav-dropdown position-absolute bg-white rounded-1 px-4 py-3 top-7 box-shadow-large" style="z-index: 6; width: 210px;">
|
||||
{% for permalink in page.permalinks %}
|
||||
<a
|
||||
href="{{ permalink.href }}"
|
||||
|
||||
@@ -65,7 +65,7 @@ class Page {
|
||||
// only the homepage will not have this.parentProduct
|
||||
.filter(availableVersion => this.parentProduct && !this.parentProduct.versions.includes(availableVersion))
|
||||
|
||||
if (versionsParentProductIsNotAvailableIn.length && this.languageCode === 'en') {
|
||||
if (versionsParentProductIsNotAvailableIn.length) {
|
||||
throw new Error(`\`versions\` frontmatter in ${this.fullPath} contains ${versionsParentProductIsNotAvailableIn}, which ${this.parentProduct.id} product is not available in!`)
|
||||
}
|
||||
|
||||
|
||||
@@ -389,7 +389,7 @@ describe('catches errors thrown in Page class', () => {
|
||||
expect(getPage).toThrowError('versions')
|
||||
})
|
||||
|
||||
test('page with a version in frontmatter that its parent product is not available in', () => {
|
||||
test('English page with a version in frontmatter that its parent product is not available in', () => {
|
||||
function getPage () {
|
||||
return new Page({
|
||||
relativePath: 'admin/some-category/some-article-with-mismatched-versions-frontmatter.md',
|
||||
@@ -400,4 +400,16 @@ describe('catches errors thrown in Page class', () => {
|
||||
|
||||
expect(getPage).toThrowError(/`versions` frontmatter.*? product is not available in/)
|
||||
})
|
||||
|
||||
test('non-English page with a version in frontmatter that its parent product is not available in', () => {
|
||||
function getPage () {
|
||||
return new Page({
|
||||
relativePath: 'admin/some-category/some-article-with-mismatched-versions-frontmatter.md',
|
||||
basePath: path.join(__dirname, '../fixtures/products'),
|
||||
languageCode: 'es'
|
||||
})
|
||||
}
|
||||
|
||||
expect(getPage).toThrowError(/`versions` frontmatter.*? product is not available in/)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -6,7 +6,6 @@ redirect_from:
|
||||
- /github/installing-and-configuring-github-insights/updating-github-insights
|
||||
permissions: 'Las personas con permisos de lectura para el repositorio de `github/insights-releases` y el acceso administrativo al servidor de aplicaciones pueden actualizar {% data variables.product.prodname_insights %}.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user