Skip to content

Commit dc4227c

Browse files
authored
Remove product_name in apps directory (#53985)
1 parent 4bc76a6 commit dc4227c

File tree

16 files changed

+46
-46
lines changed

16 files changed

+46
-46
lines changed

content/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ These security features help harden your {% data variables.product.prodname_gith
3838

3939
Similar to {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can still take actions on behalf of a user. Unlike {% data variables.product.prodname_oauth_apps %}, which don't indicate that the action was performed by the app, {% data variables.product.prodname_github_apps %} indicate that the action was performed by the app on behalf of the user.
4040

41-
{% data variables.product.prodname_github_apps %} are not tied to a user account and do not consume a {% ifversion enterprise-licensing-language %}license{% else %}seat{% endif %} on {% data variables.product.product_name %}. {% data variables.product.prodname_github_apps %} remain installed even when the person who initially installed the app leaves the organization. This lets your integrations continue to work even if people leave your team.
41+
{% data variables.product.prodname_github_apps %} are not tied to a user account and do not consume a {% ifversion enterprise-licensing-language %}license{% else %}seat{% endif %}. {% data variables.product.prodname_github_apps %} remain installed even when the person who initially installed the app leaves the organization. This lets your integrations continue to work even if people leave your team.
4242

4343
### {% data variables.product.prodname_github_apps %} have scalable rate limits
4444

content/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ topics:
1212

1313
## About private keys for {% data variables.product.prodname_github_apps %}
1414

15-
After you create a {% data variables.product.prodname_github_app %}, you'll need to generate a private key in order to make requests to the {% data variables.product.product_name %} API as the application itself. For example, you need a private key to sign a JSON Web Token (JWT) in order to request an installation access token. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app)
15+
After you create a {% data variables.product.prodname_github_app %}, you'll need to generate a private key in order to make requests to the {% data variables.product.github %} API as the application itself. For example, you need a private key to sign a JSON Web Token (JWT) in order to request an installation access token. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app)
1616

1717
You can create {% ifversion app-key-limit %}up to 25 {% else %}multiple {% endif %}private keys for an app. You should use multiple keys in order to rotate keys without downtime in the event of a key compromise. {% ifversion app-key-limit %}If your application has 25 or more keys, you must delete some before you can create more. {% endif %}
1818

@@ -37,7 +37,7 @@ To generate a private key:
3737
3838
## Verifying private keys
3939

40-
{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}.
40+
{% data variables.product.github %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.github %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.github %}.
4141

4242
To verify a private key:
4343

@@ -50,7 +50,7 @@ To verify a private key:
5050
openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64
5151
```
5252

53-
1. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}.
53+
1. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.github %}.
5454

5555
## Deleting private keys
5656

content/apps/creating-github-apps/registering-a-github-app/rate-limits-for-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ shortTitle: Rate limits
2121

2222
{% ifversion ghes %}
2323

24-
API rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance.
24+
API rate limits are disabled by default for {% data variables.product.prodname_ghe_server %}. Contact your site administrator to confirm the rate limits for your instance.
2525

2626
If you are a site administrator, you can set rate limits for your instance. For more information, see [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits).
2727

content/apps/creating-github-apps/writing-code-for-a-github-app/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Writing code for a GitHub App
3-
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.'
3+
intro: 'Learn about using the {% data variables.product.github %} API with your app, continuous integration, and how to build with apps.'
44
redirect_from:
55
- /apps/quickstart-guides
66
- /developers/apps/guides

content/apps/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ The requirements for listing an app on {% data variables.product.prodname_market
2727

2828
## Requirements for all {% data variables.product.prodname_marketplace %} listings
2929

30-
All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.product_name %} community. When you submit your listing for publication, you must read and accept the terms of the [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-marketplace-developer-agreement).
30+
All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.github %} community. When you submit your listing for publication, you must read and accept the terms of the [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-marketplace-developer-agreement).
3131

3232
### User experience requirements for all apps
3333

3434
All listings should meet the following requirements, regardless of whether they are for a free or paid app.
3535

36-
* Listings must not actively persuade users away from {% data variables.product.product_name %}.
36+
* Listings must not actively persuade users away from {% data variables.product.github %}.
3737
* Listings must include valid contact information for the publisher.
3838
* Listings must have a relevant description of the application.
3939
* Listings must specify a pricing plan.

content/apps/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps-on-github-marketplace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ Before listing an app on {% data variables.product.prodname_marketplace %}, you
2424
* [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)
2525
* [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app)
2626

27-
Additionally, you should have the capability to notify {% data variables.product.product_name %} within 24 hours of a confirmed security incident.
27+
Additionally, you should have the capability to notify {% data variables.product.company_short %} within 24 hours of a confirmed security incident.
2828

2929
In addition to following security best practices, you should also follow customer experience best practices. For more information, see [AUTOTITLE](/apps/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps).

content/apps/github-marketplace/github-marketplace-overview/about-github-marketplace-for-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: About GitHub Marketplace for apps
3-
intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps publicly with all {% data variables.product.product_name %} users.'
3+
intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps with everyone.'
44
redirect_from:
55
- /apps/marketplace/getting-started
66
- /marketplace/getting-started

content/apps/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Once you publish a pricing plan for an app that is already listed in {% data var
7676
Once you remove a pricing plan, users won't be able to purchase your app using that plan. Existing users on the removed pricing plan will continue to stay on the plan until they cancel their plan subscription.
7777

7878
> [!NOTE]
79-
> {% data variables.product.product_name %} can't remove users from a removed pricing plan. You can run a campaign to encourage users to upgrade or downgrade from the removed pricing plan onto a new pricing plan.
79+
> {% data variables.product.company_short %} can't remove users from a removed pricing plan. You can run a campaign to encourage users to upgrade or downgrade from the removed pricing plan onto a new pricing plan.
8080
8181
You can disable GitHub Marketplace free trials without retiring the pricing plan, but this prevents you from initiating future free trials for that plan. If you choose to disable free trials for a pricing plan, users already signed up can complete their free trial.
8282

content/apps/github-marketplace/selling-your-app-on-github-marketplace/receiving-payment-for-app-purchases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ shortTitle: Receive payment
2020

2121
{% data reusables.marketplace.marketplace-apps-not-actions %}
2222

23-
After your {% data variables.product.prodname_marketplace %} listing for an app with a paid plan is created and approved, you'll provide payment details to {% data variables.product.product_name %} as part of the financial onboarding process.
23+
After your {% data variables.product.prodname_marketplace %} listing for an app with a paid plan is created and approved, you'll provide payment details to {% data variables.product.company_short %} as part of the financial onboarding process.
2424

2525
Once your revenue reaches a minimum of 500 US dollars for the month, you'll receive an electronic payment from {% data variables.product.company_short %} at the end of the following month. This will be the income from marketplace transactions minus the amount charged by {% data variables.product.company_short %} to cover their running costs.
2626

content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Before a customer purchases your {% data variables.product.prodname_marketplace
2828

2929
The customer completes the purchase by clicking **Complete order and begin installation**.
3030

31-
{% data variables.product.product_name %} then sends the [`marketplace_purchase`](/webhooks/webhook-events-and-payloads#marketplace_purchase) webhook with the `purchased` action to your app.
31+
{% data variables.product.github %} then sends the [`marketplace_purchase`](/webhooks/webhook-events-and-payloads#marketplace_purchase) webhook with the `purchased` action to your app.
3232

3333
Read the `effective_date` and `marketplace_purchase` object from the `marketplace_purchase` webhook to determine which plan the customer purchased, when the billing cycle starts, and when the next billing cycle begins.
3434

@@ -38,24 +38,24 @@ See [AUTOTITLE](/apps/github-marketplace/using-the-github-marketplace-api-in-you
3838

3939
## Step 2. Installation
4040

41-
If your app is a {% data variables.product.prodname_github_app %}, {% data variables.product.product_name %} prompts the customer to select which repositories the app can access when they purchase it. {% data variables.product.product_name %} then installs the app on the account the customer selected and grants access to the selected repositories.
41+
If your app is a {% data variables.product.prodname_github_app %}, {% data variables.product.github %} prompts the customer to select which repositories the app can access when they purchase it. {% data variables.product.github %} then installs the app on the account the customer selected and grants access to the selected repositories.
4242

43-
At this point, if you specified a **Setup URL** in your {% data variables.product.prodname_github_app %} settings, {% data variables.product.product_name %} will redirect the customer to that URL. If you do not specify a setup URL, you will not be able to handle purchases of your {% data variables.product.prodname_github_app %}.
43+
At this point, if you specified a **Setup URL** in your {% data variables.product.prodname_github_app %} settings, {% data variables.product.github %} will redirect the customer to that URL. If you do not specify a setup URL, you will not be able to handle purchases of your {% data variables.product.prodname_github_app %}.
4444

4545
> [!NOTE]
4646
> The **Setup URL** is described as optional in {% data variables.product.prodname_github_app %} settings, but it is a required field if you want to offer your app in {% data variables.product.prodname_marketplace %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/about-the-setup-url).
4747
48-
If your app is an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} does not install it anywhere. Instead, {% data variables.product.product_name %} redirects the customer to the **Installation URL** you specified in your [{% data variables.product.prodname_marketplace %} listing](/apps/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app#listing-urls).
48+
If your app is an {% data variables.product.prodname_oauth_app %}, {% data variables.product.github %} does not install it anywhere. Instead, {% data variables.product.github %} redirects the customer to the **Installation URL** you specified in your [{% data variables.product.prodname_marketplace %} listing](/apps/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app#listing-urls).
4949

50-
When a customer purchases an {% data variables.product.prodname_oauth_app %}, {% data variables.product.product_name %} redirects the customer to the URL you choose (either Setup URL or Installation URL) and the URL includes the customer's selected pricing plan as a query parameter: `marketplace_listing_plan_id`.
50+
When a customer purchases an {% data variables.product.prodname_oauth_app %}, {% data variables.product.github %} redirects the customer to the URL you choose (either Setup URL or Installation URL) and the URL includes the customer's selected pricing plan as a query parameter: `marketplace_listing_plan_id`.
5151

5252
## Step 3. Authorization
5353

5454
When a customer purchases your app, you must send the customer through the OAuth authorization flow:
5555

56-
* If your app is a {% data variables.product.prodname_github_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Setup URL**. Follow the steps in [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).
56+
* If your app is a {% data variables.product.prodname_github_app %}, begin the authorization flow as soon as {% data variables.product.github %} redirects the customer to the **Setup URL**. Follow the steps in [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).
5757

58-
* If your app is an {% data variables.product.prodname_oauth_app %}, begin the authorization flow as soon as {% data variables.product.product_name %} redirects the customer to the **Installation URL**. Follow the steps in [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
58+
* If your app is an {% data variables.product.prodname_oauth_app %}, begin the authorization flow as soon as {% data variables.product.github %} redirects the customer to the **Installation URL**. Follow the steps in [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
5959

6060
For either type of app, the first step is to redirect the customer to [https://github.com/login/oauth/authorize](https://github.com/login/oauth/authorize).
6161

0 commit comments

Comments
 (0)