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

Author: Ryan Sickles

.github/workflows/build-search.yml

@@ -15,24 +15,23 @@ env:
 
 jobs:
   update-search:
-    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'update search') && github.event.pull_request.base.ref == 'main'
-    #if: contains(github.event.pull_request.labels.*.name, 'update search') # Updated to trigger directly on PRs with the label
+    if: github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'update search') && github.event.pull_request.base.ref == 'main')
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20' 
 
       - name: Run Prep from Master
         run: yarn copy-clickhouse-repo-docs
 
       - name: Run Auto Generate Settings
-        run: yarn auto-generate-settings
+        run: yarn autogenerate-settings
 
       - name: Run Indexer
         run: yarn run-indexer

.github/workflows/check-build.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       # Step 1: Check out the repository
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Step 2: Set up environment if required (e.g., installing Aspell)
       - name: Install Aspell
@@ -33,7 +33,7 @@ jobs:
 
       # Step 4: Setup Python and dependencies for KB checker
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 

.github/workflows/table_of_contents.yml

@@ -23,15 +23,15 @@ jobs:
 
       # Step 1 - Check out the repository
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Step 2 - Pull changes
       - name: Pull remote Changes
         run: git pull
 
       # Step 3 - Setup python
       - name: Set up python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 

.gitignore

@@ -28,6 +28,7 @@ clickhouse-docs.code-workspace
 yarn.lock
 yarn.error-log
 .comments
+yarn-error.log
 
 # Output files used by scripts to verify links
 sidebar_links.txt
@@ -36,9 +37,7 @@ active_links.txt
 active_links.json
 
 # Files used by scripts to autogenerate settings and do spellcheck
-FormatFactorySettingsDeclaration.h
-FormatFactorySettings.h
-Settings.cpp
+scripts/settings/tmp
 
 # Files whose content gets autogenerated
 docs/en/cloud/manage/api/invitations-api-reference.md

README.md

@@ -69,28 +69,22 @@ You can run a copy of this website locally within a few steps. Some folks find t
     # ✨  Done in 6.44s.
     ```
 
-1. Use Yarn to grab the latest documentation changes from the `clickhouse/clickhouse` repository:
+1. Use Yarn to grab the latest documentation changes from the `ClickHouse/ClickHouse` repository:
 
     ```shell
-    yarn prep-from-master
+    yarn copy-clickhouse-repo-docs
 
-    # yarn run v1.22.19
-    # Cloning into '/tmp/ch_temp_14714'...
+    # Cloning into 'ClickHouse'...
     # ...
-    # Prep completed
-    # ✨  Done in 16.44s
+    # Copying docs from ClickHouse ...
+    # Successfully executed copy from master
+    # ✨  Done in 18.56s.
     ```
 
-    Alternatively, you can use a local copy of the `clickhouse/clickhouse` if you already have that repository cloned locally.
+    Alternatively, you can use a local copy of `ClickHouse/ClickHouse` if you already have that repository cloned locally with `-l`.
 
     ```shell
-    yarn prep-from-local "/Users/johnny/clickhouse/"
-
-    # yarn run v1.22.19
-    # $ bash -c 'array_root=($npm ...
-    # ...
-    # Prep completed
-    ✨  Done in 0.47s.
+    yarn copy-clickhouse-repo-docs -l "/Users/johnny/clickhouse/"
     ```
 
 1. Start the local web-server:

copyClickhouseRepoDocs.sh

@@ -4,22 +4,26 @@ sidebar_label: Usage Limits
 title: Usage Limits
 ---
 
-
-## Database Limits
-Clickhouse is very fast and reliable, but any database has its limits. For example, having too many tables or databases could negatively affect performance. To avoid that, Clickhouse Cloud has guardrails for several types of items.
+While ClickHouse is known for its speed and reliability, optimal performance is achieved within certain operating parameters. For example, having too many tables, databases or parts could negatively impact performance. To avoid this, Clickhouse Cloud has guardrails set up for several types of items. You can find details of these guardrails below.
 
 :::tip
-If you've reached one of those limits, it may mean that you are implementing your use case in an unoptimized way. You can contact our support so we can help you refine your use case to avoid going through the limits or to increase the limits in a guided way. 
+If you've run up against one of these guardrails, it's possible that you are implementing your use case in an unoptimized way. Contact our support team and we will gladly help you refine your use case to avoid exceeding the guardrails or look together at how we can increase them in a controlled manner. 
 :::
 
-# Partitions
-Clickhouse Cloud have a limit of **50000** [partitions](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/custom-partitioning-key) per instance
-
-# Parts
-Clickhouse Cloud have a limit of **100000** [parts](https://clickhouse.com/docs/en/operations/system-tables/parts) per instance
+- **Databases**: 1000
+- **Tables**: 5000-10k
+- **Columns**: ∼1000 (wide format is preferred to compact)
+- **Partitions**: 50k
+- **Parts**: 100k across the entire instance
+- **Part size**: 150gb
+- **Services**: 20 (soft)
+- **Low cardinality**: 10k or less
+- **Primary keys in a table**: 4-5 that sufficiently filter down the data
+- **Concurrency**: default 100, can be increased to 1000 per node
+- **Batch ingest**: anything > 1M will be split by the system in 1M row blocks
 
 :::note
-For Single Replica Services, the maximum number of Databases is restricted to 100, and the maximum number of Tables is restricted to 500. In addition, Storage for Basic Tier Services is limited to 1 TB.
+For Single Replica Services, the maximum number of databases is restricted to 100, and the maximum number of tables is restricted to 500. In addition, storage for Basic Tier Services is limited to 1 TB.
 :::
 
 

docs/en/cloud/bestpractices/usagelimits.md

@@ -5,12 +5,8 @@ description: Easily spin up REST API endpoints from your saved queries
 keywords: [api, query api endpoints, query endpoints, query rest api]
 ---
 
-import BetaBadge from '@theme/badges/BetaBadge';
-
 # Query API Endpoints
 
-<BetaBadge />
-
 The **Query API Endpoints** feature allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. You'll be able to access API endpoints via HTTP to execute your saved queries without needing to connect to your ClickHouse Cloud service via a native driver.
 
 ## Quick-start Guide

docs/en/cloud/get-started/query-endpoints.md

@@ -37,7 +37,7 @@ Your service will be backed up based on the set schedule, whether it is the defa
 
 ## Understanding backup cost
 
-ClickHouse Cloud includes two backups for free, but choosing a schedule that requires retaining more data, or causes more frequent backups can cause additional storage charges for backups. If you do not change the default settings, you will not incur any backup cost.
+Per the default policy, ClickHouse Cloud mandates a backup every day, with a 24 hour retention.  Choosing a schedule that requires retaining more data, or causes more frequent backups can cause additional storage charges for backups.
 
 To understand the backup cost, you can view the backup cost per service from the usage screen (as shown below). Once you have backups running for a few days with a customized schedule, you can get an idea of the cost and extrapolate to get the monthly cost for backups.
 

docs/en/cloud/manage/backups/overview.md

@@ -73,7 +73,7 @@ However, these services can be scaled vertically by contacting support.
 
 You can use ClickHouse Cloud [public APIs](https://clickhouse.com/docs/en/cloud/manage/api/swagger#/paths/~1v1~1organizations~1:organizationId~1services~1:serviceId~1scaling/patch) to scale your service by updating the scaling settings for the service or adjust the number of replicas from the cloud console.
 
-A **Scale** or **Enterprise** ClickHouse service must have a minimum of `2` replicas.
+**Scale** and **Enterprise** tiers do support single-replica services. However, a service in these tiers that starts with multiple replicas, or scales out to multiples replicas can only be scaled back in to a minimum of `2` replicas.
 
 :::note
 Services can scale horizontally to a maximum of 20 replicas. If you need additional replicas, please contact our support team.