From dbdb8868a817bba7fa085bc897b913435c5cad07 Mon Sep 17 00:00:00 2001 From: pr0PM Date: Tue, 10 Nov 2020 19:15:54 +0530 Subject: [PATCH 1/9] Fixes #1190 --- content/developers/overview/about-githubs-apis.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md index 39e74b19f1e3..656d13605ec8 100644 --- a/content/developers/overview/about-githubs-apis.md +++ b/content/developers/overview/about-githubs-apis.md @@ -9,11 +9,9 @@ versions: github-ae: '*' --- -There are two stable versions of the GitHub API: the [REST API](/v3/) and the [GraphQL API](/v4/). - -When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version). - -For information on using the GraphQL API, see the [v4 docs](/v4/). +You can use the stable GitHub API via: +- [GraphQL API](https://docs.github.com/en/free-pro-team@latest/v4) +- [REST API](https://docs.github.com/en/free-pro-team@latest/v3) where we encourage you to [request v3 via the `Accept` header.](https://docs.github.com/en/free-pro-team@latest/v3/media/#request-specific-version) ## Deprecated versions From 486973a5a34fc17888d1af4e8aa5ae34d5ea8e86 Mon Sep 17 00:00:00 2001 From: Diego Assencio Date: Tue, 1 Dec 2020 13:34:00 +0100 Subject: [PATCH 2/9] Add missing space --- content/admin/overview/about-enterprise-accounts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 02c92ad31de7..26731d2fac88 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)." From 891705583011e4bf8c81adcadf575599fefcafd8 Mon Sep 17 00:00:00 2001 From: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> Date: Wed, 2 Dec 2020 16:01:51 -0600 Subject: [PATCH 3/9] Add entry for indentation to style guide (#16728) * Add entry for indentation * Update contributing/content-style-guide.md Co-authored-by: Laura Coursen Co-authored-by: Laura Coursen --- contributing/content-style-guide.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 7bdee3207c4f..1603764c1d10 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. From 4e1d62b91a424c9c345af5d941e047af9bb32fb0 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 2 Dec 2020 16:07:56 -0600 Subject: [PATCH 4/9] Remove free-pro-team support from Spanish translation of Insights doc (#16730) * Remove free-pro-team support from Spanish translation of Insights doc * Throw errors for mismatched products in non-English content pages as well --- lib/page.js | 2 +- tests/unit/page.js | 14 +++++++++++++- .../updating-github-insights.md | 1 - 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/lib/page.js b/lib/page.js index c97e49470f7f..75cf90210e68 100644 --- a/lib/page.js +++ b/lib/page.js @@ -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!`) } diff --git a/tests/unit/page.js b/tests/unit/page.js index 0f44158b09b3..5d1b46a0c3ad 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 809cb0f65909..f8576d1013ac 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: '*' --- From 42f6e614be75c747fde95b96dfaa4476b4d1b9ff Mon Sep 17 00:00:00 2001 From: Arhell Date: Thu, 3 Dec 2020 00:50:19 +0200 Subject: [PATCH 5/9] fix dropdown on mobile --- includes/article-version-switcher.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/article-version-switcher.html b/includes/article-version-switcher.html index c422bc853f44..96b1732a3a49 100644 --- a/includes/article-version-switcher.html +++ b/includes/article-version-switcher.html @@ -6,7 +6,7 @@ -
+
{% for permalink in page.permalinks %} Date: Thu, 3 Dec 2020 01:34:52 +0100 Subject: [PATCH 6/9] Repository.deleted events are not exclusive to org webhooks (#16719) Fixes https://github.com/github/internal-developer.github.com/issues/2948 and fixes https://github.com/github/ecosystem-api/issues/1028 Co-authored-by: Lucas Costi --- .../webhooks-and-events/webhook-events-and-payloads.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 f48511fa6281..9890c7b0aaab 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:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
  • `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)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
+`action` |`string` | The action that was performed. This can be one of:
  • `created` - A repository is created.
  • `deleted` - A repository is deleted.
  • `archived` - A repository is archived.
  • `unarchived` - A repository is unarchived.
    • {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
  • `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)
    • {% endif %}
  • `edited` - A repository's information is edited.
  • `renamed` - A repository is renamed.
  • `transferred` - A repository is transferred.
  • `publicized` - A repository is made public.
  • `privatized` - A repository is made private.
{% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} From eb1556d78eca1fe07136571a3fb64796728e051a Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Thu, 3 Dec 2020 11:45:01 +1000 Subject: [PATCH 7/9] Fix Actions link to community support category (#16733) --- data/reusables/github-actions/contacting-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/github-actions/contacting-support.md b/data/reusables/github-actions/contacting-support.md index c3d307a40523..d4bcb7c776ce 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 %}. From 7672308ae8c22e71c6d695051e36fffca1a4cc01 Mon Sep 17 00:00:00 2001 From: Hamel Husain Date: Wed, 2 Dec 2020 18:03:13 -0800 Subject: [PATCH 8/9] Update libraries.md (#1607) Co-authored-by: Sarah Edwards --- content/rest/overview/libraries.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index a1f11fa03b9a..f72b9b3b656b 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) From 04223cf1b7f3735cda808d300804e72526787455 Mon Sep 17 00:00:00 2001 From: pr0PM Date: Thu, 3 Dec 2020 16:17:45 +0530 Subject: [PATCH 9/9] Update content/developers/overview/about-githubs-apis.md Applying suggested changes. Co-authored-by: Laura Coursen --- content/developers/overview/about-githubs-apis.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md index 656d13605ec8..d69bd27b40f0 100644 --- a/content/developers/overview/about-githubs-apis.md +++ b/content/developers/overview/about-githubs-apis.md @@ -9,9 +9,7 @@ versions: github-ae: '*' --- -You can use the stable GitHub API via: -- [GraphQL API](https://docs.github.com/en/free-pro-team@latest/v4) -- [REST API](https://docs.github.com/en/free-pro-team@latest/v3) where we encourage you to [request v3 via the `Accept` header.](https://docs.github.com/en/free-pro-team@latest/v3/media/#request-specific-version) +There are two stable versions of the GitHub API: the [REST API](/v3/) and the [GraphQL API](/v4/). When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version). For information on using the GraphQL API, see the [v4 docs](/v4/). ## Deprecated versions