diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 3eb7f05d40..49b7490204 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -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 diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 02c92ad31d..26731d2fac 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -15,7 +15,7 @@ An enterprise account allows you to manage multiple organizations{% if enterpris - Member access and management (organization members, outside collaborators){% if enterpriseServerVersions contains currentVersion %} - Billing and usage ({% data variables.product.prodname_ghe_server %} instances, user licenses, {% data variables.large_files.product_name_short %} packs){% endif %} -- Security{% if enterpriseServerVersions contains currentVersion %}(single sign-on, two factor authentication) +- Security {% if enterpriseServerVersions contains currentVersion %}(single sign-on, two factor authentication) - Requests {% if enterpriseServerVersions contains currentVersion %}and support bundle sharing {% endif %}with {% data variables.contact.enterprise_support %}{% endif %} {% if enterpriseServerVersions contains currentVersion %}{% data reusables.enterprise-accounts.enterprise-accounts-billing %} For more information about managing your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." {% endif %}For more information about managing your {% data variables.product.product_name %} billing settings, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." diff --git a/content/developers/apps/authenticating-with-github-apps.md b/content/developers/apps/authenticating-with-github-apps.md index 27150cc195..c09dc6e3de 100644 --- a/content/developers/apps/authenticating-with-github-apps.md +++ b/content/developers/apps/authenticating-with-github-apps.md @@ -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**. ![Generate private key](/assets/images/github-apps/github_apps_generate_private_keys.png) 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. diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index f48511fa62..9890c7b0aa 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -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: +`action` |`string` | The action that was performed. This can be one of: {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} diff --git a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md index fcb3518947..4b978b4222 100644 --- a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md @@ -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: diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index a1f11fa03b..f72b9b3b65 100644 --- a/content/rest/overview/libraries.md +++ b/content/rest/overview/libraries.md @@ -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) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 7bdee3207c..1603764c1d 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -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. diff --git a/data/reusables/github-actions/contacting-support.md b/data/reusables/github-actions/contacting-support.md index c3d307a405..d4bcb7c776 100644 --- a/data/reusables/github-actions/contacting-support.md +++ b/data/reusables/github-actions/contacting-support.md @@ -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 %}. diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index 11de4d874f..64b208d748 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -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`. diff --git a/includes/article-version-switcher.html b/includes/article-version-switcher.html index c422bc853f..96b1732a3a 100644 --- a/includes/article-version-switcher.html +++ b/includes/article-version-switcher.html @@ -6,7 +6,7 @@ -
+
{% for permalink in page.permalinks %} 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!`) } diff --git a/tests/unit/page.js b/tests/unit/page.js index 0f44158b09..5d1b46a0c3 100644 --- a/tests/unit/page.js +++ b/tests/unit/page.js @@ -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/) + }) }) diff --git a/translations/es-XL/content/insights/installing-and-configuring-github-insights/updating-github-insights.md b/translations/es-XL/content/insights/installing-and-configuring-github-insights/updating-github-insights.md index 809cb0f659..f8576d1013 100644 --- a/translations/es-XL/content/insights/installing-and-configuring-github-insights/updating-github-insights.md +++ b/translations/es-XL/content/insights/installing-and-configuring-github-insights/updating-github-insights.md @@ -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: '*' ---