Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into scripts_refactor

Author: Blargian

.github/workflows/check-build.yml

@@ -0,0 +1,60 @@
+---
+name: Style check
+
+env:
+  # Force the stdout and stderr streams to be unbuffered
+  PYTHONUNBUFFERED: 1
+
+on:
+  pull_request:
+    types:
+      - synchronize
+      - reopened
+      - opened
+jobs:
+  stylecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: Check out the repository
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      # Step 2: Set up environment if required (e.g., installing Aspell)
+      - name: Install Aspell
+        run: sudo apt-get update && sudo apt-get install -y aspell aspell-en
+
+      # Step 3: Run the spellcheck script
+      - name: Run spellcheck
+        run: |
+          ./scripts/check-doc-aspell
+        continue-on-error: true
+        id: spellcheck
+
+      # Step 4: Setup Python and dependencies for KB checker
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+
+      # Step 5: Install Python dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r 'scripts/knowledgebase-checker/requirements.txt'
+
+      # Step 5: Run knowledgebase article checker
+      - name: Check KB
+        run: |
+          ./scripts/knowledgebase-checker/knowledgebase_article_checker.py --kb-dir="knowledgebase"
+        continue-on-error: true
+        id: kbcheck
+
+      # Step 6: Fail the build if any script returns exit code 1
+      - name: Check exit code
+        run: |
+          if [[ "${{ steps.spellcheck.outcome }}" == "failure" ]] || [[ "${{ steps.kbcheck.outcome }}" == "failure" ]]; then
+            echo "Style check failed. See the logs for details."
+            exit 1
+          fi
+          

.github/workflows/pull-request.yml

@@ -14,8 +14,6 @@ on:  # yamllint disable-line rule:truthy
       - synchronize
       - reopened
       - opened
-    branches-ignore:
-      - 'new-nav'
 
 # Cancel the previous wf run in PRs.
 concurrency:

.gitignore

@@ -35,7 +35,17 @@ orphaned_pages.txt
 active_links.txt
 active_links.json
 
-# Files used by scripts to autogenerate settings
+# Files used by scripts to autogenerate settings and do spellcheck
 FormatFactorySettingsDeclaration.h
 FormatFactorySettings.h
 Settings.cpp
+
+# Files whose content gets autogenerated
+docs/en/cloud/manage/api/invitations-api-reference.md
+docs/en/cloud/manage/api/keys-api-reference.md
+docs/en/cloud/manage/api/members-api-reference.md
+docs/en/cloud/manage/api/organizations-api-reference.md
+docs/en/cloud/manage/api/services-api-reference.md
+.vscode
+.aspell.en.prepl
+*.md.bak

clickhouseapi.js

@@ -52,7 +52,7 @@ function generateDocusaurusMarkdown(spec, groupedEndpoints, prefix) {
 
       markdownContent += `| Method | Path |\n`
       markdownContent += `| :----- | :--- |\n`
-      markdownContent += `| ${method.toUpperCase()} | ${path} |\n\n`
+      markdownContent += `| ${method.toUpperCase()} | \`${path}\` |\n\n`
 
       markdownContent += `### Request\n\n`;
 

contrib-writing-guide.md

@@ -43,7 +43,7 @@ sudo apt-get install npm
 sudo npm install --global yarn
 ```
 
-note: if the Node version available in your distro is old (<=v16), you can use [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to pick a specific one.
+note: if the Node version available in your distro is old (`<=v16`), you can use [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to pick a specific one.
 
 for example to use node 18:
 
@@ -477,10 +477,12 @@ cd $DOCS/ClickHouse/tests/integration/
 
 Code highlighting is based on the language chosen for your code blocks.  Specify the language when you start the code block:
 
-<pre lang="no-highlight"><code>```sql
+<pre lang="no-highlight"><code>
+```sql
 SELECT firstname from imdb.actors;
 ```
-</code></pre>
+</code>
+</pre>
 
 ```sql
 SELECT firstname from imdb.actors;

copyClickhouseRepoDocs.sh

@@ -1,12 +1,15 @@
-#! ./bin/bash
+#! /bin/bash
 
 SCRIPT_NAME=$(basename "$0")
 
+rm -rf ClickHouse
 echo "[$SCRIPT_NAME] Start tasks for copying docs from ClickHouse repo"
 
 # Clone ClickHouse repo
 echo "[$SCRIPT_NAME] Start cloning ClickHouse repo"
-git clone --depth 1 https://github.com/ClickHouse/ClickHouse.git
+git clone --depth 1 https://github.com/ClickHouse/ClickHouse.git temp
+cp -r temp/ ClickHouse/
+rm -rf temp
 echo "[$SCRIPT_NAME] Cloning completed"
 
 # Copy docs folders from ClickHouse repo to docs folder
@@ -28,13 +31,21 @@ echo "[$SCRIPT_NAME] Copying completed"
 
 echo "[$SCRIPT_NAME] Generate changelog"
 cp docs/en/_placeholders/changelog/_index.md docs/en/whats-new/changelog/index.md
-sed "0,/^# $(date +%Y) Changelog/d" \
-    < ClickHouse/CHANGELOG.md \
-    >> docs/en/whats-new/changelog/index.md
+if grep -q '^# $(date +%Y) Changelog' ClickHouse/CHANGELOG.md; then
+  sed '/^# $(date +%Y) Changelog/d' ClickHouse/CHANGELOG.md > temp.txt
+  cat >> docs/en/whats-new/changelog/index.md
+  rm temp.txt
+  echo "$(date +%Y) Changelog was updated."
+else
+  current_year="$(date +%Y)"
+  previous_year="$(($current_year - 1))"
+  echo "No Changelog found for $current_year."
+  echo -e ":::note\nThere have been no new releases yet for $current_year.  \n View changelog for the year [$previous_year](/docs/en/whats-new/changelog/$previous_year).\n:::" >> docs/en/whats-new/changelog/index.md
+fi
 
 # Delete ClickHouse repo
 echo "[$SCRIPT_NAME] Start deleting ClickHouse repo"
-rm -r ClickHouse
+rm -rf ClickHouse
 echo "[$SCRIPT_NAME] Deleting ClickHouse repo completed"
 
 echo "[$SCRIPT_NAME] Finish tasks for copying docs from ClickHouse repo"

docs/en/_placeholders/changelog/_index.md

@@ -1,8 +1,8 @@
 ---
 slug: /en/whats-new/changelog/
 sidebar_position: 2
-sidebar_label:  2024
-title: 2024 Changelog
+sidebar_label:  2025
+title: 2025 Changelog
 note: This file is autogenerated by the yarn new-build
 ---
 

docs/en/_snippets/_GCS_authentication_and_bucket.md

@@ -1,5 +1,6 @@
 
-<details><summary>Create GCS buckets and an HMAC key</summary>
+<details>
+    <summary>Create GCS buckets and an HMAC key</summary>
 
 ### ch_bucket_us_east1
 

docs/en/_snippets/_S3_authentication_and_bucket.md

@@ -1,5 +1,6 @@
 
-<details><summary>Create S3 buckets and an IAM user</summary>
+<details>
+  <summary>Create S3 buckets and an IAM user</summary>
 
 This article demonstrates the basics of how to configure an AWS IAM user, create an S3 bucket and configure ClickHouse to use the bucket as an S3 disk. You should work with your security team to determine the permissions to be used, and consider these as a starting point.
 

docs/en/_snippets/_add_remote_ip_access_list_detail.md

@@ -1,4 +1,5 @@
-<details><summary>Manage your IP Access List</summary>
+<details>
+    <summary>Manage your IP Access List</summary>
 
 From your ClickHouse Cloud services list choose the service that you will work with and switch to **Security**.  If the IP Access List does not contain the IP Address or range of the remote system that needs to connect to your ClickHouse Cloud service, then you can resolve the problem with **Add entry**: