Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

repo sync #25373

Merged
merged 5 commits into from
May 3, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
3 changes: 2 additions & 1 deletion content/apps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GitHub Apps documentation
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/setting-up-a-github-app/about-apps
overview: /apps/overview
layout: product-landing
featuredLinks:
startHere:
Expand All @@ -28,6 +28,7 @@ versions:
topics:
- GitHub Apps
children:
- /overview
- /using-github-apps
- /creating-github-apps
- /maintaining-github-apps
Expand Down
26 changes: 26 additions & 0 deletions content/apps/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: GitHub Apps overview
shortTitle: Overview
intro: 'You can use {% data variables.product.prodname_github_app %}s to extend the functionality of {% data variables.product.company_short %}.'
allowTitleToDifferFromFilename: true
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: overview
topics:
- GitHub Apps
---

## About {% data variables.product.prodname_github_app %}s

{% data variables.product.prodname_github_app %}s are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_app %}s can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}.

For more information about using {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/about-using-github-apps)."

For more information about building {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)."

## {% data variables.product.prodname_github_app %}s and OAuth Apps

{% data variables.product.company_short %} also supports OAuth Apps. In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_app %}s. {% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of the app by limiting the damage that could be done if the app's credentials were leaked. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)."