Skip to content

Commit 06993e2

Browse files
Fix CI/CD and GitHub Actions casing, add Vale exceptions
- Restore proper casing for 'GitHub Actions' (not 'GitHub actions') - Restore proper casing for 'CI/CD' (not 'Ci/cd') - Restore proper casing for 'CircleCI' (not 'Circleci') - Restore proper casing for 'GitLab CI' (not 'GitLab ci') - Add exceptions to Vale Headings.yml for: GitHub, Actions, CI/CD, CircleCI, GitLab Co-Authored-By: Devin Logan <[email protected]>
1 parent 5d45fb8 commit 06993e2

File tree

6 files changed

+23
-18
lines changed

6 files changed

+23
-18
lines changed

.vale/styles/FernStyles/Headings.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,8 @@ exceptions:
2727
- Support
2828
- Markdown
2929
- Docs
30+
- GitHub
31+
- Actions
32+
- CI/CD
33+
- CircleCI
34+
- GitLab

fern/products/api-def/asyncapi-pages/automation.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Automatically sync your AsyncAPI spec changes to keep SDKs and docs up
55

66
Keeping your AsyncAPI specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process.
77

8-
## GitHub actions
8+
## GitHub Actions
99

1010
Use Fern's GitHub Action to automatically update SDKs and docs when your AsyncAPI spec changes:
1111

@@ -99,9 +99,9 @@ api:
9999
version: 0.8.8
100100
```
101101
102-
## Ci/cd integration
102+
## CI/CD integration
103103
104-
### Circleci
104+
### CircleCI
105105
```yaml title=".circleci/config.yml" {15-23}
106106
version: 2.1
107107

@@ -126,7 +126,7 @@ workflows:
126126
- fern-context
127127
```
128128
129-
### GitLab ci
129+
### GitLab CI
130130
```yaml title=".gitlab-ci.yml" {13-20}
131131
stages:
132132
- build
@@ -200,4 +200,4 @@ api:
200200
version: 0.8.8
201201
```
202202
203-
This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
203+
This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.

fern/products/api-def/grpc-pages/automation.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Automatically sync your Protocol Buffer changes to keep SDKs and docs
55

66
Keeping your gRPC specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process.
77

8-
## GitHub actions
8+
## GitHub Actions
99

1010
Use Fern's GitHub Action to automatically update SDKs and docs when your Protocol Buffer files change:
1111

@@ -128,9 +128,9 @@ api:
128128
version: 0.8.8
129129
```
130130
131-
## Ci/cd integration
131+
## CI/CD integration
132132
133-
### Circleci
133+
### CircleCI
134134
```yaml title=".circleci/config.yml" {15-26}
135135
version: 2.1
136136

@@ -170,7 +170,7 @@ jobs:
170170
find proto -name "*.proto" -exec protoc --proto_path=proto --descriptor_set_out=/dev/null {} \;
171171
```
172172
173-
### GitLab ci
173+
### GitLab CI
174174
```yaml title=".gitlab-ci.yml" {13-25}
175175
stages:
176176
- build

fern/products/api-def/openrpc-pages/automation.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Automatically sync your OpenRPC spec changes to keep SDKs and docs up
55

66
Keeping your OpenRPC specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process.
77

8-
## GitHub actions
8+
## GitHub Actions
99

1010
Use Fern's GitHub Action to automatically update SDKs and docs when your OpenRPC spec changes:
1111

@@ -99,9 +99,9 @@ api:
9999
version: 0.8.8
100100
```
101101
102-
## Ci/cd integration
102+
## CI/CD integration
103103
104-
### Circleci
104+
### CircleCI
105105
```yaml title=".circleci/config.yml" {15-23}
106106
version: 2.1
107107

@@ -126,7 +126,7 @@ workflows:
126126
- fern-context
127127
```
128128
129-
### GitLab ci
129+
### GitLab CI
130130
```yaml title=".gitlab-ci.yml" {13-20}
131131
stages:
132132
- build

fern/products/docs/pages/getting-started/pr-preview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ fern generate --docs --preview
2323
└─
2424
```
2525

26-
## Usage in GitHub actions
26+
## Usage in GitHub Actions
2727

28-
The following is a GitHub Action workflow that generates a preview URL for every pull request. [Be sure to add the `FERN_TOKEN` for your organization to the repository](/learn/cli-api/cli-reference/commands#fern-token).
28+
The following is a GitHub Action workflow that generates a preview URL for every pull request. [Be sure to add the `FERN_TOKEN` for your organization to the repository](/learn/cli-api/cli-reference/commands#fern-token).
2929

3030
<CodeBlock title = ".github/workflows/preview-docs.yml">
3131
```yaml

fern/products/docs/pages/getting-started/publishing-your-docs.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ fern generate --docs
2626
└─
2727
```
2828

29-
### Usage in GitHub actions
30-
To automate the publishing process, you can use a GitHub Action workflow to publish your docs when a push is made to the `main` branch. [Be sure to add the `FERN_TOKEN` for your organization to the repository](/learn/cli-api/cli-reference/commands#fern-token).
29+
### Usage in GitHub Actions
30+
To automate the publishing process, you can use a GitHub Action workflow to publish your docs when a push is made to the `main` branch. [Be sure to add the `FERN_TOKEN` for your organization to the repository](/learn/cli-api/cli-reference/commands#fern-token).
3131

3232
```yaml .github/workflows/publish-docs.yml
3333
name: Publish Docs
@@ -80,4 +80,4 @@ navigation: []
8080

8181
Publish the updated configuration by running `fern generate --docs`. This will remove all content from your site, and users visiting any page will see a 404 error.
8282
</Step>
83-
</Steps>
83+
</Steps>

0 commit comments

Comments
 (0)