[Apps overhaul] Restructure the current docs to match the proposed docs structure as closely as possible (#34664)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
Jess Hosman
@@ -1,35 +0,0 @@
|
||||
---
|
||||
title: About GitHub Marketplace
|
||||
intro: '{% data variables.product.prodname_marketplace %} contains tools that add functionality and improve your workflow.'
|
||||
redirect_from:
|
||||
- /articles/about-github-marketplace
|
||||
- /github/customizing-your-github-workflow/about-github-marketplace
|
||||
- /github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).
|
||||
|
||||
If you purchase a paid tool, you'll pay for your tool subscription with the same billing information you use to pay for your {% data variables.product.product_name %} subscription, and receive one bill on your regular billing date. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace)."
|
||||
|
||||
You may also have the option to select a free 14-day trial on some tools. You can cancel at any time during your trial and you won't be charged, but you will automatically lose access to the tool. Your paid subscription will start at the end of the 14-day trial. For more information, see "[About billing for {% data variables.product.prodname_marketplace %}](/billing/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace)."
|
||||
|
||||
## Finding tools on {% data variables.product.prodname_marketplace %}
|
||||
|
||||
You can discover, browse, and install apps and actions created by others on {% data variables.product.prodname_marketplace %}, see "[Searching {% data variables.product.prodname_marketplace %}](/search-github/searching-on-github/searching-github-marketplace)."
|
||||
|
||||
{% data reusables.actions.actions-not-verified %}
|
||||
|
||||
Anyone can list a free {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} on {% data variables.product.prodname_marketplace %}. Publishers of paid apps are verified by {% data variables.product.company_short %} and listings for these apps are shown with a marketplace badge {% octicon "verified" aria-label="Verified creator badge" %}. You will also see badges for unverified and verified apps. These apps were published using the previous method for verifying individual apps. For more information about the current process, see "[About GitHub Marketplace](/developers/github-marketplace/github-marketplace-overview/about-github-marketplace)" and "[Requirements for listing an app](/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
## Building and listing a tool on {% data variables.product.prodname_marketplace %}
|
||||
|
||||
For more information on creating your own tool to list on {% data variables.product.prodname_marketplace %}, see "[Apps](/developers/apps)" and "[{% data variables.product.prodname_actions %}](/actions)."
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Purchasing and installing apps in {% data variables.product.prodname_marketplace %}](/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace)"
|
||||
- "[Managing billing for {% data variables.product.prodname_marketplace %} apps](/billing/managing-billing-for-github-marketplace-apps)"
|
||||
- "[{% data variables.product.prodname_marketplace %} support](/support/learning-about-github-support/github-marketplace-support)"
|
||||
- "[Differences between GitHub Apps and OAuth Apps](/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps)"
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: About integrations
|
||||
intro: 'Integrations are tools and services that connect with {% data variables.product.product_name %} to complement and extend your workflow.'
|
||||
redirect_from:
|
||||
- /articles/about-integrations
|
||||
- /github/customizing-your-github-workflow/about-integrations
|
||||
- /github/customizing-your-github-workflow/exploring-integrations/about-integrations
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
You can install integrations in your personal account or organizations you own. You can also install {% data variables.product.prodname_github_apps %} from a third-party in a specific repository where you have admin permissions or which is owned by your organization.
|
||||
|
||||
## Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}
|
||||
|
||||
Integrations can be {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, or anything that utilizes {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs or webhooks.
|
||||
|
||||
{% data variables.product.prodname_github_apps %} offer granular permissions and request access to only what the app needs. {% data variables.product.prodname_github_apps %} also offer specific user-level permissions that each user must authorize individually when an app is installed or when the integrator changes the permissions requested by the app.
|
||||
|
||||
For more information, see:
|
||||
- "[Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}](/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps)"
|
||||
- "[About apps](/developers/apps/getting-started-with-apps/about-apps)"
|
||||
- "[User-level permissions](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#user-level-permissions)"
|
||||
- "[Authorizing {% data variables.product.prodname_oauth_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)"
|
||||
- "[Authorizing {% data variables.product.prodname_github_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)"
|
||||
- "[Reviewing your authorized integrations](/authentication/keeping-your-account-and-data-secure/reviewing-your-authorized-integrations)"
|
||||
|
||||
You can install a preconfigured {% data variables.product.prodname_github_app %}, if the integrators or app creators have created their app with the {% data variables.product.prodname_github_app %} manifest flow. For information about how to run your {% data variables.product.prodname_github_app %} with automated configuration, contact the integrator or app creator.
|
||||
|
||||
You can create a {% data variables.product.prodname_github_app %} with simplified configuration if you build your app with Probot. For more information, see the [Probot docs](https://probot.github.io/docs/) site.
|
||||
|
||||
## Discovering integrations in {% data variables.product.prodname_marketplace %}
|
||||
|
||||
You can find an integration to install or publish your own integration in {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
[{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) contains {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}. For more information on finding an integration or creating your own integration, see "[About {% data variables.product.prodname_marketplace %}](/get-started/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)."
|
||||
|
||||
## Integrations purchased directly from integrators
|
||||
|
||||
You can also purchase some integrations directly from integrators. As an organization member, if you find a {% data variables.product.prodname_github_app %} that you'd like to use, you can request that an organization approve and install the app for the organization.
|
||||
|
||||
If you have admin permissions for all organization-owned repositories the app is installed on, you can install {% data variables.product.prodname_github_apps %} with repository-level permissions without having to ask an organization owner to approve the app. When an integrator changes an app's permissions, if the permissions are for a repository only, organization owners and people with admin permissions to a repository with that app installed can review and accept the new permissions.
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: About webhooks
|
||||
redirect_from:
|
||||
- /post-receive-hooks
|
||||
- /articles/post-receive-hooks
|
||||
- /articles/creating-webhooks
|
||||
- /articles/about-webhooks
|
||||
- /github/extending-github/about-webhooks
|
||||
intro: Webhooks provide a way for notifications to be delivered to an external web server whenever certain actions occur on a repository or organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** {% data reusables.organizations.owners-and-admins-can %} manage webhooks for an organization. {% data reusables.organizations.new-org-permissions-more-info %}
|
||||
|
||||
{% endtip %}
|
||||
|
||||
Webhooks can be triggered whenever a variety of actions are performed on a repository or an organization. For example, you can configure a webhook to execute whenever:
|
||||
|
||||
* A repository is pushed to
|
||||
* A pull request is opened
|
||||
* A {% data variables.product.prodname_pages %} site is built
|
||||
* A new member is added to a team
|
||||
|
||||
Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, you can make these webhooks update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server.
|
||||
|
||||
To set up a new webhook, you'll need access to an external server and familiarity with the technical procedures involved. For help on building a webhook, including a full list of actions you can associate with, see "[Webhooks](/developers/webhooks-and-events/webhooks/about-webhooks)."
|
||||
@@ -1,82 +0,0 @@
|
||||
---
|
||||
title: GitHub extensions and integrations
|
||||
intro: 'Use {% data variables.product.prodname_dotcom %} extensions to work seamlessly in repositories on {% data variables.location.product_location %} within third-party applications.'
|
||||
redirect_from:
|
||||
- /articles/about-github-extensions-for-third-party-applications
|
||||
- /articles/github-extensions-and-integrations
|
||||
- /github/customizing-your-github-workflow/github-extensions-and-integrations
|
||||
- /github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.7'
|
||||
shortTitle: Extensions & integrations
|
||||
---
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
## Editor tools
|
||||
|
||||
You can connect to {% data variables.product.product_name %} repositories within third-party editor tools such as Unity and {% data variables.product.prodname_vs %}.
|
||||
|
||||
### {% data variables.product.product_name %} for Unity
|
||||
|
||||
With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs).
|
||||
|
||||
### {% data variables.product.product_name %} for {% data variables.product.prodname_vs %}
|
||||
|
||||
With the {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} extension, you can work in {% data variables.product.product_name %} repositories without leaving {% data variables.product.prodname_vs %}. For more information, see the official {% data variables.product.prodname_vs %} extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs).
|
||||
|
||||
### {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %}
|
||||
|
||||
With the {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} extension, you can review and manage {% data variables.product.product_name %} pull requests in {% data variables.product.prodname_vscode_shortname %}. For more information, see the official {% data variables.product.prodname_vscode_shortname %} extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github).
|
||||
|
||||
## Project management tools
|
||||
|
||||
You can integrate your personal or organization account on {% data variables.location.product_location %} with third-party project management tools, such as Jira.
|
||||
|
||||
### Jira Cloud and {% data variables.product.product_name %}.com integration
|
||||
|
||||
You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion slack-and-team-integrations %}
|
||||
|
||||
## Team communication tools
|
||||
|
||||
You can integrate your {% ifversion fpt or ghec %}personal{% elsif ghes %}user{% endif %} or organization account on {% data variables.location.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams.
|
||||
|
||||
### Slack and {% data variables.product.product_name %} integration
|
||||
|
||||
The Slack + {% data variables.product.prodname_dotcom %} app lets you subscribe to your repositories or organizations and get real-time updates about activity for the following features on {% data variables.location.product_location %}.
|
||||
|
||||
- Issues
|
||||
- Pull requests
|
||||
- Commits
|
||||
- Discussions
|
||||
- Releases
|
||||
- {% data variables.product.prodname_actions %}
|
||||
- Deployments
|
||||
|
||||
You can also open and close issues, comment on your issues and pull requests, approve deployments, and see detailed references to issues and pull requests without leaving Slack. The app will also ping you personally on Slack if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats.
|
||||
|
||||
The Slack + {% data variables.product.prodname_dotcom %} app is also compatible with [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). For more information, visit the [Slack + {% data variables.product.prodname_dotcom %} app](https://github.com/marketplace/slack-github) in the marketplace.
|
||||
|
||||
### Microsoft Teams and {% data variables.product.product_name %} integration
|
||||
|
||||
The {% data variables.product.prodname_dotcom %} for Teams app lets you subscribe to your repositories or organizations and get real-time updates about activity for the following features on {% data variables.location.product_location %}.
|
||||
|
||||
- Issues
|
||||
- Pull requests
|
||||
- Commits
|
||||
- Discussions
|
||||
- Releases
|
||||
- {% data variables.product.prodname_actions %}
|
||||
- Deployments
|
||||
|
||||
You can also open and close issues, comment on your issues and pull requests, approve deployments, and see detailed references to issues and pull requests without leaving Microsoft Teams. The app will also ping you personally on Teams if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats.
|
||||
|
||||
For more information, visit the [{% data variables.product.prodname_dotcom %} for Teams app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource.
|
||||
|
||||
{% endif %}
|
||||
@@ -1,18 +0,0 @@
|
||||
---
|
||||
title: Exploring integrations
|
||||
intro: 'You can customize and extend your {% data variables.product.product_name %} workflow with tools and services built by the {% data variables.product.product_name %} community.'
|
||||
redirect_from:
|
||||
- /articles/exploring-integrations
|
||||
- /github/customizing-your-github-workflow/exploring-integrations
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
children:
|
||||
- /about-integrations
|
||||
- /about-webhooks
|
||||
- /about-github-marketplace
|
||||
- /github-extensions-and-integrations
|
||||
---
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
---
|
||||
title: Customizing your GitHub workflow
|
||||
intro: 'Learn how you can customize your {% data variables.product.prodname_dotcom %} workflow with extensions, integrations, {% data variables.product.prodname_marketplace %}, and webhooks.'
|
||||
redirect_from:
|
||||
- /categories/customizing-your-github-workflow
|
||||
- /github/customizing-your-github-workflow
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghae: '*'
|
||||
ghes: '*'
|
||||
children:
|
||||
- /exploring-integrations
|
||||
- /purchasing-and-installing-apps-in-github-marketplace
|
||||
shortTitle: Customize your workflow
|
||||
---
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: Purchasing and installing apps in GitHub Marketplace
|
||||
intro: '{% data variables.product.prodname_marketplace %} includes apps with free and paid pricing plans. When you find a paid app you''d like to use for your personal account or organization, you can purchase and install the app using your existing billing information.'
|
||||
redirect_from:
|
||||
- /articles/purchasing-and-installing-apps-in-github-marketplace
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /installing-an-app-in-your-personal-account
|
||||
- /installing-an-app-in-your-organization
|
||||
shortTitle: Install Marketplace apps
|
||||
---
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: Installing an app in your organization
|
||||
intro: 'You can install apps from {% data variables.product.prodname_marketplace %} to use in your organization.'
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install app organization
|
||||
---
|
||||
{% data reusables.marketplace.marketplace-apps-only %}
|
||||
|
||||
{% data reusables.marketplace.marketplace-org-perms %}
|
||||
|
||||
If you choose a paid plan, you'll pay for your app subscription on your organization's current billing date using your organization's existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your organization
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-org %}
|
||||
{% data reusables.marketplace.add-payment-method-org %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
8. If the app requires access to repositories, decide whether to give the app access to all of your repositories or to certain repositories, then select **All repositories** or **Only select repositories**.
|
||||
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Installing an {% data variables.product.prodname_oauth_app %} in your organization
|
||||
|
||||
{% data reusables.saml.saml-session-oauth %}
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-org %}
|
||||
{% data reusables.marketplace.add-payment-method-org %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
8. Review the information about the app's access to your personal account, organizations, and data, then click **Authorize application**.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Updating your organization's payment method](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[Installing an app in your personal account](/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account)"
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: Installing an app in your personal account
|
||||
intro: 'You can install apps from {% data variables.product.prodname_marketplace %} to use in your personal account.'
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install app personal account
|
||||
---
|
||||
{% data reusables.marketplace.marketplace-apps-only %}
|
||||
|
||||
If you choose a paid plan, you'll pay for your app subscription on your personal account's current billing date using your existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your personal account
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-personal %}
|
||||
{% data reusables.marketplace.add-payment-method-personal %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
8. Decide whether to give the app access to all of your repositories, or to certain repositories, then select **All repositories** or **Only select repositories**.
|
||||
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Installing an {% data variables.product.prodname_oauth_app %} in your personal account
|
||||
|
||||
{% data reusables.saml.saml-session-oauth %}
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-personal %}
|
||||
{% data reusables.marketplace.add-payment-method-personal %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
8. Review the information about the app's access to your personal account and data, then click **Authorize application**.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Updating your personal account's payment method](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[Installing an app in your organization](/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization)"
|
||||
Reference in New Issue
Block a user