Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/instructions/content.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ Examples:
* ❌ Incorrect: `For more information, see [Using GitHub Copilot](/copilot/using-github-copilot).`
* ❌ Incorrect: `For more information, see {% link /copilot/using-github-copilot %}.`

## RAI application and platform cards

Articles with `contentType: rai` in their frontmatter are **application or platform cards**—legally mandated documents describing the responsible use of AI-powered features. The content linter enforces the required section structure (GHD064) and reusable isolation (GHD035).

* **Template**: See `content/contributing/writing-for-github-docs/templates.md` for the full application/platform card template with all required sections and boilerplate reusables.
* **Reusables**: RAI articles must only reference reusables from `data/reusables/rai/`. Place new RAI reusables there too.
* **Frontmatter**: New application cards use `contentType: rai`. The older `type: rai` is for legacy transparency notes not yet migrated.

## Parenthetical dashes

Where a sentence of normal body text contains a parenthetical dash, the dash should always be an em dash without spaces at either side. This rule does not apply to text within code blocks.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ For high availability, you can designate a replica node as your backup server. T
> [!IMPORTANT]
> Backups from cache replica nodes or active geo replica nodes are not supported.
To configure your backup server, run the following commands, replacing `HOSTNAME` with the hostname of the node:
To configure your backup server on a replica, run the following commands. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service).

```shell
ghe-config cluster.HOSTNAME.backup-server true
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME

ghe-config-apply
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ For clustering, you can designate a node as your backup server. To minimize late
> [!IMPORTANT]
> Only one node can be specified as a `backup-server` node.

1. To configure your backup server, set up a backup disk on one of the cluster nodes of your choice. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service).
1. To configure your backup server, run the following commands to set up a backup disk on one of the cluster nodes of your choice. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service).

1. After `ghe-storage-init-backup` is executed, the `backup-server` role will be set on this cluster node. You can now run `ghe-backup` directly on this node, or use the management console to schedule backups.
```shell
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME

ghe-config-apply
```

1. After `ghe-config-apply` is executed, the `backup-server` role will be set on this cluster node. You can now run `ghe-backup` directly on this node, or use the management console to schedule backups.
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ If the device was already initialized using `ghe-storage-init-backup`, you can r
### Configuring backup settings
After the backup target is mounted, the Backup Service page will become available in the {% data variables.enterprise.management_console %} in the "Backup" section. {% ifversion ghes > 3.19 %} If your instance is part of a clustered environment, the system will automatically detect the node that was initialized with `ghe-storage-init-backup` and treat it as the backup server. {% endif %}
After the backup target is mounted, the Backup Service page will become available in the {% data variables.enterprise.management_console %} in the "Backup" section. {% ifversion ghes > 3.19 %} If your instance is part of a clustered environment, the Backup Service page will be available after `ghe-config-apply`. {% endif %}
>[!NOTE] The settings page won’t appear until the backup storage is mounted at `/data/backup` by completing the initialization or mount steps above.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ redirect_from:
- /developers/apps/about-apps
- /developers/apps/getting-started-with-apps/about-apps
- /apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps
topics:
- GitHub Apps
---

## About {% data variables.product.prodname_github_apps %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## Using a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /about-creating-github-apps
- /deciding-when-to-build-a-github-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: 'Migrate from {% data variables.product.prodname_oauth_apps %}'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: About authentication
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About authentication as a {% data variables.product.prodname_github_app %} installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Authenticate as an app
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

Your app can make API requests on behalf of a user. API requests made by an app on behalf of a user will be attributed to that user. For example, if your app posts a comment on behalf of a user, the {% data variables.product.company_short %} UI will show the user's avatar photo along with the app's identicon badge as the author of the issue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About JSON Web Tokens (JWTs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Generate a user access token
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About installation access tokens
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /about-authentication-with-a-github-app
- /authenticating-as-a-github-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
- Actions
redirect_from:
- /apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow
- /apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About private keys for {% data variables.product.prodname_github_apps %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Refresh user access tokens
---
## About user access tokens that expire
Expand Down
2 changes: 0 additions & 2 deletions content/apps/creating-github-apps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /about-creating-github-apps
- /registering-a-github-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Setup URL
redirect_from:
- /apps/creating-github-apps/setting-up-a-github-app/about-the-setup-url
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Callback URL
redirect_from:
- /apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About {% data variables.product.prodname_github_app %} permissions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Custom badge
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ redirect_from:
- /apps/building-github-apps
- /apps/creating-github-apps/creating-github-apps
- /apps/creating-github-apps/setting-up-a-github-app
topics:
- GitHub Apps
children:
- /registering-a-github-app
- /about-the-user-authorization-callback-url
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Visibility
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
shortTitle: Rate limits
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---

## About registering {% data variables.product.prodname_github_apps %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps
- /apps/creating-github-apps/setting-up-a-github-app/using-webhooks-with-github-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/building-your-first-github-app
- /apps/quickstart-guides/using-the-github-api-in-your-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/guides/building-a-cli-with-a-github-app
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events
layout: inline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/guides/using-the-web-application-flow-to-generate-a-user-access-token-for-a-github-app
- /apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
---
## Introduction

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /about-writing-code-for-a-github-app
- /quickstart
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- GitHub Apps
redirect_from:
- /apps/creating-github-apps/guides/quickstart
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ shortTitle: Customer experience best practice
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
redirect_from:
- /developers/github-marketplace/customer-experience-best-practices-for-apps
- /developers/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ intro: 'You can list free and paid tools for developers to use in {% data variab
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
children:
- /requirements-for-listing-an-app
- /security-best-practices-for-apps-on-github-marketplace
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ redirect_from:
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
shortTitle: Listing requirements
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ shortTitle: Security best practice
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
---

{% data reusables.marketplace.marketplace-apps-not-actions %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ redirect_from:
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
shortTitle: View listing metrics
---

Expand Down
Loading