Skip to content

Commit

Permalink
essentially final?
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah Riehl committed Oct 24, 2023
1 parent 27da623 commit dcf967c
Show file tree
Hide file tree
Showing 21 changed files with 44 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/api-docs/cart-and-checkout/channels-sites-routes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ BigCommerce provides webhooks for 3rd-party developers, enabling them to respond
**Required APIs**

These APIs are required to build a functioning BigCommerce channel app:
* Catalog: Products ([API docs](/api-docs/store-management/catalog/catalog-overview), [API reference](/docs/rest-catalog), [webhooks](/api-docs/store-management/webhooks/webhook-events#products))
* Catalog: Products ([API docs](/docs/store-operations/catalog), [API reference](/docs/rest-catalog), [webhooks](/docs/integrations/webhooks/events#products))
* [Catalog: Channel & Listings](# add here)
* Orders: Orders API ([API docs](/api-docs/orders/orders-api-overview), [API reference](/docs/rest-management/orders), [webhooks](/api-docs/store-management/webhooks/webhook-events#orders))
* Orders: Orders API ([API docs](/docs/store-operations/orders), [API reference](/docs/rest-management/orders), [webhooks](/api-docs/store-management/webhooks/webhook-events#orders))

**Recommended APIs**

Expand Down
2 changes: 1 addition & 1 deletion docs/api-docs/catalog/v2-vs-v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ In V3, any variants or modifier adjusters created with non-null core properties
## Related resources

### Articles
* [Catalog Overview](/api-docs/store-management/catalog/catalog-overview/)
* [Catalog Overview](/docs/store-operations/catalog)
* [Deprecations and sunsets](/docs/start/best-practices/sunsets)

### Endpoints
Expand Down
2 changes: 1 addition & 1 deletion docs/api-docs/getting-started/about-our-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Make BigCommerce API requests in the context of the **storefront**, BigCommerce
| API or Use Case | Context |
|:----------------|:--------|
| [GraphQL Account API](/docs/start/authentication#access-tokens), including [Users](/docs/graphql-account/users-overview) | server |
| [GraphQL Admin API](/api-docs/getting-started/) | server |
| [GraphQL Admin API](/docs/start/authentication#access-tokens) | server |
| [GraphQL Storefront API](/docs/start/authentication#bigcommerce-generated-jwts) | storefront |
| [REST Store Management APIs](/docs/start/authentication#access-tokens) | server |
| [REST Storefront API](/docs/start/authentication#same-origin-cors-authentication) | storefront |
Expand Down
4 changes: 2 additions & 2 deletions docs/api-docs/partner/marketing-api-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When to use:

<Callout type="warning">
#### Intent to deprecate
As BigCommerce moves operations to the V3 API, the endpoints outlined in this article will be deprecated. For a complete list of deprecated endpoints, see [Deprecations and sunsets](/api-docs/getting-started/deprecations-and-sunsets).
As BigCommerce moves operations to the V3 API, the endpoints outlined in this article will be deprecated. For a complete list of deprecated endpoints, see [Deprecations and sunsets](/docs/start/best-practices/sunsets).
</Callout>


Expand All @@ -23,7 +23,7 @@ As BigCommerce moves operations to the V3 API, the endpoints outlined in this ar
| Marketing | modify | `store_v2_marketing` |
| Marketing | read-only | `store_v2_marketing_read_only` |

For more information on available authentication methods, see [Authentication](/api-docs/getting-started/authentication).
For more information on available authentication methods, see [Authentication](/docs/start/authentication).

## Banners
You can use banners to convey information to customers.
Expand Down
4 changes: 2 additions & 2 deletions docs/api-docs/partner/pos/foundation-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ We recommend that you use a sandbox store that has the same multi-storefront sta

To configure your accounts, complete the following steps:

1. To develop and test safely, you need a BigCommerce sandbox store. If you don't have one, [Create a Sandbox Store](/api-docs/partner/getting-started/create-a-sandbox-store?source=pos-foundation).
1. To develop and test safely, you need a BigCommerce sandbox store. If you don't have one, [Create a Sandbox Store](/docs/start/about/sandboxes?source=pos-foundation).

2. In the control panel of your sandbox store, [create a store-level API account](/docs/start/authentication/api-accounts#creating-store-level-api-credentials) and add the following OAuth scopes:

Expand Down Expand Up @@ -279,7 +279,7 @@ Want to help expand this foundation? We'd love to hear from you. Submit a pull r

* [Point of Sale Foundation README (GitHub)](https://github.com/bigcommerce/point-of-sale-foundation/blob/main/README.md)
* [Introducing the Point of Sale Foundation (Dev Blog)](https://medium.com/@stephen.hilliard/introducing-the-point-of-sale-foundation-70834efca76d)
* [Create a Sandbox Store](/api-docs/partner/getting-started/create-a-sandbox-store?source=pos-foundation)
* [Create a Sandbox Store](/docs/start/about/sandboxes?source=pos-foundation)
* [Create a Store-level API Account](/docs/start/authentication/api-accounts#creating-store-level-api-credentials)
* [Connecting with Stripe](https://support.bigcommerce.com/s/article/Connecting-Stripe-Payment-Gateway#foundations)
* [Setting up an "In-Store Pickup" Shipping Method](https://support.bigcommerce.com/s/article/Free-Shipping#in-store)
Expand Down
2 changes: 1 addition & 1 deletion docs/api-docs/partner/subscriptions/foundation-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Subscription Foundation uses the [Channels toolkit](/docs/integrations/channels#
</Callout>

To configure your accounts, complete the following steps:
1. To develop and test apps, you need a BigCommerce sandbox store. If you don't have one, [Create a Sandbox Store](/api-docs/partner/getting-started/create-a-sandbox-store?source=subscription-foundation).
1. To develop and test apps, you need a BigCommerce sandbox store. If you don't have one, [Create a Sandbox Store](/docs/start/about/sandboxes?source=subscription-foundation).
2. To register apps and create app API accounts, you need a BigCommerce Dev Portal account. If you don't have one, create a [Dev Portal account](https://devtools.bigcommerce.com/?source=subscription-foundation).

## Fork and install the source repository
Expand Down
4 changes: 2 additions & 2 deletions docs/api-docs/users/Account-level-API-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ With Account-Level API credentials merchants can now perform actions such as:
As long as this account is active, the token will always be tied to the account.
</Callout>

Before you get started creating Account-Level tokens, read our doc on [API Accounts & OAuth Scopes](api-docs/getting-started/api-accounts) to get up to speed.
Before you get started creating Account-Level tokens, read our doc on [API Accounts & OAuth Scopes](/docs/start/authentication/api-accounts) to get up to speed.

## Prerequisites

Expand Down Expand Up @@ -49,4 +49,4 @@ This process allows BigCommerce to filter out API requests that must be verified

All in all, the Account-Level API accounts on the BigCommerce platform provide merchants and developers with a powerful tool-set for building custom integrations and solutions that can help streamline and automate various processes.

Learn more about setting up Account-Level API token by checking out our Knowledge Base article, [API Accounts](https://support.bigcommerce.com/s/article/Store-API-Accounts?language=en_US#Account-Level-api-accounts).
Learn more about setting up Account-Level API token by checking out our Knowledge Base article, [API Accounts](https://support.bigcommerce.com/s/article/Store-API-Accounts?language=en_US#Account-Level-api-accounts).
10 changes: 5 additions & 5 deletions docs/bigcommerce-for-wordpress/setup/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ These are the most common account issues:

### Necessary scopes for full functionality

The full list of scopes is on the [Multi-site Setup](https://developer.bigcommerce.com/bigcommerce-for-wordpress/setup/multisite#api-account-name-field) page.
The full list of scopes is on the [Multi-site Setup](/docs/storefront/wordpress/start/multi-site#api-account-name-field) page.

### Password reset email trouble

Expand Down Expand Up @@ -56,7 +56,7 @@ If products are missing in the WordPress control panel, verify that you have ass

The import time depends on the number of products synced from your catalog. In general, if you have more than 200 products and use `Full` import, then it is normal for the import to run for more than 30 minutes.

Note that the import process also relies on WP-Cron. Import tasks are processed only when the site has visitors. To avoid this kind of issue, follow the [Server Side Cron](https://developer.bigcommerce.com/bigcommerce-for-wordpress/extending-the-plugin/creating-reliable-cron-jobs#using-server-cron-to-enhance-wp-cron) guide.
Note that the import process also relies on WP-Cron. Import tasks are processed only when the site has visitors. To avoid this kind of issue, follow the [Server Side Cron](/docs/storefront/wordpress/deployment/creating-reliable-cron-jobs#using-server-cron-to-enhance-wp-cron) guide.

### Inactive channel. Product import canceled

Expand Down Expand Up @@ -241,6 +241,6 @@ If you repeatedly encounter the same error or warning and this page doesn't solv
## Related articles
* [Creating Reliable Cron Jobs](https://developer.bigcommerce.com/bigcommerce-for-wordpress/extending-the-plugin/creating-reliable-cron-jobs)
* [Site Launch Checklist](https://developer.bigcommerce.com/bigcommerce-for-wordpress/getting-started/site-launch-checklist)
* [Multi-site Setup](https://developer.bigcommerce.com/bigcommerce-for-wordpress/setup/multisite#api-account-name-field)
* [Creating Reliable Cron Jobs](/docs/storefront/wordpress/deployment/creating-reliable-cron-jobs)
* [Site Launch Checklist](/docs/storefront/wordpress/deployment)
* [Multi-site Setup](/docs/storefront/wordpress/start/multi-site#api-account-name-field)
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
As of November 2016, new BigCommerce stores are being offered themes exclusively from BigCommerce's new [Stencil](https://support.bigcommerce.com/articles/Public/The-Stencil-Theme-Platform) theme platform. For existing stores, the control panel's **Themes Marketplace** and **My Themes** pages will show only those Blueprint themes that have been applied to the store and/or purchased before November 2016.
</Callout>

This means that the workflow below will work only for stores that have applied or purchased at least one Blueprint theme before November 2016. For information about developing on the current Stencil platform, please consult the [Stencil documentation](https://developer.bigcommerce.com/stencil-docs/).
This means that the workflow below will work only for stores that have applied or purchased at least one Blueprint theme before November 2016. For information about developing on the current Stencil platform, please consult the [Stencil documentation](/docs/storefront/stencil).



Expand Down
2 changes: 1 addition & 1 deletion docs/legacy/storefronts/nextjs-commerce-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ SWR uses FETCH for data fetching: [vercel/fetch: Opinionated fetch (with retryin

### SSL/TSL Certificate

To use BigCommerce's [redirected checkout](https://developer.bigcommerce.com/api-docs/storefronts/guide/checkout#redirecting-to-the-bigcommerce-checkout), make sure your Next.js Commerce storefront has an SSL/TSL certificate installed and you are using URL beginning with `https://`.
To use BigCommerce's [redirected checkout](https://developer.bigcommerce.com/docs/storefront/headless/cart-checkout/checkout#redirecting-to-the-bigcommerce-checkout), make sure your Next.js Commerce storefront has an SSL/TSL certificate installed and you are using URL beginning with `https://`.

This comment has been minimized.

Copy link
@bc-stephen-hilliard

bc-stephen-hilliard Oct 24, 2023

Contributor

Shouldn't this link be just /docs/storefront/headless/cart-checkout/checkout#redirecting-to-the-bigcommerce-checkout if we are removing the https://developer.bigcommerce.com from links?


### Next SEO

Expand Down
12 changes: 8 additions & 4 deletions docs/stencil-docs/customizing-checkout/open-source-checkout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ Custom checkouts must have a single JS loader file. The first step to using a cu

## Developing a custom checkout

If you wish to customize a checkout, enter your CSS into the [optimized-checkout.scss](https://github.com/bigcommerce/cornerstone/blob/master/assets/scss/optimized-checkout.scss) in Cornerstone or the [scss folder](https://github.com/bigcommerce/checkout-js/tree/master/packages/core/src/scss) in checkout.js. We suggest moving content from "optimized-checkout.scss to the scss folder or vice-versa to ensure a single source of truth for handling styles. NOTE: "optimized-checkout.scss" will always override the CSS rules defined in checkout-js.
If you wish to customize a checkout, enter your CSS into the [optimized-checkout.scss](https://github.com/bigcommerce/cornerstone/blob/master/assets/scss/optimized-checkout.scss) in Cornerstone or the [scss folder](https://github.com/bigcommerce/checkout-js/tree/master/packages/core/src/scss) in checkout.js. We suggest moving content from "optimized-checkout.scss to the scss folder or vice-versa to ensure a single source of truth for handling styles.

<Callout type="info">
Note: "optimized-checkout.scss" will always override the CSS rules defined in checkout-js.
</Callout>

### Packaging custom checkouts with Open Source Checkout

Expand All @@ -36,12 +40,12 @@ npm run dev & npm run dev:server
```

<Callout type="info">
- Open your browser and navigate to `http://127.0.0.1:8080/` to confirm the dev server is running (you should see content from `build/`).
- Open your browser and navigate to `http://127.0.0.1:8080/` to confirm the dev server is running. You should see content from `build/`.
- To serve files over HTTPS, install an SSL on your development machine, or use [ngrok](https://ngrok.com/).
</Callout>


When using Open Source Checkout to view changes and test implementations through the UI, deploy, and install the custom checkout. Checkout-JS is a reference implementation of Checkout SDK (/docs/stencil-docs/customizing-checkout/checkout-sdk-example); therefore, changes to your loader file are unnecessary. For more details on installing the Checkout JS SDK, see the Checkout SDK (/docs/stencil-docs/customizing-checkout/checkout-sdk-example) Tutorial.
When using Open Source Checkout to view changes and test implementations through the UI, deploy, and install the custom checkout. Checkout-JS is a reference implementation of [Checkout SDK](/docs/storefront/cart-checkout/checkout-sdk); therefore, changes to your loader file are unnecessary. For more details on installing the Checkout JS SDK, see the [Checkout SDK Tutorial](/docs/storefront/cart-checkout/checkout-sdk/tutorial).

## Hosting a custom checkout

Expand All @@ -57,5 +61,5 @@ The steps to host a custom checkout on BigCommerce are below:

### Articles
- [Checkout SDK](/docs/storefront/cart-checkout/checkout-sdk)
- [File Access (WebDav)](https://support.bigcommerce.com/s/article/File-Access-WebDAV)
- [File Access (WebDAV)](https://support.bigcommerce.com/s/article/File-Access-WebDAV)
- [Installing Custom Checkouts in the Control Panel](https://support.bigcommerce.com/s/blog-article/aAn4O000000CdFGSA0/installing-custom-checkouts-in-the-control-panel)
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Custom theme uploads must meet these restrictions:
| TR-902 | Two or more theme variations defined in the contained config.json file share an external ID. All external IDs must be unique. |
| TR-1000 | There was a problem processing the contained <a href="https://github.com/bigcommerce/cornerstone/blob/master/schema.json">schema.json</a> file. |
| TR-1001 | The theme is missing its required <a href="https://github.com/bigcommerce/cornerstone/blob/master/schema.json">schema.json</a> file. |
| TR-1400 | There was a problem processing template <a href="/stencil-docs/front-matter/front-matter-overview">front matter</a>. |
| TR-1401 | There was a database validation error when saving <a href="/stencil-docs/front-matter/front-matter-overview">front matter</a> to the database. |
| TR-1400 | There was a problem processing template <a href="/docs/storefront/stencil/themes/context/frontmatter">front matter</a>. |
| TR-1401 | There was a database validation error when saving <a href="/docs/storefront/stencil/themes/context/frontmatter">front matter</a> to the database. |
| TR-1500 | There was a problem uploading your files due to multi-threading (multiple simultaneous uploads). Please try again. |
| TR-1600 | There was a temporary problem on our system. Please try again. |
| TR-1601 | There was a problem with processing screenshots. |
Expand Down
2 changes: 1 addition & 1 deletion docs/stencil-docs/developing-further/add-recaptcha-v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To add reCAPTCHA v2 support to a theme, update script references in three templa

See [PR #951](https://github.com/bigcommerce/cornerstone/pull/951) in the Cornerstone GitHub Repository to see differentials for each file that needs to be modified.

It is possible to add reCaptcha to the Login template. See the [Forms object](/stencil-docs/reference-docs/) for details.
It is possible to add reCaptcha to the Login template. See the [Forms object](/docs/storefront/stencil/themes/context/object-reference/schemas#forms) for details.

## Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ export default class Cart extends PageManager {
this.bindEvents();
}

cartUpdate($target) {
cartUpdate($target) {
const itemId = $target.data('cartItemid');
const $el = $(`#qty-${itemId}`);
const oldQty = parseInt($el.val(), 10);
Expand All @@ -238,11 +238,13 @@ export default class Cart extends PageManager {
type: 'error',
});
}
}
}
```

## Mapping custom templates to JavaScript modules

If you add [custom page templates](/stencil-docs/storefront-customization/custom-templates/) to your theme, you can edit the same `assets/js/app.js` file to map each custom template to an appropriate JavaScript module.
If you add [custom page templates](/docs/storefront/stencil/themes/templates) to your theme, you can edit the same `assets/js/app.js` file to map each custom template to an appropriate JavaScript module.

In the following example, we will map a custom JavaScript file, `assets/js/themes/custom.js` to a custom product page file `templates/pages/custom/product/customProd.html`.

Expand Down
2 changes: 1 addition & 1 deletion docs/stencil-docs/page-builder/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In all, the structure that you give your theme's `config.json` and `schema.json`

## Theme Styles data types

You are free to decide which properties of your theme to make editable in [Theme Styles](/stencil-docs/reference-docs/styles-and-properties/) and in which order to display them. Theme Styles can expose any set of properties as long as your `schema.json` declares them using the data types that Theme Styles supports.
You are free to decide which properties of your theme to make editable in [Theme Styles](/docs/storefront/stencil/themes/context/object-reference/config) and in which order to display them. Theme Styles can expose any set of properties as long as your `schema.json` declares them using the data types that Theme Styles supports.

Theme Styles supports the following data types:
* checkbox
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
|Attribute|Description|
|---|---|
|`visibility`|Displays an eyeball icon similar to the [Visibility](docs/stencil-docs/page-builder/widget_visibility.yaml) setting type|
|`visibility`|Displays an eyeball icon similar to the [Visibility](/docs/storefront/widgets/input-reference/settings#visibility) setting type |
|`advanced`|Displays a brush icon that reveals a list of settings when clicked|
<hr>
Expand Down
3 changes: 1 addition & 2 deletions docs/stencil-docs/reference-docs/common-objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ This consistent behavior is true for each of the common objects documented in th
| &#x21B3; formatted | String representation of the above price, including currency formatting | string <br /> `"$25.98"` |
| &#x21B3; value | Raw numeric value of the above price | number <br /> `25.98`|
| tax_label | Tax label (VAT, sales tax, etc.) displayed to customers. | string <br /> `"Tax"`|
| price_range | See [Price Range Object](/stencil-docs/reference-docs/common-objects#common-objects_price-range)| |

| price_range | See [Price Range Object](/docs/storefront/stencil/themes/context/object-reference/config)
## Price

**Description:** Exposes price- and currency-related properties in both raw numeric, and formatted string, formats.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ In this example, the `image.jpg` file was uploaded to the WebDAV `/content/` dir

#### CDN custom endpoints

You can define custom CDN endpoints to use with the `{{cdn}}` helper. By doing so you can include large, high-resolution image assets in themes without exceeding BigCommerce's [50 MB limit](https://developer.bigcommerce.com/stencil-docs/deploying-a-theme/bundling-and-pushing) when bundling the theme for upload to BigCommerce.
You can define custom CDN endpoints to use with the `{{cdn}}` helper. By doing so you can include large, high-resolution image assets in themes without exceeding BigCommerce's [50 MB limit](/docs/storefront/stencil/deployment/upload) when bundling the theme for upload to BigCommerce.

You can also use a local version of the image in development and a remote version on a CDN such as Imgix in production. To do so, define custom CDN endpoints in your theme's [`config.json` file](https://github.com/bigcommerce/cornerstone/blob/master/config.json).

Expand Down
Loading

1 comment on commit dcf967c

@bc-stephen-hilliard
Copy link
Contributor

@bc-stephen-hilliard bc-stephen-hilliard commented on dcf967c Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 168 needs to be changed, otherwise looks good

Please sign in to comment.