Skip to content

Commit

Permalink
Merge branch 'main' into experiment-with-react-and-mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
heiskr authored Dec 3, 2020
2 parents f89c983 + c1d7d83 commit 92ba8d9
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 12 deletions.
2 changes: 1 addition & 1 deletion content/admin/overview/about-enterprise-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)."
Expand Down
6 changes: 1 addition & 5 deletions content/developers/overview/about-githubs-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ versions:
github-ae: '*'
---

There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql).

When using the REST API, we encourage you to [request v3 via the `Accept` header](/rest/overview/media-types#request-specific-version).

For information on using the GraphQL API, see the [v4 docs](/graphql).
There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). 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](/graphql).

## Deprecated versions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
1 change: 1 addition & 0 deletions content/rest/overview/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 16 additions & 0 deletions contributing/content-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/github-actions/contacting-support.md
Original file line number Diff line number Diff line change
@@ -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 %}.

Expand Down
2 changes: 1 addition & 1 deletion includes/article-version-switcher.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}"
Expand Down
2 changes: 1 addition & 1 deletion lib/page.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,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!`)
}

Expand Down
14 changes: 13 additions & 1 deletion tests/unit/page.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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/)
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
---

Expand Down

0 comments on commit 92ba8d9

Please sign in to comment.