|
| 1 | +> [!NOTE] |
| 2 | +> You may find that there are errors for the `vale/lint` job that are unrelated to your change. |
| 3 | +> Vale checks the whole file when a change is made so if there are existing issues on the page they will be flagged. |
| 4 | +> You can ignore lint errors outside your changes and the CircleCI docs team will address them for you. |
| 5 | +> Vale logs are advisory to help all contributors create content that conforms to our style guide. The `vale/lint` job will not prevent changes from being published. |
| 6 | +
|
1 | 7 | # Description |
2 | 8 | What did you change? |
3 | 9 |
|
4 | 10 | # Reasons |
5 | | -Why did you make these changes? |
| 11 | +Why did you make these changes? What problem does this solve? |
| 12 | + |
| 13 | +# Content checks |
| 14 | +Please follow our style when contributing to CircleCI docs. View our [style guide](https://circleci.com/docs/style/style-guide-overview) or check out our [CONTRIBUTING.md](../CONTRIBUTING.md) for more information. |
6 | 15 |
|
7 | | -# Content Checklist |
8 | | -Please follow our style when contributing to CircleCI docs. Our style guide is here: [https://circleci.com/docs/style/style-guide-overview](https://circleci.com/docs/style/style-guide-overview). |
| 16 | +**Preview your changes:** |
| 17 | +- [ ] View the Vale linter results, select the `ci/circleci: lint` job at the bottom of your PR. You will be redirected to the `vale/lint` job output in CircleCI. |
| 18 | +- [ ] Preview your changes, select the `ci/circleci: build` job at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and select `index.html` to open a preview version of the docs site built for your latest commit. |
9 | 19 |
|
10 | | -Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs): |
| 20 | +Take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs): |
11 | 21 |
|
| 22 | +**Content structure:** |
12 | 23 | - [ ] Break up walls of text by adding paragraph breaks. |
13 | 24 | - [ ] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume. |
14 | | -- [ ] Keep the title between 20 and 70 characters. |
15 | 25 | - [ ] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume. |
16 | | -- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized). |
17 | 26 | - [ ] Include relevant backlinks to other CircleCI docs/pages. |
| 27 | + |
| 28 | +**Formatting:** |
| 29 | +- [ ] Keep the title between 20 and 70 characters. |
| 30 | +- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized). |
0 commit comments