From 8b614cf949a4db14956517dc92391a7287ca95d3 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Mon, 3 Apr 2023 09:00:22 -0700 Subject: [PATCH] A little tidy-ing of the contributing folder (#36123) --- contributing/README.md | 5 +++-- contributing/development.md | 3 ++- .../{github-partners/README.md => github-partners.md} | 0 contributing/node-versions.md | 5 ++--- contributing/self-review.md | 2 +- .../for-translators.md => translations-for-translators.md} | 0 .../for-writers.md => translations-for-writers.md} | 0 7 files changed, 8 insertions(+), 7 deletions(-) rename contributing/{github-partners/README.md => github-partners.md} (100%) rename contributing/{translations/for-translators.md => translations-for-translators.md} (100%) rename contributing/{translations/for-writers.md => translations-for-writers.md} (100%) diff --git a/contributing/README.md b/contributing/README.md index c5f8a04b5902..adf9ff4b4e52 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -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. diff --git a/contributing/development.md b/contributing/development.md index a5b7cfedd4e1..7634a20cc8a8 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -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: @@ -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) + - [components/README.md](../components/README.md) - [lib/liquid-tags/README.md](../lib/liquid-tags/README.md) - [middleware/README.md](../middleware/README.md) diff --git a/contributing/github-partners/README.md b/contributing/github-partners.md similarity index 100% rename from contributing/github-partners/README.md rename to contributing/github-partners.md diff --git a/contributing/node-versions.md b/contributing/node-versions.md index d47f374967c0..0c6d14a3fb67 100644 --- a/contributing/node-versions.md +++ b/contributing/node-versions.md @@ -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 @@ -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 ``` diff --git a/contributing/self-review.md b/contributing/self-review.md index ee24412f33ff..f1f462c0171e 100644 --- a/contributing/self-review.md +++ b/contributing/self-review.md @@ -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. diff --git a/contributing/translations/for-translators.md b/contributing/translations-for-translators.md similarity index 100% rename from contributing/translations/for-translators.md rename to contributing/translations-for-translators.md diff --git a/contributing/translations/for-writers.md b/contributing/translations-for-writers.md similarity index 100% rename from contributing/translations/for-writers.md rename to contributing/translations-for-writers.md