DEVDOCS-5691: [migration] Add docs from current public repos (#2)

.cspell.json

@@ -0,0 +1,25 @@
+{
+  // Enable your dictionary by adding it to the list of `dictionaries`
+  "dictionaries": [
+    "core-glossary"
+  ],
+  "ignoreWords": [
+    "skip-list"
+  ],
+  // Tell CSpell about your dictionary
+  "dictionaryDefinitions": [
+    {
+      "name": "core-glossary",
+      // Path to the custom word file. Relative to this `cspell.json` file.
+      "path": "./.style/core-glossary.txt",
+      // Some editor extensions will use `addWords` for adding words to your
+      // personal dictionary.
+      "addWords": true
+    },
+    {
+      "name": "skip-list", //these aren't glossary words, but shouldn't be spell checked away
+      "path": "./.style/skip-list.txt",
+      "addWords": true
+    }
+  ]
+}

.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

@@ -0,0 +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.
+
+@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.

.github/workflows/deploy.yml

@@ -0,0 +1,25 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      buildWithCache:
+        description: 'Build with cache'
+        default: true
+        required: false
+        type: boolean
+
+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 }}?buildCache=${{ inputs.buildWithCache }}

.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 v18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - run: npm ci
+      - run: npm run lint

.github/workflows/retext-style-guide.yml

@@ -0,0 +1,15 @@
+name: remark
+on: [pull_request]
+jobs:
+  remark:
+    name: runner / retext-style-guide
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: quality-docs-github-check
+        uses: bigcommerce/dev-docs-style-guide-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          level: warning
+          filter_mode: added

.github/workflows/spectral.yml

@@ -0,0 +1,17 @@
+name: Run Spectral on Pull Requests
+on:
+  - pull_request
+jobs:
+  build:
+    name: Run Spectral
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the repository
+      - uses: actions/checkout@v2
+
+      # Run Spectral
+      - uses: stoplightio/spectral-action@latest
+        with:
+          file_glob: 'reference/*.yml'
+          spectral_ruleset: '.spectral.yaml'
+

.nvmrc

@@ -0,0 +1 @@
+18

.spectral.yaml

@@ -0,0 +1,114 @@
+extends: spectral:oas
+rules:
+  info-contact: off
+  oas3-unused-component: off
+  oas2-unused-definition: off
+except:
+  'reference/tax_provider.yml':
+    - oas3-schema
+  'reference/carts.v3.yml':
+    - oas2-oneOf
+    - oas2-valid-schema-example
+    - operation-tag-defined
+  'reference/catalog.v3.yml':
+    - oas2-operation-security-defined
+    - oas3-schema
+    - oas2-schema
+    - oas2-valid-media-example
+    - oas2-valid-schema-example
+  'reference/channels.v3.yml':
+    - operation-operationId
+    - oas3-schema
+    - oas3-valid-media-example
+  'reference/current_customer.yml':
+    - operation-success-response
+  'reference/custom-template-associations.v3.yml':
+    - openapi-tags
+    - operation-tag-defined
+  'reference/customer_login.yml':
+    - operation-operationId
+    - operation-success-response
+  'reference/email_templates.v3.yml':
+    - oas3-schema
+    - operation-tag-defined
+    - openapi-tags
+  'reference/geography.v2.yml':
+    - operation-operationId
+    - oas2-valid-media-example
+  'reference/orders.v2.oas2.yml':
+    - oas3-valid-schema-example
+    - oas3-valid-media-example
+    - oas3-schema
+  'reference/orders.v3.yml':
+    - oas2-valid-schema-example
+    - oas2-valid-media-example
+    - oas2-anyOf
+  'reference/settings.v3.yml':
+    - oas3-valid-media-example
+    - operation-operationId
+  'reference/sites.v3.yml':
+    - oas2-valid-media-example
+    - operation-operationId
+  'reference/store_information.v2.yml':
+    - oas2-valid-media-example
+    - operation-operationId
+    - oas2-valid-schema-example
+  'reference/themes.v3.yml':
+    - oas3-schema
+    - operation-operationId
+  'reference/webhooks.v3.yml':
+    - oas3-valid-media-example
+  'carts.v3.yml':
+    - oas2-oneOf
+    - oas2-valid-schema-example
+    - operation-tag-defined
+  'catalog.v3.yml':
+    - oas2-operation-security-defined
+    - oas3-schema
+    - oas2-schema
+    - oas2-valid-media-example
+    - oas2-valid-schema-example
+  'channels.v3.yml':
+    - operation-operationId
+    - oas3-schema
+    - oas3-valid-media-example
+  'current_customer.yml':
+    - operation-success-response
+  'custom-template-associations.v3.yml':
+    - openapi-tags
+    - operation-tag-defined
+  'customer_login.yml':
+    - operation-success-response
+  'email_templates.v3.yml':
+    - oas3-schema
+    - operation-tag-defined
+    - openapi-tags
+  'geography.v2.yml':
+    - operation-operationId
+    - oas2-valid-media-example
+  'orders.v2.oas2.yml':
+    - oas3-valid-schema-example
+    - oas3-valid-media-example
+    - oas3-schema
+  'orders.v3.yml':
+    - oas2-valid-schema-example
+    - oas2-valid-media-example
+    - oas2-anyOf
+  'settings.v3.yml':
+    - oas3-valid-media-example
+    - operation-operationId
+  'sites.v3.yml':
+    - oas2-valid-media-example
+    - operation-operationId
+  'store_information.v2.yml':
+    - oas2-valid-media-example
+    - operation-operationId
+    - oas2-valid-schema-example
+  'themes.v3.yml':
+    - oas3-schema
+    - operation-operationId
+  'webhooks.v3.yml':
+    - oas3-valid-media-example
+  'pages.v3.yml':
+    - oas3-valid-media-example
+    - oas3-valid-schema-example