Skip to content

Commit

Permalink
Merge branch 'main' into DEVDOCS-4028
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah Riehl committed Dec 28, 2023
2 parents f2d01b8 + 1e9d021 commit 2da6b3f
Show file tree
Hide file tree
Showing 596 changed files with 132,314 additions and 13,803 deletions.
25 changes: 25 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -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
}
]
}
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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/devdocs-codeowners @markcmurphy
@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
Expand Down
9 changes: 0 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE/publication_pr_template.md

This file was deleted.

7 changes: 0 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

This file was deleted.

25 changes: 25 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -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 }}
8 changes: 3 additions & 5 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
name: lint-valid-mdx

on:
pull_request:
branches: [migrate-DEVDOCS-4719]
- pull_request

jobs:
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Use Node.js v17.x
- name: Use Node.js v18.x
uses: actions/setup-node@v3
with:
node-version: 17.x
node-version: 18.x
- run: npm ci
- run: npm run lint
2 changes: 1 addition & 1 deletion .github/workflows/retext-style-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ jobs:
name: runner / retext-style-guide
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.2
- uses: actions/checkout@v3
- name: quality-docs-github-check
uses: bigcommerce/dev-docs-style-guide-action@master
with:
Expand Down
17 changes: 17 additions & 0 deletions .github/workflows/spectral.yml
Original file line number Diff line number Diff line change
@@ -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'

10 changes: 7 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
.idea
.scratch
.notes
node_modules
.DS_Store
.vscode
.idea
.scratch
.notes
.env
.bashrc
# .bash_profile

8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/api-specs.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18
114 changes: 114 additions & 0 deletions .spectral.yaml
Original file line number Diff line number Diff line change
@@ -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
38 changes: 0 additions & 38 deletions .stoplight.json

This file was deleted.

Loading

0 comments on commit 2da6b3f

Please sign in to comment.