Skip to content

Commit

Permalink
A little tidy-ing of the contributing folder (github#36123)
Browse files Browse the repository at this point in the history
  • Loading branch information
heiskr authored Apr 3, 2023
1 parent e4a04b5 commit 8b614cf
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 7 deletions.
5 changes: 3 additions & 2 deletions contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ Here, you'll find additional information that might be helpful as you work on a
- [content templates](./content-templates.md) - handy templates to get you started with a new article
- [deployments](./deployments.md) - how our staging and production environments work
- [liquid helpers](./liquid-helpers.md) - using liquid helpers for versioning in our docs
- [translations guide for writers](./translations/for-writers.md) - making sure your content is ready to be translated
- [translations guide for writers](./translations-for-writers.md) - making sure your content is ready to be translated
- [node versions](./node-versions.md) - our site runs on Node.js
- [permalinks](./permalinks.md) - permalinks for article versioning
- [redirects](./redirects.md) - configuring redirects in the site
- [search](./search.md) - our local site search functionality
- [troubleshooting](./troubleshooting.md) - some help for troubleshooting failed and stalled status checks

You can also read the READMEs in the `src/` directory to learn more about the features of the docs site.
3 changes: 2 additions & 1 deletion contributing/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This site is powered by Node.js! :sparkles: :turtle: :rocket: :sparkles:

It runs on macOS, Windows, and Linux environments.

You'll need Node.js to run the site. Check the version in `.node-version`. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](https://github.com/nodenv/nodenv#readme) for instructions on switching Node.js versions.
You'll need Node.js to run the site. Check the version in `package.json`. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](https://github.com/nodenv/nodenv#readme) for instructions on switching Node.js versions.

Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following:

Expand Down Expand Up @@ -71,6 +71,7 @@ For more info about working with this site, check out these READMEs:
- [data/variables/README.md](../data/variables/README.md)
- [includes/liquid-tags/README.md](../includes/liquid-tags/README.md)
- [includes/README.md](../includes/README.md)
<!-- The following will be moved into src directory over time: -->
- [components/README.md](../components/README.md)
- [lib/liquid-tags/README.md](../lib/liquid-tags/README.md)
- [middleware/README.md](../middleware/README.md)
Expand Down
File renamed without changes.
5 changes: 2 additions & 3 deletions contributing/node-versions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Node Versions

This site will run on the Node.js version specified in `.node-version`.
This site will run on the Node.js version specified in `package.json`.

When updating to a new Node.js version, consider the following files:

- [ ] The `engines.node` entry in `package.json`
- [ ] The `.node-version` file used by [nodenv](https://github.com/nodenv/nodenv), a tool for managing multiple Node.js versions on your machine.
- [ ] The `.github/*.workflow` Actions files
- [ ] The `Dockerfile` that can be used for deployments
- [ ] The `contributing/development.md` guide
Expand Down Expand Up @@ -33,7 +32,7 @@ If you're using another operating system, or did not use Homebrew to install nod
To install Node.js and make it your default version, run this command:

```sh
VERSION=`cat .node-version`
# Set VERSION= based on package.json#engines
nodenv install $VERSION && nodenv global $VERSION
```

Expand Down
2 changes: 1 addition & 1 deletion contributing/self-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For content changes, make sure that you:
- [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one).
- [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Remember that lists and tables can be tricky.
- [ ] Review the content for technical accuracy.
- [ ] Review the entire pull request using the [translations guide for writers](./translations/for-writers.md).
- [ ] Review the entire pull request using the [translations guide for writers](./translations-for-writers.md).
- [ ] Copy-edit the changes for grammar, spelling, and adherence to the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).
- [ ] Check new or updated Liquid statements to confirm that versioning is correct.
- [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing.
File renamed without changes.

0 comments on commit 8b614cf

Please sign in to comment.