Skip to content

Commit 0cd655b

Browse files
committed
bring in new claims in correct section
2 parents 2047950 + 3558130 commit 0cd655b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2490
-1683
lines changed

.github/pull_request_template.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
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+
17
# Description
28
What did you change?
39

410
# 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.
615

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.
919

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):
1121

22+
**Content structure:**
1223
- [ ] Break up walls of text by adding paragraph breaks.
1324
- [ ] 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.
1525
- [ ] 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).
1726
- [ ] 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).

.vale.ini

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,8 @@ experimental = YES
1818
attribute-missing = drop
1919

2020
[*.adoc]
21-
BasedOnStyles = circleci-docs, Vale, Readability, Openly, AsciiDoc
21+
BasedOnStyles = circleci-docs, Vale, Readability, Openly, AsciiDoc
22+
23+
[**/nav.adoc]
24+
circleci-docs.XrefTitleCase = NO
25+
circleci-docs.ListPunctuation = NO

ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# CircleCI Docs Static Site: Architecture
1+
# CircleCI docs site: Architecture
22

3-
This document provides an in-depth look at the architecture of the CircleCI Docs Static Site project.
3+
This document provides an in-depth look at the architecture of the CircleCI docs site project.
44

55
## Table of Contents
66
- [Overview](#overview)
@@ -12,7 +12,7 @@ This document provides an in-depth look at the architecture of the CircleCI Docs
1212

1313
## Overview
1414

15-
The CircleCI Docs Static Site is built using [Antora](https://antora.org/), a multi-repository documentation site generator. The project is structured as a collection of components, each represented by a directory in the `docs/` folder.
15+
The CircleCI docs site is built using [Antora](https://antora.org/), a multi-repository documentation site generator. The project is structured as a collection of components, each represented by a directory in the `docs/` folder.
1616

1717
### Key Architectural Principles
1818

0 commit comments

Comments
 (0)