Skip to content

Commit

Permalink
(no ticket): [dev] bump to node 18 (#1945)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Riehl <[email protected]>
  • Loading branch information
chanceaclark and Sarah Riehl authored May 30, 2023
1 parent 64d705d commit 09ea709
Show file tree
Hide file tree
Showing 9 changed files with 2,118 additions and 3,964 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ jobs:

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
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18
20 changes: 0 additions & 20 deletions .textlintrc

This file was deleted.

34 changes: 1 addition & 33 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
- [Editing Locally](#editing-locally)
- [Commit Messages](#commit-messages)
- [Style Guides](#style-guides)
- [Linting &amp; Spell Checking](#linting--spell-checking)
- [Contributing to Other Projects](#contributing-to-other-projects)

Thanks for showing interest in contributing!
Expand Down Expand Up @@ -60,37 +59,6 @@ For more complex changes, fork and edit locally:
- [Documentation Style Guide](_project/_doc_style_guide.md)
- [API Specification Style Guide](_project/_spec_style_guide.md)

## Linting & Spell Checking

```bash
# install grunt-cli
npm install -g grunt-cli

# make sure you're in dev-docs root dir
cd ~/path/to/dev-docs

# install the linters and spell checkers
npm install

# run mdspell to spell check:
grunt mdspell

# run textlint to lint / check for dead links:
grunt textlint
```

**Configuration Files**:

```shell
...
├── .spelling # mdspell dictionary
├── .textlintrc # textlint configuration file
├── Gruntfile.js # grunt configuration file
├── package-lock.json # packages for grunt, linting, and spell checking
├── package.json # packages for grunt, linting, and spell checking
...
```

## Contributing to Other Projects

There are many other public BigCommerce repositories accepting contributions. If you're interested in contributing to those projects, see the [full list of public source repos](https://github.com/bigcommerce?utf8=%E2%9C%93&q=is%3Apublic&type=source&language=). Also, consider joining the [BigCommerce Developer Community Group](https://support.bigcommerce.com/s/group/0F913000000HLjECAW/bigcommerce-developers).
There are many other public BigCommerce repositories accepting contributions. If you're interested in contributing to those projects, see the [full list of public source repos](https://github.com/bigcommerce?utf8=%E2%9C%93&q=is%3Apublic&type=source&language=). Also, consider joining the [BigCommerce Developer Community](https://developer.bigcommerce.com/community).
29 changes: 0 additions & 29 deletions Gruntfile.js

This file was deleted.

4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ If you're interested in contributing to BigCommerce Developer Documentation, see
├── .eslintrc.json # config for MDX linter
├── .gitignore # gitignore
├── .nojekyll
├── .spelling # mdspell dictionary
├── .textlintrc # textlint configuration file
├── .spelling
├── CONTRIBUTING # guidelines for contribution
├── Gruntfile.js # grunt configuration file
├── package-lock.json
├── package.json
├── pull_request_template.md # template for most pull requests
Expand Down
Loading

0 comments on commit 09ea709

Please sign in to comment.