Skip to content

Commit fd1c9e1

Browse files
authoredApr 14, 2025
Merge pull request #3677 from ClickHouse/linter_spellcheck
restructure linting and checks
2 parents 5cd5e1e + 7d2c55a commit fd1c9e1

Some content is hidden

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

59 files changed

+150
-230
lines changed
 

‎.github/workflows/check-build.yml

+5-10
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,10 @@ jobs:
2424
if: matrix.check_type == 'spellcheck'
2525
run: sudo apt-get update && sudo apt-get install -y aspell aspell-en
2626
- name: Set up Python
27-
if: matrix.check_type == 'kbcheck'
28-
uses: actions/setup-python@v5
29-
with:
30-
python-version: '3.x'
31-
- name: Install dependencies
3227
if: matrix.check_type == 'kbcheck'
3328
run: |
34-
python -m pip install --upgrade pip
35-
pip install -r 'scripts/knowledgebase-checker/requirements.txt'
29+
curl -Ls https://astral.sh/uv/install.sh | sh
30+
uv python install 3.12
3631
- name: Setup md-lint environment
3732
if: matrix.check_type == 'md-lint'
3833
uses: actions/setup-node@v3
@@ -47,13 +42,13 @@ jobs:
4742
id: check_step
4843
run: |
4944
if [[ "${{ matrix.check_type }}" == "spellcheck" ]]; then
50-
./scripts/check-doc-aspell
45+
yarn check-spelling
5146
exit_code=$?
5247
elif [[ "${{ matrix.check_type }}" == "kbcheck" ]]; then
53-
./scripts/knowledgebase-checker/knowledgebase_article_checker.py --kb-dir="knowledgebase"
48+
yarn check-kb
5449
exit_code=$?
5550
elif [[ "${{ matrix.check_type }}" == "md-lint" ]]; then
56-
yarn markdownlint-cli2 --config ./scripts/.markdownlint-cli2.yaml 'docs/**/*.md'
51+
yarn check-markdown
5752
exit_code=$?
5853
fi
5954

‎README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ We recommend to install rsync in order to only copy what is needed, however the
110110
111111
Running `yarn copy-clickhouse-repo-docs` without any arguments will pull in the latest docs changes from github.
112112
113+
To check spelling and markdown is correct locally run:
114+
115+
```bash
116+
yarn check-style
117+
```
118+
113119
### Notes {#notes}
114120
115121
Here are some things to keep in mind when building a local copy of the ClickHouse docs site.
@@ -134,7 +140,13 @@ Check out the GitHub docs for a refresher on [how to create a pull request](http
134140
135141
### Style guidelines
136142
137-
For documentation style guidelines, see ["Style guide"](/contribute/style-guide.md).
143+
For documentation style guidelines, see ["Style guide"](/contribute/style-guide.md).
144+
145+
To check spelling and markdown is correct locally run:
146+
147+
```bash
148+
yarn check-style
149+
```
138150
139151
### Generating documentation from source code
140152

0 commit comments

Comments
 (0)