Skip to content

Commit

Permalink
[Apps overhaul] Restructure the current docs to match the proposed do…
Browse files Browse the repository at this point in the history
…cs structure as closely as possible (github#34664)

Co-authored-by: Sarah Edwards <skedwards88@github.com>
  • Loading branch information
jhosman and skedwards88 authored Feb 14, 2023
1 parent 9d15924 commit 3937238
Show file tree
Hide file tree
Showing 123 changed files with 335 additions and 242 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /apps/building-github-apps/authentication-options-for-github-apps
- /apps/building-github-apps/authenticating-with-github-apps
- /developers/apps/authenticating-with-github-apps
- /developers/apps/building-github-apps/authenticating-with-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps
- /apps/building-github-apps/identifying-and-authorizing-users-for-github-apps
- /developers/apps/identifying-and-authorizing-users-for-github-apps
- /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down Expand Up @@ -914,4 +915,3 @@ While most of your API interaction should occur using your server-to-server inst
## Further reading

- "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github#githubs-token-formats)"

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Authenticating with a {% data variables.product.prodname_github_app %}
intro: 'Learn how to set up authentication options for {% data variables.product.prodname_github_apps %}.'
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /authenticating-with-github-apps
- /identifying-and-authorizing-users-for-github-apps
- /refreshing-user-to-server-access-tokens
---
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'To enforce regular token rotation and reduce the impact of a compromised
redirect_from:
- /apps/building-github-apps/refreshing-user-to-server-access-tokens
- /developers/apps/refreshing-user-to-server-access-tokens
- /developers/apps/building-github-apps/refreshing-user-to-server-access-tokens
versions:
fpt: '*'
ghes: '*'
Expand All @@ -19,7 +20,7 @@ shortTitle: Refresh user-to-server access

To enforce regular token rotation and reduce the impact of a compromised token, you can configure your {% data variables.product.prodname_github_app %} to use expiring user access tokens. For more information on making user-to-server requests, see "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)."

Expiring user tokens expire after 8 hours. When you receive a new user-to-server access token, the response will also contain a refresh token, which can be exchanged for a new user token and refresh token. Refresh tokens are valid for 6 months.
Expiring user tokens expire after 8 hours. When you receive a new user-to-server access token, the response will also contain a refresh token, which can be exchanged for a new user token and refresh token. Refresh tokens are valid for 6 months.

## Renewing a user token with a refresh token

Expand Down Expand Up @@ -60,7 +61,7 @@ You can enable or disable expiring user-to-server authorization tokens from your
4. Click **Edit** next to your chosen {% data variables.product.prodname_github_app %}.
![Settings to edit a GitHub App](/assets/images/github-apps/edit-test-app.png)
5. In the left sidebar, click **Optional Features**.
![Optional features tab](/assets/images/github-apps/optional-features-option.png)
![Optional features tab](/assets/images/github-apps/optional-features-option.png)
6. Next to "User-to-server token expiration", click **Opt-in** or **Opt-out**. This setting may take a couple of seconds to apply.

## Opting out of expiring tokens for new GitHub Apps
Expand All @@ -78,4 +79,3 @@ Enabling expiring user tokens for existing {% data variables.product.prodname_gi
## Further reading

- "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github#githubs-token-formats)"

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:
- /apps/getting-started-with-building-apps
- /apps/about-apps
- /developers/apps/about-apps
- /developers/apps/getting-started-with-apps/about-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: '{% data reusables.shortdesc.creating_custom_badges_github_apps %}'
redirect_from:
- /apps/building-github-apps/creating-custom-badges-for-github-apps
- /developers/apps/creating-a-custom-badge-for-your-github-app
- /developers/apps/building-github-apps/creating-a-custom-badge-for-your-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'A GitHub App Manifest is a preconfigured GitHub App you can share with a
redirect_from:
- /apps/building-github-apps/creating-github-apps-from-a-manifest
- /developers/apps/creating-a-github-app-from-a-manifest
- /developers/apps/building-github-apps/creating-a-github-app-from-a-manifest
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'You can preselect the settings of a new {% data variables.product.prodna
redirect_from:
- /apps/building-github-apps/creating-github-apps-using-url-parameters
- /developers/apps/creating-a-github-app-using-url-parameters
- /developers/apps/building-github-apps/creating-a-github-app-using-url-parameters
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps
- /apps/building-github-apps/creating-a-github-app
- /developers/apps/creating-a-github-app
- /developers/apps/building-github-apps/creating-a-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type
- /apps/differences-between-apps
- /developers/apps/differences-between-github-apps-and-oauth-apps
- /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
23 changes: 23 additions & 0 deletions content/apps/creating-github-apps/creating-github-apps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: 'Creating {% data variables.product.prodname_github_apps %}'
intro: 'Learn about building {% data variables.product.prodname_github_apps %}.'
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
redirect_from:
- /apps/building-github-apps
topics:
- GitHub Apps
children:
- /about-apps
- /differences-between-github-apps-and-oauth-apps
- /rate-limits-for-github-apps
- /creating-a-github-app
- /setting-permissions-for-github-apps
- /making-a-github-app-public-or-private
- /creating-a-github-app-from-a-manifest
- /creating-a-github-app-using-url-parameters
- /creating-a-custom-badge-for-your-github-app
---
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ redirect_from:
- /apps/managing-github-apps/changing-a-github-app-s-installation-option
- /apps/managing-github-apps/making-a-github-app-public-or-private
- /developers/apps/making-a-github-app-public-or-private
- /developers/apps/managing-github-apps/making-a-github-app-public-or-private
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:
- /apps/building-github-apps/rate-limits-for-github-apps
- /apps/building-github-apps/understanding-rate-limits-for-github-apps
- /developers/apps/rate-limits-for-github-apps
- /developers/apps/building-github-apps/rate-limits-for-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /apps/building-github-apps/permissions-for-github-apps
- /apps/building-github-apps/setting-permissions-for-github-apps
- /developers/apps/setting-permissions-for-github-apps
- /developers/apps/building-github-apps/setting-permissions-for-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'Build a continuous integration server to run tests using a {% data varia
redirect_from:
- /apps/quickstart-guides/creating-ci-tests-with-the-checks-api
- /developers/apps/creating-ci-tests-with-the-checks-api
- /developers/apps/guides/creating-ci-tests-with-the-checks-api
versions:
fpt: '*'
ghes: '*'
Expand Down Expand Up @@ -145,7 +146,7 @@ def create_check_run
@payload['repository']['full_name'],
# [String] The name of your check run.
'Octo RuboCop',
# [String] The SHA of the commit to check
# [String] The SHA of the commit to check
# The payload structure differs depending on whether a check run or a check suite event occurred.
@payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'],
# [Hash] 'Accept' header option, to avoid a warning about the API not being ready for production use.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Guides
intro: 'Learn about using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API with your app, continuous integration, and how to build with apps.'
redirect_from:
- /apps/quickstart-guides
- /developers/apps/guides
versions:
fpt: '*'
ghes: '*'
Expand All @@ -11,7 +12,8 @@ versions:
topics:
- GitHub Apps
children:
- /using-the-github-api-in-your-app
- /setting-up-your-development-environment-to-create-a-github-app
- /creating-ci-tests-with-the-checks-api
- /using-the-github-api-in-your-app
- /migrating-oauth-apps-to-github-apps
---

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'Learn about the advantages of migrating your {% data variables.product.p
redirect_from:
- /apps/migrating-oauth-apps-to-github-apps
- /developers/apps/migrating-oauth-apps-to-github-apps
- /developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'Learn the foundations for extending and building new {% data variables.p
redirect_from:
- /apps/quickstart-guides/setting-up-your-development-environment
- /developers/apps/setting-up-your-development-environment-to-create-a-github-app
- /developers/apps/getting-started-with-apps/setting-up-your-development-environment-to-create-a-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /apps/building-your-first-github-app
- /apps/quickstart-guides/using-the-github-api-in-your-app
- /developers/apps/using-the-github-api-in-your-app
- /developers/apps/guides/using-the-github-api-in-your-app
versions:
fpt: '*'
ghes: '*'
Expand Down
18 changes: 18 additions & 0 deletions content/apps/creating-github-apps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: 'Creating GitHub Apps'
intro: You can build GitHub Apps for yourself or others to use.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /creating-github-apps
- /authenticating-with-a-github-app
- /guides
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps
- /developers/apps/building-github-apps
---
48 changes: 48 additions & 0 deletions content/apps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Apps
shortTitle: Apps
intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs and webhooks, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.'
introLinks:
About apps: /apps/creating-github-apps/building-github-apps/about-apps
layout: product-landing
featuredLinks:
startHere:
- /apps/creating-github-apps/creating-github-apps/about-apps
- /apps/creating-github-apps/creating-github-apps/differences-between-github-apps-and-oauth-apps
- /apps/creating-github-apps/creating-github-apps/creating-a-github-app
- /apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-github-apps
- /apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps
popular:
- /apps/creating-github-apps/creating-github-apps/creating-a-github-app
- /apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-github-apps
- /apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace
guideCards:
- /apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api
- /apps/creating-github-apps/guides/using-the-github-api-in-your-app
changelog:
label: apps
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- GitHub Apps
children:
- /using-github-apps
- /creating-github-apps
- /publishing-apps-to-github-marketplace
- /maintaining-github-apps
- /oauth-apps
redirect_from:
- /developers
- /developers/apps/getting-started-with-apps
- /early-access/integrations
- /early-access/integrations/authentication
- /early-access/integrations/install-an-integration
- /apps/adding-integrations
- /apps/building-integrations/setting-up-a-new-integration/about-integrations
- /apps
- /v3/integrations
- /developers/apps
---
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'You can test new optional features for your {% data variables.product.pr
redirect_from:
- /developers/apps/activating-beta-features-for-apps
- /developers/apps/activating-optional-features-for-apps
- /developers/apps/getting-started-with-apps/activating-optional-features-for-apps
versions:
fpt: '*'
ghae: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /apps/building-integrations/managing-github-apps/deleting-a-github-app
- /apps/managing-github-apps/deleting-a-github-app
- /developers/apps/deleting-a-github-app
- /developers/apps/managing-github-apps/deleting-a-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions
- /apps/managing-github-apps/editing-a-github-app-s-permissions
- /developers/apps/editing-a-github-apps-permissions
- /developers/apps/managing-github-apps/editing-a-github-apps-permissions
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Managing GitHub Apps
intro: 'After you create and register a GitHub App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.'
title: Maintaining {% data variables.product.prodname_github_apps %}
intro: 'After you create and register a {% data variables.product.prodname_github_app %}, you can make modifications to the app, change permissions, transfer ownership, and delete the app.'
redirect_from:
- /apps/building-integrations/managing-github-apps
- /apps/managing-github-apps
- /developers/apps/managing-github-apps
versions:
fpt: '*'
ghes: '*'
Expand All @@ -12,12 +13,12 @@ versions:
topics:
- GitHub Apps
children:
- /installing-github-apps
- /modifying-a-github-app
- /editing-a-github-apps-permissions
- /making-a-github-app-public-or-private
- /managing-allowed-ip-addresses-for-a-github-app
- /installing-github-apps
- /activating-optional-features-for-apps
- /suspending-a-github-app-installation
- /transferring-ownership-of-a-github-app
- /deleting-a-github-app
---

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'When your app is public, anyone can use {% ifversion fpt or ghec %} the
redirect_from:
- /apps/installing-github-apps
- /developers/apps/installing-github-apps
- /developers/apps/managing-github-apps/installing-github-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
topics:
- GitHub Apps
shortTitle: Manage allowed IP addresses
redirect_from:
- /developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app
---

## About IP address allow lists for {% data variables.product.prodname_github_apps %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /apps/building-integrations/managing-github-apps/modifying-a-github-app
- /apps/managing-github-apps/modifying-a-github-app
- /developers/apps/modifying-a-github-app
- /developers/apps/managing-github-apps/modifying-a-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: '{% data reusables.shortdesc.suspending_a_github_app %}'
redirect_from:
- /apps/managing-github-apps/suspending-a-github-app-installation
- /developers/apps/suspending-a-github-app-installation
- /developers/apps/managing-github-apps/suspending-a-github-app-installation
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app
- /apps/managing-github-apps/transferring-ownership-of-a-github-app
- /developers/apps/transferring-ownership-of-a-github-app
- /developers/apps/managing-github-apps/transferring-ownership-of-a-github-app
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ redirect_from:
- /apps/building-oauth-apps/authorization-options-for-oauth-apps
- /apps/building-oauth-apps/authorizing-oauth-apps
- /developers/apps/authorizing-oauth-apps
- /developers/apps/building-oauth-apps/authorizing-oauth-apps
versions:
fpt: '*'
ghes: '*'
Expand Down
Loading

0 comments on commit 3937238

Please sign in to comment.