Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ words:
- Docsy
- dwelsch
- fluxcd
- github
- keda
- knative
- kedacore
Expand Down
15 changes: 15 additions & 0 deletions .github/actions/npm-ci-via-cached-nvmrc/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: npm ci via cached .nvmrc
description: >-
Installs Node from .nvmrc with npm cache enabled and runs npm ci. The job must
run actions/checkout before this action.

runs:
using: composite
steps:
- uses: actions/setup-node@v6
with:
node-version-file: .nvmrc
cache: npm
- name: Install dependencies
run: npm ci
shell: bash
18 changes: 4 additions & 14 deletions .github/workflows/format-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,14 @@ jobs:
name: FILE FORMAT
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: package.json
- run: npm install
- uses: actions/checkout@v6
- uses: ./.github/actions/npm-ci-via-cached-nvmrc
- run: npm run check:format

markdown-linter:
name: MARKDOWN linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: package.json
- run: npm install
- uses: actions/checkout@v6
- uses: ./.github/actions/npm-ci-via-cached-nvmrc
- run: npm run check:markdown
9 changes: 2 additions & 7 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ jobs:
name: LINK checking
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: package.json
- run: npm install
- uses: actions/checkout@v6
- uses: ./.github/actions/npm-ci-via-cached-nvmrc
- run: npm run check:links
9 changes: 2 additions & 7 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ jobs:
name: SPELLING check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: package.json
- run: npm install
- uses: actions/checkout@v6
- uses: ./.github/actions/npm-ci-via-cached-nvmrc
- run: npm run check:spelling
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,5 @@ dist

# npm assets
node_modules/
package-lock.json

/tmp
7 changes: 6 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ const config: Config = {
projectName: 'techdocs',

onBrokenLinks: 'warn', // TODO: 'error' or 'throw' once we've fixed all links
onBrokenMarkdownLinks: 'warn',

markdown: {
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},

trailingSlash: true,

Expand Down
Loading