Skip to content

Commit 6da9817

Browse files
committed
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into followup_breadcrumbs
2 parents 9a1e494 + 81372ce commit 6da9817

File tree

230 files changed

+5119
-988
lines changed

Some content is hidden

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

230 files changed

+5119
-988
lines changed

.github/workflows/check-build.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Style check
3+
4+
env:
5+
# Force the stdout and stderr streams to be unbuffered
6+
PYTHONUNBUFFERED: 1
7+
8+
on:
9+
pull_request:
10+
types:
11+
- synchronize
12+
- reopened
13+
- opened
14+
jobs:
15+
stylecheck:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
# Step 1: Check out the repository
20+
- name: Check out repository
21+
uses: actions/checkout@v3
22+
23+
# Step 2: Set up environment if required (e.g., installing Aspell)
24+
- name: Install Aspell
25+
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: Fail the build if the script returns exit code 1
35+
- name: Check exit code
36+
run: |
37+
if [ ${{ steps.spellcheck.outcome }} == 'failure' ]; then
38+
echo "Spellcheck failed. See the logs for details."
39+
exit 1
40+
fi

.github/workflows/pull-request.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ on: # yamllint disable-line rule:truthy
1414
- synchronize
1515
- reopened
1616
- opened
17-
branches-ignore:
18-
- 'new-nav'
1917

2018
# Cancel the previous wf run in PRs.
2119
concurrency:

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ orphaned_pages.txt
3535
active_links.txt
3636
active_links.json
3737

38-
# Files used by scripts to autogenerate settings
38+
# Files used by scripts to autogenerate settings and do spellcheck
3939
FormatFactorySettingsDeclaration.h
4040
FormatFactorySettings.h
4141
Settings.cpp
@@ -47,3 +47,5 @@ docs/en/cloud/manage/api/members-api-reference.md
4747
docs/en/cloud/manage/api/organizations-api-reference.md
4848
docs/en/cloud/manage/api/services-api-reference.md
4949
.vscode
50+
.aspell.en.prepl
51+
*.md.bak

docs/en/_snippets/_add_superset_detail.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Superset provides [installing Superset locally using Docker Compose](https://sup
66
There are a few tasks to be done before running `docker compose`:
77

88
1. Add the official ClickHouse Connect driver
9-
2. Optain a MapBox API key and add that as an environment variable (optional)
9+
2. Obtain a Mapbox API key and add that as an environment variable (optional)
1010
3. Specify the version of Superset to run
1111

1212
:::tip
@@ -21,11 +21,11 @@ To make the ClickHouse Connect driver available in the Superset deployment add i
2121
echo "clickhouse-connect" >> ./docker/requirements-local.txt
2222
```
2323

24-
## MapBox
24+
## Mapbox
2525

26-
This is optional, you can plot location data in Superset without a MapBox API key, but you will see a message telling you that you should add a key and the background image of the map will be missing (you will only see the data points and not the map background). MapBox provides a free tier if you would like to use it.
26+
This is optional, you can plot location data in Superset without a Mapbox API key, but you will see a message telling you that you should add a key and the background image of the map will be missing (you will only see the data points and not the map background). Mapbox provides a free tier if you would like to use it.
2727

28-
Some of the sample visualizations that the guides have you create use location, for example longitude and latitude, data. Superset includes support for MapBox maps. To use the MapBox visualizations you need a MapBox API key. Sign up for the [MapBox free tier](https://account.mapbox.com/auth/signup/), and generate an API key.
28+
Some of the sample visualizations that the guides have you create use location, for example longitude and latitude, data. Superset includes support for Mapbox maps. To use the Mapbox visualizations you need a Mapbox API key. Sign up for the [Mapbox free tier](https://account.mapbox.com/auth/signup/), and generate an API key.
2929

3030
Make the API key available to Superset:
3131

docs/en/_snippets/_gcp_regions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
| Region | Service Attachment | Private DNS domain |
22
|--------------|-------------------------------------------------------------|------------------------------|
3-
|asia-southeast1| projects/dataplane-production/regions/asia-southeast1/serviceAttachments/production-asia-southeast1-clickhouse-cloud| asia-southeast1.p.gcp.clickhouse.cloud|
4-
|europe-west4| projects/dataplane-production/regions/europe-west4/serviceAttachments/production-europe-west4-clickhouse-cloud| europe-west4.p.gcp.clickhouse.cloud|
5-
|us-central1| projects/dataplane-production/regions/us-central1/serviceAttachments/production-us-central1-clickhouse-cloud| us-central1.p.gcp.clickhouse.cloud|
6-
|us-east1| projects/dataplane-production/regions/us-east1/serviceAttachments/production-us-east1-clickhouse-cloud| us-east1.p.gcp.clickhouse.cloud|
3+
|`asia-southeast1`| `projects/dataplane-production/regions/asia-southeast1/serviceAttachments/production-asia-southeast1-clickhouse-cloud`| `asia-southeast1.p.gcp.clickhouse.cloud`|
4+
|`europe-west4`| `projects/dataplane-production/regions/europe-west4/serviceAttachments/production-europe-west4-clickhouse-cloud`| `europe-west4.p.gcp.clickhouse.cloud` |
5+
|`us-central1`| `projects/dataplane-production/regions/us-central1/serviceAttachments/production-us-central1-clickhouse-cloud` | `us-central1.p.gcp.clickhouse.cloud` |
6+
|`us-east1`| `projects/dataplane-production/regions/us-east1/serviceAttachments/production-us-east1-clickhouse-cloud` | `us-east1.p.gcp.clickhouse.cloud` |
77

88

99

0 commit comments

Comments
 (0)