Skip to content

Commit 975e84a

Browse files
committed
Merge branch 'main' into japanese_docs_fixed
2 parents 5f82c43 + cb3c66e commit 975e84a

File tree

86 files changed

+4450
-2714
lines changed

Some content is hidden

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

86 files changed

+4450
-2714
lines changed

.github/workflows/check-build.yml

+37-28
Original file line numberDiff line numberDiff line change
@@ -14,47 +14,56 @@ on:
1414
jobs:
1515
stylecheck:
1616
runs-on: ubuntu-latest
17-
17+
strategy:
18+
matrix:
19+
check_type: [spellcheck, kbcheck]
1820
steps:
19-
# Step 1: Check out the repository
20-
- name: Check out repository
21-
uses: actions/checkout@v4
22-
23-
# Step 2: Set up environment if required (e.g., installing Aspell)
21+
- uses: actions/checkout@v4
2422
- name: Install Aspell
23+
if: matrix.check_type == 'spellcheck'
2524
run: sudo apt-get update && sudo apt-get install -y aspell aspell-en
26-
27-
# Step 3: Run the spellcheck script
28-
- name: Run spellcheck
29-
run: |
30-
./scripts/check-doc-aspell
31-
continue-on-error: true
32-
id: spellcheck
33-
34-
# Step 4: Setup Python and dependencies for KB checker
3525
- name: Set up Python
26+
if: matrix.check_type == 'kbcheck'
3627
uses: actions/setup-python@v5
3728
with:
3829
python-version: '3.x'
39-
40-
# Step 5: Install Python dependencies
4130
- name: Install dependencies
31+
if: matrix.check_type == 'kbcheck'
4232
run: |
4333
python -m pip install --upgrade pip
4434
pip install -r 'scripts/knowledgebase-checker/requirements.txt'
4535
46-
# Step 5: Run knowledgebase article checker
47-
- name: Check KB
48-
run: |
49-
./scripts/knowledgebase-checker/knowledgebase_article_checker.py --kb-dir="knowledgebase"
50-
continue-on-error: true
51-
id: kbcheck
52-
53-
# Step 6: Fail the build if any script returns exit code 1
54-
- name: Check exit code
36+
- name: Run checks
37+
id: check_step
5538
run: |
56-
if [[ "${{ steps.spellcheck.outcome }}" == "failure" ]] || [[ "${{ steps.kbcheck.outcome }}" == "failure" ]]; then
57-
echo "Style check failed. See the logs for details."
39+
if [[ "${{ matrix.check_type }}" == "spellcheck" ]]; then
40+
./scripts/check-doc-aspell
41+
exit_code=$?
42+
elif [[ "${{ matrix.check_type }}" == "kbcheck" ]]; then
43+
./scripts/knowledgebase-checker/knowledgebase_article_checker.py --kb-dir="knowledgebase"
44+
exit_code=$?
45+
fi
46+
47+
if [[ $exit_code -ne 0 ]]; then
48+
echo "::error::${{ matrix.check_type }} check failed. See logs for details."
5849
exit 1
5950
fi
51+
52+
- name: Set check status
53+
if: steps.check_step.outcome != 'success'
54+
uses: actions/github-script@v6
55+
with:
56+
script: |
57+
core.setFailed('${{ matrix.check_type }} check failed.');
58+
59+
check_overall_status:
60+
needs: stylecheck
61+
runs-on: ubuntu-latest
62+
if: always() # run the job even if stylecheck fails
63+
steps:
64+
- name: Check overall results
65+
if: needs.stylecheck.result != 'success'
66+
run: |
67+
echo "::error::One or more checks of the style check failed."
68+
exit 1
6069

docs/en/_snippets/_users-and-roles-common.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Roles are used to define groups of users for certain privileges instead of manag
170170

171171
1. Log into the clickhouse client using the `clickhouse_admin` user
172172

173-
```
173+
```bash
174174
clickhouse-client --user clickhouse_admin --password password
175175
```
176176

@@ -194,7 +194,7 @@ Roles are used to define groups of users for certain privileges instead of manag
194194

195195
3. Log into the ClickHouse client using the `column_user` user
196196

197-
```
197+
```bash
198198
clickhouse-client --user column_user --password password
199199
```
200200

@@ -245,7 +245,7 @@ Roles are used to define groups of users for certain privileges instead of manag
245245

246246
1. Log into the ClickHouse client using `row_user`
247247

248-
```
248+
```bash
249249
clickhouse-client --user row_user --password password
250250
```
251251

@@ -295,7 +295,7 @@ For example, if one `role1` allows for only select on `column1` and `role2` allo
295295

296296
4. Log into the ClickHouse client using `row_and_column_user`
297297

298-
```
298+
```bash
299299
clickhouse-client --user row_and_column_user --password password;
300300
```
301301

docs/en/chdb/guides/clickhouse-local.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ from chdb import session as chs
9898

9999
Initialize a session pointing to `demo..chdb`:
100100

101-
```
101+
```python
102102
sess = chs.Session("demo.chdb")
103103
```
104104

docs/en/chdb/guides/querying-pandas.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ from chdb import session as chs
321321

322322
Initialize a session:
323323

324-
```
324+
```python
325325
sess = chs.Session()
326326
```
327327

docs/en/cloud/manage/account-close.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ below.
3939
3. Click the Help button (question mark in the upper right corner of the screen).
4040
4. Under 'Support' click 'Create case.'
4141
5. In the 'Create new case' screen, enter the following:
42-
```
42+
43+
```text
4344
Priority: Severity 3
4445
Subject: Please close my ClickHouse account
4546
Description: We would appreciate it if you would share a brief note about why you are cancelling.
4647
```
48+
4749
5. Click 'Create new case'
4850
6. We will close your account and send a confirmation email to let you know when it is complete.
4951

0 commit comments

Comments
 (0)