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.

Sign up for GitHub

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

Added links to docs: for words that mention organizations and authen… #35541

Closed
wants to merge 1 commit into from
Closed

Added links to docs: for words that mention organizations and authen… #35541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions ...s/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About creating GitHub Apps
shortTitle: About creating apps
title: About Creating GitHub Apps
shortTitle: Creating Apps
intro: '{% data variables.product.prodname_github_apps %} let you build integrations to automate processes and extend {% data variables.product.company_short %}''s functionality.'
versions:
fpt: '*'
Expand Down Expand Up @@ -31,10 +31,10 @@

Like {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} use OAuth 2.0 and can act on behalf of a user. Unlike {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can also act independently of a user.

{% data variables.product.prodname_github_apps %} can be installed directly on organizations and personal accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions.
{% data variables.product.prodname_github_apps %} can be installed directly on [organizations](https://docs.github.com/organizations) and personal accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions.

Check failure on line 34 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.

{% ifversion enterprise-apps-public-beta %}
You can also create an enterprise-owned {% data variables.product.prodname_github_app %} that can only be installed on organizations within your enterprise, and can only be authorized by members of your enterprise. For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-github-apps-for-your-enterprise)."
You can also create an enterprise-owned {% data variables.product.prodname_github_app %} that can only be installed on [organizations](https://docs.github.com/organizations) within your enterprise, and can only be authorized by members of your enterprise. For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-github-apps-for-your-enterprise)."

Check failure on line 37 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.
{% endif %}

{% data reusables.apps.app_manager_role %}
Expand All @@ -42,15 +42,15 @@
## Building a {% data variables.product.prodname_github_app %}

In order to build a {% data variables.product.prodname_github_app %}, you first need to register a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)."

Check failure on line 45 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / test-changed-content

Error 

Unable to find Page by '/apps/creating-github-apps/authenticating-with-a-github-app/about-%5Bauthentication%5D(https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)-with-a-github-app'.
    To fix it, look at content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md on line 45 and see if the link is correct and active.
Then, you need to write code to add functionality to your {% data variables.product.prodname_github_app %}. You can use the credentials from your {% data variables.product.prodname_github_app %} registration to make authenticated requests to {% data variables.product.company_short %}'s APIs. For more information about writing code for your {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/about-writing-code-for-a-github-app)." For more information about making authenticated requests, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)."
Then, you need to write code to add functionality to your {% data variables.product.prodname_github_app %}. You can use the credentials from your {% data variables.product.prodname_github_app %} registration to make authenticated requests to {% data variables.product.company_short %}'s APIs. For more information about writing code for your {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/about-writing-code-for-a-github-app)." For more information about making authenticated requests, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-[authentication](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)-with-a-github-app)."

Check failure on line 46 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.

Check failure on line 47 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / check-links

Error 

Unable to find Page by '/apps/creating-github-apps/authenticating-with-a-github-app/about-%5Bauthentication%5D(https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)-with-a-github-app'.
    To fix it, look at content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md on line 47 and see if the link is correct and active.
Once you have written the code for your {% data variables.product.prodname_github_app %}, your app needs to run somewhere. If your app is a website or web app, you might host your app on a server like [Azure App Service](https://azure.microsoft.com/products/app-service/). If your app is a client-side app, it might run on a user's device.

Check failure on line 49 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / check-links

Error 

Unable to find Page by '/apps/creating-github-apps/authenticating-with-a-github-app/about-%5Bauthentication%5D(https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)-with-a-github-app'.
    To fix it, look at content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md on line 49 and see if the link is correct and active.
To use your {% data variables.product.prodname_github_app %}, you need to install it on your organization or personal account.

* If your {% data variables.product.prodname_github_app %} is **private**, you can only install it on the account that owns the app.
* If your {% data variables.product.prodname_github_app %} is **public**, other users and organizations can also install it.{% ifversion enterprise-apps-public-beta %}
* If your {% data variables.product.prodname_github_app %} is **public**, other users and [organizations](https://docs.github.com/organizations) can also install it.{% ifversion enterprise-apps-public-beta %}

Check failure on line 53 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.
* If your {% data variables.product.prodname_github_app %} is owned by an **enterprise**, you can install it on any organization within that enterprise.{% endif %}

For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)" and "[AUTOTITLE](/apps/sharing-github-apps/sharing-your-github-app)."
Expand All @@ -61,15 +61,15 @@

### {% data variables.product.prodname_github_apps %} that act on behalf of a user

If you want your app to take actions on behalf of a user, you should use a user access token for authentication. This type of request is sometimes called "user-to-server," and it means that the app will be limited by the permissions that have been given to the app as well as the user's permission. With this pattern, the user must authorize the app before the app can take action. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."
If you want your app to take actions on behalf of a user, you should use a user access token for [authentication](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github). This type of request is sometimes called "user-to-server," and it means that the app will be limited by the permissions that have been given to the app as well as the user's permission. With this pattern, the user must authorize the app before the app can take action. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."

Check failure on line 64 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.

Some examples of automations you could create with a {% data variables.product.prodname_github_app %}, where the app acts on a user's behalf, include:
* A {% data variables.product.prodname_github_app %} that uses {% data variables.product.prodname_dotcom %} as an identity provider for your ecosystem.
* A {% data variables.product.prodname_github_app %} that adds a service on top of {% data variables.product.github %} that might be useful to a {% data variables.product.prodname_dotcom %} user. You can share the app with other developers via {% data variables.product.prodname_marketplace %} or by making the app public.

### {% data variables.product.prodname_github_apps %} that act on their own behalf

If you want your app to take actions on behalf of itself, rather than a user, you should use an installation access token for authentication. This type of request is sometimes called "server-to-server," and it means that the app will be limited by the permissions that have been given to the app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation)."
If you want your app to take actions on behalf of itself, rather than a user, you should use an installation access token for [authentication](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github). This type of request is sometimes called "server-to-server," and it means that the app will be limited by the permissions that have been given to the app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation)."

Check failure on line 72 in content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.

Some examples of automations you could create with a {% data variables.product.prodname_github_app %}, where the app acts on its own behalf, include:
* A {% data variables.product.prodname_github_app %} that uses webhooks to react to an event given a certain set of criteria. For example, you could create an automation around the REST API endpoints for [reviewing requests for {% data variables.product.pat_v2 %}](/rest/orgs/personal-access-tokens?apiVersion=2022-11-28#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens) that approves a request given a certain policy.
Expand Down
Loading