Skip to content

Commit 8700aef

Browse files
committed
DEVDOCS-6658 Various fixes across the project
1 parent edb9eb4 commit 8700aef

92 files changed

Lines changed: 700 additions & 698 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.style/.spelling

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ reCAPTCHA
426426
v1
427427
invoice_email.html
428428
invoice_printable.zip
429-
CyberDuck
429+
Cyberduck
430430
prefilled
431431
invoice.html
432432
PrintableDetailedInvoice.html

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here are some quick links to our [Contribution](/CONTRIBUTING.md) guide:
1919

2020
- [Making a Quick Edit](/CONTRIBUTING.md#making-a-quick-edit)
2121
- [Editing Locally](/CONTRIBUTING.md#editing-locally)
22-
- [Commit Messages](/CONTRIBUTING.md/cod#commit-messages)
22+
- [Commit Messages](/CONTRIBUTING.md#commit-messages)
2323
- [Style Guides](/CONTRIBUTING.md#style-guides)
2424
- [Contributing to Other Projects](/CONTRIBUTING.md#contributing-to-other-projects)
2525

@@ -53,10 +53,10 @@ Always update your fork to ensure you're working with the newest source files.
5353

5454
```shell
5555
.
56-
├── .github/ # github config
56+
├── .github/ # GitHub config
5757
└── workflows/ # workflows to lint pull requests, etc.
5858
└── ...
59-
├── .idea/ # directory ignored by git - use for yourself
59+
├── .idea/ # directory ignored by Git - use for yourself
6060
├── .style/ # CSPELL data files
6161
├── assets/
6262
├── csv/ # static files used in docs

docs/integrations/apps/guide/buttons.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Your button will link merchants to BigCommerce's install endpoint for your appli
2424

2525
## Rendering success and failure pages
2626

27-
Modify your web site's server-side code to serve either a success or failure page, depending on whether the external installation was successful or unsuccessful.
27+
Modify your website's server-side code to serve either a success or failure page, depending on whether the external installation was successful or unsuccessful.
2828

2929
If you skip this step, your application will load in the iFrame created by your button. To ensure a good experience for your users, we strongly recommend that you return a confirmation page, instead of allowing your application to be loaded in that modal.
3030

docs/integrations/apps/guide/callbacks.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This article is a reference for endpoints to which we send event-driven callback
1111

1212
## Overview
1313

14-
Your app's front-end views render inside an iFrame in the store control panel, so your app has no native ability to listen for a few high-level events. To support your work, BigCommerce sends `GET` requests to callback routes in your app that correspond to three events: opening the app, uninstalling the app, and revoking a user's access to the app. Each request includes a signed JSON web token (_JWT_), which contains identifying information about the store and the user.
14+
Your app's front-end views render inside an iFrame in the store control panel, so your app has no native ability to listen for a few high-level events. To support your work, BigCommerce sends `GET` requests to callback routes in your app that correspond to three events: opening the app, uninstalling the app, and revoking a user's access to the app. Each request includes a signed JSON web token (_JWT_), which contains identifying information about the store and the user.
1515

1616
Your app is only required to handle the `GET /auth{:http}` and `GET /load{:http}` endpoints, but we recommend writing handlers for the others, as well. Please see the corresponding detail sections that follow for more about the consequences of not handling optional callback endpoints.
1717

@@ -26,7 +26,7 @@ The following table lists the app management callbacks that BigCommerce stores s
2626

2727
## Render the app with load
2828

29-
Once the store owner or authorized user installs your app, it appears on the **Apps** sub-menu list in their store control panel, as well as their authorized users' control panels. When a user clicks your app's listing or another referring UI component, BigCommerce dispatches a request to your app's `GET /load{:http}` endpoint. The following is an example request:
29+
Once the store owner or authorized user installs your app, it appears on the **Apps** sub-menu list in their store control panel, as well as their authorized users' control panels. When a user clicks your app's listing or another referring UI component, BigCommerce dispatches a request to your app's `GET /load{:http}` endpoint. The following is an example request:
3030

3131
```http filename="Example request: /load callback from BigCommerce"
3232
GET https://your_app.example.com/load?signed_payload_jwt={header_b64.payload_claims_b64.signature_b64}
@@ -98,8 +98,8 @@ The following is an example of the payload claims encoded in the `signed_payload
9898
"id": 7654321,
9999
"email": "owner@example.com"
100100
},
101-
"url": "/",
102-
"channel_id": null,
101+
"url": "/",
102+
"channel_id": null
103103
}
104104
```
105105

docs/integrations/apps/guide/catalyst-compatible-apps.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ It’s likely that your app or integration is already compatible with Catalyst i
6161

6262
### I am the developer of a net-new Single-Click App, and want to ensure my app is compatible with Catalyst.
6363

64-
#### Follow these teps:
64+
#### Follow these steps:
6565
1. **Understand Catalyst's Architecture**
6666
- Catalyst uses Next.js and React components for storefront UI.
6767
- Familiarize yourself with routing, data fetching, and state management.
@@ -92,6 +92,6 @@ Our App Marketplace team will review your app compatibility, follow up with any
9292
## Leverage our BigCommerce Developer ecosystem to learn more
9393

9494
- Join our [BigCommerce Developers Slack](https://developer.bigcommerce.com/slack).
95-
- Align your app with Catalyst’s roadmap, coming soon on the [Catalyst Github repo](https://github.com/bigcommerce/catalyst)!
95+
- Align your app with Catalyst’s roadmap, coming soon on the [Catalyst GitHub repo](https://github.com/bigcommerce/catalyst)!
9696
- Contribute to the [Resource Hub](https://developer.bigcommerce.com/resource-hub) to showcase your integration.
9797

docs/integrations/apps/guide/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Here's a few things you'll need before beginning app development:
1111
3. [BigCommerce partnership](https://www.bigcommerce.com/partners/) (required to publish apps to marketplace)
1212

1313
## Beginning quickly
14-
The fastest way to begin app development is by starting with one of our sample apps. You can follow our [Building Apps Quick Start Tutorial](/docs/integrations/apps/quick-start), either alone or in conjunction with [spinning up a Heroku instance](https://heroku.com/deploy?template=https://github.com/bigcommerce/sample-app-nodejs) that runs our [Node / React / Next.js sample app](https://github.com/bigcommerce/sample-app-nodejs/).
14+
The fastest way to begin app development is by starting with one of our sample apps. You can follow our [Building Apps Quick Start Tutorial](/docs/integrations/apps/quick-start), either alone or in conjunction with [spinning up a Heroku instance](https://heroku.com/deploy?template=https://github.com/bigcommerce/sample-app-nodejs) that runs our [Node / React / Next.js sample app](https://github.com/bigcommerce/sample-app-nodejs/).
1515

1616
Alternatively, you can clone the GitHub repo for your preferred stack:
1717

@@ -34,7 +34,7 @@ cd myapp # move into app dir
3434

3535
brew install ngrok/ngrok/ngrok # install ngrok using homebrew
3636

37-
ngrok config add-authtoken <TOKEN> # Obtain your authtoken by going to https://dashboard.ngrok.com/get-started/your-authtoken
37+
ngrok config add-authtoken <TOKEN> # Obtain your authtoken by going to https://dashboard.ngrok.com/get-started/your-authtoken
3838

3939
npm install # install dependencies
4040

@@ -61,8 +61,8 @@ Once you've exposed your app to the internet, you can register it as a draft app
6161
Any store registered to the same email as your [Developer Portal](https://devtools.bigcommerce.com/my/apps) account can install your draft apps. Use the following steps to install:
6262

6363
1. Sign in to the store and navigate to **Apps** > **My Apps** > [**My Draft Apps**](https://login.bigcommerce.com/deep-links/manage/marketplace/apps/my-apps/drafts).
64-
2. Click the draft app thumbnail to install the draft.
65-
3. Once you click **Install**, BigCommerce will begin the OAuth flow by making a `GET` request to the app's `/auth` callback URL. If the app handles all the requests successfully, the app has been installed and you can begin feature development.
64+
2. Click the draft app thumbnail to install the draft.
65+
3. Once you click **Install**, BigCommerce will begin the OAuth flow by making a `GET` request to the app's `/auth` callback URL. If the app handles all the requests successfully, the app has been installed, and you can begin feature development.
6666

6767
## Next steps
6868
* [Learn How Test App Authentication Locally with ngrok](https://medium.com/bigcommerce-developer-blog/how-to-test-app-authentication-locally-with-ngrok-149150bfe4cf)

docs/integrations/apps/guide/ui.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ forms, tables, and modals. You can use these patterns as a starting point for yo
5656
* [GitHub repo](https://github.com/bigcommerce/big-design-patterns-sandbox/).
5757

5858
### UX writing
59-
BigDesign also provides a set of UX writing guidelines to help you create clear and consistent copy for your app's UI. These guidelines cover topics such as tone, voice, and terminology, and provide examples of how to write effective UI copy. You can use these guidelines to ensure that your app's UI copy aligns with BigCommerce's design language and provides a consistent user experience.
59+
BigDesign also provides a set of UX writing guidelines to help you create clear and consistent copy for your app's UI. These guidelines cover topics such as tone, voice, and terminology, and provide examples of how to write effective UI copy. You can use these guidelines to ensure that your app's UI copy aligns with BigCommerce's design language and provides a consistent user experience.
6060

6161
[BigDesign UX writing guidelines](https://developer.bigcommerce.com/docs/start/design/ux-writing).
6262

@@ -71,7 +71,7 @@ Single-click apps benefit from a high level of integration with the BigCommerce
7171

7272
To load inside the control panel iFrame, your app must do the following:
7373
1. **Serve app resources over HTTPS:** BigCommerce's control panel is served over HTTPS. Your app must also be served over HTTPS, including any remote resources referenced (such as CSS, JS, and image files). If any resources are served over HTTP, the user's browser will display a mixed content error and refuse to render your app's UI in the control panel iFrame.
74-
2. **Support browser same-origin policies:** Same-origin policities restrict apps running within iFrames from performing certain activities, such as interacting with other services. If your app requires this, open a new tab for actions that cannot occur in an iFrame<sup>1</sup>. [Learn more about same-origin policies](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) (developer.mozilla.org).
74+
2. **Support browser same-origin policies:** Same-origin policies restrict apps running within iFrames from performing certain activities, such as interacting with other services. If your app requires this, open a new tab for actions that cannot occur in an iFrame<sup>1</sup>. [Learn more about same-origin policies](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) (developer.mozilla.org).
7575

7676
<Callout type="info">
7777
Apps that operate in the iFrame get strong preference during [App Marketplace](https://www.bigcommerce.com/apps/) consideration; however, we sometimes make exceptions for apps that need to interact with other services.

docs/integrations/apps/guide/users.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Because you know the store owner or user's `email` and `ID` from the app install
2727
- **Users**: Cannot `install` or `uninstall` apps. Users are permitted only to `load` the apps that a store owner authorized.
2828

2929
## The remove user request
30-
Store owners can also remove users. This action generates a `GET` request to the remove user callback URL that you provided in the [Developer Portal](https://devtools.bigcommerce.com/my/apps). When this occurs, your app should remove the user identified in the request from it's records.
30+
Store owners can also remove users. This action generates a `GET` request to the remove user callback URL that you provided in the [Developer Portal](https://devtools.bigcommerce.com/my/apps). When this occurs, your app should remove the user identified in the request from its records.
3131

3232
For details about remove user and load requests, see [Single-click App Callbacks](/docs/integrations/apps/guide/callbacks).
3333

docs/integrations/apps/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Use [BigCommerce APIs](/docs/api) to integrate stores with business systems such
4444
### Connect to sales channels
4545
List products on external [sales channels](https://www.bigcommerce.com/apps/categories/sales-channels/) with [Channels Toolkit](/docs/integrations/channels/toolkit-reference).
4646

47-
[Learn more about connecting apps to sales channels.](/docs/integrations/channels).
47+
[Learn more about connecting apps to sales channels](/docs/integrations/channels).
4848

4949
### Add and manage scripts
5050
Create and manage scripts with [Scripts API](/docs/rest-management/scripts) and [Script Manager](https://support.bigcommerce.com/s/article/Using-Script-Manager).

docs/integrations/apps/tutorial/nextjs-setup.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For this tutorial, you need Node.js version 18+. To check your version of Node.j
1515
node -v
1616
```
1717

18-
If you do not have Node.js installed, you can download it from [nodejs.org (downloads)](https://nodejs.org/en/download/).
18+
If you do not have Node.js installed, you can download it from [nodejs.org (downloads)](https://nodejs.org/en/download/).
1919

2020
## Set up a project directory
2121

@@ -140,7 +140,7 @@ Next.js associates each file in the pages folder with a route based on the file'
140140

141141
Next.js allows you to use a theme provider and import CSS files from `node_modules`. In this tutorial, you integrate [BigDesign React components](https://developer.bigcommerce.com/big-design/) to give your app a distinct BigCommerce look and feel.
142142

143-
1. Next.js uses the `App` component to initialize pages. To override the default `App` component, add the `_app.tsx` file to the `pages` folder. This is where you initialize BigDesign.
143+
1. Next.js uses the `App` component to initialize pages. To override the default `App` component, add the `_app.tsx` file to the `pages` folder. This is where you initialize BigDesign.
144144

145145
2. Open `_app.tsx` and import `GlobalStyles` from BigDesign and `AppProps` from Next.js.
146146

@@ -160,7 +160,7 @@ const MyApp = ({ Component, pageProps }: AppProps) => (
160160
<Component {...pageProps} />
161161
</>
162162
);
163-
163+
164164
export default MyApp;
165165
```
166166

@@ -170,7 +170,7 @@ The `Component` prop represents the active page. Consequently, it will change wh
170170

171171
Because BigDesign uses styled-components, we need to add additional configuration for both BigDesign and styled-components to function properly.
172172

173-
1. Add a custom `_document.tsx` file to your pages folder.
173+
1. Add a custom `_document.tsx` file to your pages folder.
174174

175175
2. Import `Document` and `DocumentContext`, the built-in TypeScript types, from Next.js.
176176

@@ -218,7 +218,7 @@ export default class MyDocument extends Document {
218218

219219
## Start the development server
220220

221-
1. Using the terminal, open the root directory of your app and start the development server.
221+
1. Using the terminal, open the root directory of your app and start the development server.
222222

223223
```shell copy filename="Start development server"
224224
npm run dev

0 commit comments

Comments
 (0)