merge main into 3804

.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["plugin:mdx/recommended"],
+  // optional, if you want to lint code blocks at the same time
+  "settings": {
+    "mdx/code-blocks": true,
+    // optional, if you want to disable language mapper, set it to `false`
+    // if you want to override the default language mapper inside, you can provide your own
+    "mdx/language-mapper": {}
+  }
+}

.github/CODEOWNERS

@@ -1,12 +1,8 @@
 # These owners will be the default owners for everything in the repo. Unless a later match takes precedence, @global-owner1 and @global-owner2 will be requested for review when someone opens a pull request.
 
-@markcmurphy @slsriehl
+@slsriehl @bigcommerce/dev-docs-team @markcmurphy
 
 # Teams can be specified as code owners as well. Teams should
 # be identified in the format @org/team-name. Teams must have
 # explicit write access to the repository. In this example,
 # the octocats team in the octo-org organization owns all .md files.
-*.yml @bigcommerce/devdocs-codeowners
-*.yaml @bigcommerce/devdocs-codeowners
-*.md @bigcommerce/devdocs-codeowners
-*.json @bigcommerce/devdocs-codeowners

.github/workflows/deploy.yml

@@ -0,0 +1,18 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Trigger Vercel Deploy Hook
+      run: |
+        curl -X POST ${{ secrets.VERCEL_DEPLOY_HOOK_URL }}

.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: lint-valid-mdx
+on:
+  - pull_request
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js v17.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 17.x
+      - run: npm ci
+      - run: npm run lint

.gitignore

@@ -1 +1,4 @@
 .idea
+node_modules
+.DS_Store
+

.spectral.yaml

@@ -20,19 +20,6 @@ except:
     - operation-operationId
     - oas3-schema
     - oas3-valid-media-example
-  'reference/checkouts.sf.yml':
-    - oas2-valid-media-example
-  'reference/checkouts.v3.yml':
-    - no-$ref-siblings
-    - oas2-schema
-    - oas2-operation-security-defined
-    - oas2-valid-schema-example
-    - oas2-valid-media-example
-    - operation-parameters
-  'reference/currencies.v2.yml':
-    - oas2-valid-schema-example
-    - operation-operationId
-    - no-$ref-siblings
   'reference/current_customer.yml':
     - operation-success-response
   'reference/custom-template-associations.v3.yml':
@@ -41,26 +28,13 @@ except:
   'reference/customer_login.yml':
     - operation-operationId
     - operation-success-response
-    - oas2-schema
-  'reference/customers.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'reference/email_templates.v3.yml':
     - oas3-schema
     - operation-tag-defined
     - openapi-tags
-  'reference/form_fields.sf.yml':
-    - operation-operationId
   'reference/geography.v2.yml':
     - operation-operationId
     - oas2-valid-media-example
-  'reference/marketing.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-    - operation-operationId
-  'reference/orders.sf.yml':
-    - operation-tag-defined
-    - oas3-valid-schema-example
   'reference/orders.v2.oas2.yml':
     - oas3-valid-schema-example
     - oas3-valid-media-example
@@ -69,74 +43,21 @@ except:
     - oas2-valid-schema-example
     - oas2-valid-media-example
     - oas2-anyOf
-  'reference/payment_methods.v2.yml':
-    - operation-operationId
-  'reference/price_lists.v3.yml':
-    - oas2-schema
-    - oas2-valid-media-example
-  'reference/pricing.sf.yml':
-    - oas2-valid-media-example
-    - oas2-schema
-    - no-$ref-siblings
-  'reference/redirects.v3.yml':
-    - oas2-valid-media-example
-    - oas2-schema
-    - no-$ref-siblings
   'reference/settings.v3.yml':
     - oas3-valid-media-example
     - operation-operationId
-  'reference/shipping.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-    - typed-enum
-    - operation-operationId
-  'reference/shipping.v3.yml':
-    - oas2-valid-schema-example
-    - operation-operationId
-    - typed-enum
   'reference/sites.v3.yml':
     - oas2-valid-media-example
     - operation-operationId
-  'reference/store_content.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'reference/store_information.v2.yml':
     - oas2-valid-media-example
     - operation-operationId
     - oas2-valid-schema-example
-  'reference/storefront_tokens.v3.yml':
-    - oas2-valid-schema-example
-  'reference/subscriptions.sf.yml':
-    - operation-operationId
-  'reference/tax_classes.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'reference/themes.v3.yml':
     - oas3-schema
     - operation-operationId
   'reference/webhooks.v3.yml':
     - oas3-valid-media-example
-  'reference/widgets.v3.yml':
-    - typed-enum
-    - oas2-anyOf
-    - oas2-valid-media-example
-  'reference/wishlists.v3.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-  'reference/checkouts.sf.yml#/host':
-    - oas2-schema
-  'reference/form_fields.sf.yml#/host':
-    - oas2-schema
-  'reference/orders.sf.yml#/host':
-    - oas2-schema
-  'reference/subscriptions.sf.yml#/host':
-    - oas2-schema
-  'reference/current_customer.yml#/host':
-    - oas2-schema
-  'reference/customer_login.yml#/host':
-    - oas2-schema
-  'reference/shipping_provider.yml#/host':
-    - oas2-schema
   'carts.v3.yml':
     - oas2-oneOf
     - oas2-valid-schema-example
@@ -151,48 +72,20 @@ except:
     - operation-operationId
     - oas3-schema
     - oas3-valid-media-example
-  'checkouts.sf.yml':
-    - oas2-valid-media-example
-  'checkouts.v3.yml':
-    - no-$ref-siblings
-    - oas2-schema
-    - oas2-operation-security-defined
-    - oas2-valid-schema-example
-    - oas2-valid-media-example
-    - operation-parameters
-  'currencies.v2.yml':
-    - oas2-valid-schema-example
-    - operation-operationId
-    - no-$ref-siblings
   'current_customer.yml':
     - operation-success-response
   'custom-template-associations.v3.yml':
     - openapi-tags
     - operation-tag-defined
   'customer_login.yml':
-    - operation-operationId
     - operation-success-response
-  'customers.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'email_templates.v3.yml':
     - oas3-schema
     - operation-tag-defined
     - openapi-tags
-  'form_fields.sf.yml':
-    - operation-operationId
-    - oas2-schema    
-    - oas2-valid-schema-example
   'geography.v2.yml':
     - operation-operationId
     - oas2-valid-media-example
-  'marketing.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-    - operation-operationId
-  'orders.sf.yml':
-    - operation-tag-defined
-    - oas3-valid-schema-example
   'orders.v2.oas2.yml':
     - oas3-valid-schema-example
     - oas3-valid-media-example
@@ -201,80 +94,21 @@ except:
     - oas2-valid-schema-example
     - oas2-valid-media-example
     - oas2-anyOf
-  'payment_methods.v2.yml':
-    - operation-operationId
-  'price_lists.v3.yml':
-    - oas2-schema
-    - oas2-valid-media-example
-  'pricing.sf.yml':
-    - oas2-valid-media-example
-    - oas2-schema
-    - no-$ref-siblings
-  'redirects.v3.yml':
-    - oas2-valid-media-example
-    - oas2-schema
-    - no-$ref-siblings
   'settings.v3.yml':
     - oas3-valid-media-example
     - operation-operationId
-  'shipping.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-    - typed-enum
-    - operation-operationId
-  'shipping.v3.yml':
-    - oas2-valid-schema-example
-    - operation-operationId
-    - typed-enum
   'sites.v3.yml':
     - oas2-valid-media-example
     - operation-operationId
-  'store_content.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'store_information.v2.yml':
     - oas2-valid-media-example
     - operation-operationId
     - oas2-valid-schema-example
-  'storefront_tokens.v3.yml':
-    - oas2-valid-schema-example
-  'subscriptions.sf.yml':
-    - operation-operationId
-  'tax_classes.v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'themes.v3.yml':
     - oas3-schema
     - operation-operationId
   'webhooks.v3.yml':
     - oas3-valid-media-example
-  'widgets.v3.yml':
-    - typed-enum
-    - oas2-anyOf
-    - oas2-valid-media-example
-  'wishlists.v3.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-  'checkouts.sf.yml#/host':
-    - oas2-schema
-  'form_fields.sf.yml#/host':
-    - oas2-schema
-  'orders.sf.yml#/host':
-    - oas2-schema
-  'subscriptions.sf.yml#/host':
-    - oas2-schema
-  'current_customer.yml#/host':
-    - oas2-schema
-  'customer_login.yml#/host':
-    - oas2-schema
-  'shipping_provider.yml#/host':
-    - oas2-schema
-  'reference/customers_v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
-  'customers_v2.yml':
-    - oas2-valid-media-example
-    - oas2-valid-schema-example
   'pages.v3.yml':
     - oas3-valid-media-example
     - oas3-valid-schema-example

CONTRIBUTING.md

@@ -1,11 +1,13 @@
 # Contributing to BigCommerce's API Specifications
 
-Thanks for showing interest in contributing!
+Thanks for your interest in contributing!
 
 ## Edit
-* **Edit:** Fork the repository and edit with your preferred editor (we recommend [VS Code](https://code.visualstudio.com/) or [Stoplight Studio](https://meta.stoplight.io/docs/studio)).
-* **Lint:** Check for errors using [Spectral](https://stoplight.io/open-source/spectral).
-* **Commit:** Write good commit messages using the guidelines in the following section
+
+* **Edit:** Fork the repository and edit with your preferred editor. We recommend [VS Code](https://code.visualstudio.com/).
+* **Lint:** Check for errors using [Spectral](https://stoplight.io/open-source/spectral) or another OAS linter.
+
+* **Commit:** Write good commit messages using the guidelines in the following section.
 * **Push** to your fork to ensure that your pull request contains the most up-to-date version of your code.
 
 ## Write descriptive commit messages
@@ -16,20 +18,18 @@ Thanks for showing interest in contributing!
 * Use the imperative mood ("Fix broken link to x" not "Fixes broken link to x").
 
 ## Pull request
-[What is a pull request?](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
 
-Internal users: Consult the repo's `internal_pr_template` to learn more about our pull request process. Then use the template to create your PR's description.
+[What is a pull request?](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
 
-External users: Consult the repo's `external_pr_template` to learn more about our pull request process. Then use the template to create your PR's description.
+Use the included `pull_request_template.md` to tell us more about the changes you propose.
 
 ## Tools
 
 The following tools might be helpful.
 
 | Tool | Description |
 |:-----|:------------|
-| [BigCommerce Stoplight Workspace](https://bigcommerce.stoplight.io/) | Our hosted documentation back end. <br> Contains editing tools for internal users.|
-| [Spectral CLI](https://stoplight.io/open-source/spectral) | Node.js CLI for Stoplight's OpenAPI linter |
-| [Spectral Linter for VS Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)| Stoplight's OpenAPI linter as a VS Code extension |
+| [Spectral CLI](https://stoplight.io/open-source/spectral) | Node.js CLI for the Spectral OpenAPI linter |
+| [Spectral Linter for VS Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)| The Spectral OpenAPI linter as a VS Code extension |
 | [swagger2openapi](https://www.npmjs.com/package/swagger2openapi)| Node.js CLI for converting Swagger to OpenAPI 3.0 |
 | [openapi.tools](https://openapi.tools/) | List of open-source OpenAPI tools |