Skip to content

Commit 9b30142

Browse files
BlargianBlargian
authored
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into mysql-clickpipes-datetime00
2 parents fe7c47d + 3fbd0b4 commit 9b30142

File tree

444 files changed

+7874
-3436
lines changed

Some content is hidden

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

444 files changed

+7874
-3436
lines changed

‎.github/workflows/badges-notify.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Weekly Badge Monitor
2+
3+
on:
4+
schedule:
5+
# Run every Monday at 10:00 AM Amsterdam time (UTC+1/+2)
6+
# Using 8:00 UTC to account for Amsterdam time (adjusts for DST)
7+
- cron: '0 8 * * 1'
8+
workflow_dispatch: # Allow manual triggering
9+
10+
jobs:
11+
monitor-badges:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Make script executable
19+
run: chmod +x scripts/badger.sh
20+
21+
- name: Run badge finder script
22+
id: find_badges
23+
run: |
24+
# Run the script and capture output
25+
SCRIPT_OUTPUT=$(scripts/badger.sh)
26+
27+
# Escape the output for JSON and store in GitHub output
28+
# Replace newlines with \n and escape quotes
29+
ESCAPED_OUTPUT=$(echo "$SCRIPT_OUTPUT" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed ':a;N;$!ba;s/\n/\\n/g')
30+
31+
echo "badges_output<<EOF" >> $GITHUB_OUTPUT
32+
echo "$ESCAPED_OUTPUT" >> $GITHUB_OUTPUT
33+
echo "EOF" >> $GITHUB_OUTPUT
34+
35+
- name: Send webhook
36+
env:
37+
WEBHOOK_URL: ${{ secrets.DOCS_BADGER }}
38+
BADGES_OUTPUT: ${{ steps.find_badges.outputs.badges_output }}
39+
run: |
40+
# Create JSON payload
41+
JSON_PAYLOAD=$(cat <<EOF
42+
{
43+
"badges_list": "$BADGES_OUTPUT"
44+
}
45+
EOF
46+
)
47+
48+
# Send webhook
49+
curl -X POST \
50+
-H "Content-Type: application/json" \
51+
-d "$JSON_PAYLOAD" \
52+
"$WEBHOOK_URL"
53+
54+
- name: Log completion
55+
run: |
56+
echo "Badge monitoring completed successfully"
57+
echo "Webhook sent to configured endpoint"

‎.gitignore‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,18 @@ static/knowledgebase_toc.json
5555
.frontmatter-validation-failed
5656
logs/
5757

58+
# Landing page files with autogenerated table of contents
59+
docs/cloud/reference/release-notes-index.md
60+
docs/cloud/manage/api/api-reference-index.md
61+
docs/getting-started/index.md
62+
docs/data-modeling/projections/index.md
63+
docs/cloud/manage/jan2025_faq/index.md
64+
docs/chdb/guides/index.md
65+
5866
.vscode
5967
.aspell.en.prepl
6068
*.md.bak
6169

6270
**.translated
6371
**.translate
6472
/ClickHouse/
65-
66-
# Ignore table of contents files
67-
docs/cloud/reference/release-notes-index.md
68-
docs/whats-new/changelog/index.md
69-
docs/cloud/manage/api/api-reference-index.md
70-
docs/getting-started/index.md

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -171,28 +171,28 @@ Have you noticed a typo or found some wonky formatting? For small contributions
171171
172172
1. Each page in Clickhouse.com/docs has an **Edit this page** link at the top:
173173
174-
![The ClickHouse Docs website with the edit button highlighted.](./static/images/contribute/readme-edit-this-page.png)
174+
![The ClickHouse Docs website with the edit button highlighted.](./static/images/contributing/readme-edit-this-page.png)
175175
176176
Click this button to edit this page in GitHub.
177177
178178
1. Once you're in GitHub, click the pencil icon to edit this page:
179179

180-
![README Pencil Icon](./static/images/contribute/readme-pencil-icon.png)
180+
![README Pencil Icon](./static/images/contributing/readme-pencil-icon.png)
181181

182182
1. GitHub will _fork_ the repository for you. This creates a copy of the `clickhouse-docs` repository on your personal GitHub account.
183183
1. Make your changes in the textbox. Once you're done, click **Commit changes**:
184184
185-
![README Commit Changes](./static/images/contribute/readme-commit-changes.png)
185+
![README Commit Changes](./static/images/contributing/readme-commit-changes.png)
186186
187187
1. In the **Propose changes** popup, enter a descriptive title to explain the changes you just made. Keep this title to 10 words or less. If your changes are fairly complex and need further explanation, enter your comments into the **Extended description** field.
188188
1. Make sure **Create a new branch** is selected, and click **Propose changes**:
189189
190-
![README Propose Changes](./static/images/contribute/readme-propose-changes.png)
190+
![README Propose Changes](./static/images/contributing/readme-propose-changes.png)
191191
192192
1. A new page should open with a new pull request. Double-check that the title and description are accurate.
193193
1. If you've spoken to someone on the docs team about your changes, tag them into the **Reviewers** section:
194194

195-
![README Create Pull Request](./static/images/contribute/readme-create-pull-request.png)
195+
![README Create Pull Request](./static/images/contributing/readme-create-pull-request.png)
196196

197197
If you haven't mentioned your changes to anyone yet, leave the **Reviewers** section blank.
198198

‎contribute/autogenerated-documentation-from-source.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
# Generating documentation from source code
22

33
A [script in our docs repo](https://github.com/ClickHouse/clickhouse-docs/blob/main/scripts/settings/autogenerate-settings.sh)
4-
extracts setting names, descriptions, default values, etc. from ClickHouse's source code.
4+
is used to run SQL queries which generate markdown documentation from the system tables in ClickHouse and insert it
5+
into the appropriate pages before build time of the docs.
56

67
## Session settings
78

89
Documentation for session settings is autogenerated from source file [`src/Core/Settings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Settings.cpp).
10+
[SQL](../scripts/settings/session-settings.sql)
911

1012
## Format settings
1113

1214
Documentation for session settings is autogenerated from source file [`src/Core/FormatFactorySettings.h`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/FormatFactorySettings.h).
15+
[SQL](../scripts/settings/format-settings.sql)
1316

1417
## Server settings
1518

@@ -43,14 +46,33 @@ If it is, then please edit the setting description in the source code documentat
4346
in [`ServerSettings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/ServerSettings.cpp)
4447
or else edit `_server_settings_outside_source.md`.**
4548

49+
[SQL](../scripts/settings/global-server-settings.sql)
50+
4651
## MergeTree settings
4752

4853
Documentation for MergeTree settings is autogenerated from [MergeTreeSettings.cpp](https://github.com/ClickHouse/ClickHouse/blob/master/src/Storages/MergeTree/MergeTreeSettings.cpp)
4954

55+
[SQL](../scripts/settings/mergetree-settings.sql)
56+
5057
## System tables
5158

52-
TO DO. ETA April.
59+
TO DO
5360

5461
## Functions
5562

56-
TO DO. ETA April/May.
63+
Documentation for functions is autogenerated from the documentation in system tables (`system.functions`) which is
64+
registered along with the function registration in the C++ code.
65+
66+
To add a new page:
67+
- add SQL to generate the markdown from system tables
68+
- update `autogenerate-settings.sh` in the section which specifies which markdown file contents to
69+
copy to which file in between the `<!--AUTOGENERATED_START-->` and `<!--AUTOGENERATED_END-->`
70+
71+
The following pages are autogenerated from the source code for functions:
72+
- [Arithmetic](/sql-reference/functions/arithmetic-functions) ([SQL](../scripts/settings/arithmetic-functions.sql))
73+
- [Arrays](/sql-reference/functions/array-functions) ([SQL](../scripts/settings/array-functions.sql))
74+
- [Bit](/sql-reference/functions/bit-functions) ([SQL](../scripts/settings/bit-functions.sql))
75+
- [Bitmap](/sql-reference/functions/bitmap-functions) ([SQL](../scripts/settings/bitmap-functions.sql))
76+
- [Comparison](/sql-reference/functions/comparison-functions) ([SQL](../scripts/settings/comparison-functions.sql))
77+
- [Conditional](/sql-reference/functions/conditional-functions) ([SQL](../scripts/settings/conditional-functions.sql))
78+

‎docs/about-us/adopters.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The following list of companies using ClickHouse and their success stories is as
6969
| [Beeline](https://beeline.ru/) | Telecom | Data Platform | [Blog post, July 2021](https://habr.com/en/company/beeline/blog/567508/) | — | — |
7070
| [Beekeeper](https://www.beekeeper.io/) | Workforce Enablement | Analytics | [Blog post, April 2024](https://www.meetup.com/clickhouse—switzerland—meetup—group/events/299628922) | — | — |
7171
| [Beetested](https://www.beetested.com/) | Software & Technology | Game Testing | [Case Study, June 2023](https://double.cloud/resources/case—studies/beetested—analyze—millions—of—gamers—emotions—with—doublecloud/) | — | — |
72-
| [Benocs](https://www.benocs.com/) | Network Telemetry and Analytics | Main Product | [Meetup Video, December 2022](https://www.youtube.com/watch?v=48pAVShkeCY&list=PL0Z2YDlm0b3iNDUzpY1S3L_iV4nARda_U&index=12) [Slides, December 2022](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup66/Self%20repairing%20processing%20using%20ClickHouse.pdf) [Blog Post, March 2022](https://clickhouse.com/blog/—indexing—for—data—streams—benocs—telco/) [Slides in English, October 2017](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup9/lpm.pdf) | — | — |
72+
| [Benocs](https://www.benocs.com/) | Network Telemetry and Analytics | Main Product | [Slides, December 2022](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup66/Self%20repairing%20processing%20using%20ClickHouse.pdf) [Blog Post, March 2022](https://clickhouse.com/blog/—indexing—for—data—streams—benocs—telco/) [Slides in English, October 2017](https://github.com/ClickHouse/clickhouse—presentations/blob/master/meetup9/lpm.pdf) | — | — |
7373
| [Bento](https://bento.me/en/home) | Software & Technology | Personal Portfolio | [Twitter, May 2023](https://twitter.com/gubmee/status/1653405962542219264) | — | — |
7474
| [Better Stack](https://betterstack.com/) | Cloud, SaaS | Log Management | [Official Website](https://betterstack.com/logtail) | — | — |
7575
| [BiliBili](https://www.bilibili.com/) | Video sharing | — | [Blog post, June 2021](https://chowdera.com/2021/06/20210622012241476b.html) | — | — |

0 commit comments

Comments
 (0)