Skip to content

Add keywords to pages #4211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions docs/_placeholders/api/_invitations-api-reference.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_placeholders/api/_keys-api-reference.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_placeholders/api/_members-api-reference.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_placeholders/api/_organizations-api-reference.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_placeholders/api/_services-api-reference.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_placeholders/changelog/_index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/about-us/about-faq-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'FAQ'
slug: /about-us/faq
description: 'Landing page'
keywords: ['ClickHouse FAQ', 'frequently asked questions', 'common questions', 'help documentation', 'troubleshooting']
---

| FAQ |
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Adopters'
title: 'ClickHouse Adopters'
sidebar_position: 60
description: 'A list of companies using ClickHouse and their success stories'
keywords: ['ClickHouse adopters', 'success stories', 'case studies', 'company testimonials', 'ClickHouse users']
---

The following list of companies using ClickHouse and their success stories is assembled from public sources, thus might differ from current reality. We'd appreciate it if you share the story of adopting ClickHouse in your company and [add it to the list](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/about-us/adopters.md), but please make sure you won't have any NDA issues by doing so. Providing updates with publications from other companies is also useful.
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Cloud Service'
sidebar_position: 10
description: 'ClickHouse Cloud'
title: 'ClickHouse Cloud'
keywords: ['ClickHouse Cloud', 'cloud database', 'managed ClickHouse', 'serverless database', 'cloud OLAP']
---

# ClickHouse Cloud
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /about
title: 'About ClickHouse'
description: 'Landing page for About ClickHouse'
keywords: ['about', 'overview', 'introduction']
---

# About ClickHouse
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /about-clickhouse
sidebar_label: 'What is ClickHouse?'
title: 'What is ClickHouse?'
description: 'Page describing what ClickHouse is'
keywords: ['what is', 'introduction']
---

import Content from '@site/docs/intro.md';
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Support'
title: 'ClickHouse Cloud support services'
sidebar_position: 30
description: 'Information on ClickHouse Cloud support services'
keywords: ['ClickHouse support', 'cloud support', 'technical support', 'support services', 'help desk']
---

# ClickHouse Cloud support services
Expand Down
1 change: 1 addition & 0 deletions docs/architecture/cluster-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Cluster deployment'
sidebar_position: 100
title: 'Cluster deployment'
description: 'By going through this tutorial, you will learn how to set up a simple ClickHouse cluster.'
keywords: [clickhouse cluster, cluster deployment, distributed tables, sharding, replication, zookeeper, mergetree, cluster configuration]
---

This tutorial assumes you've already set up a [local ClickHouse server](../getting-started/install/install.mdx)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Sizing and hardware recommendations'
sidebar_position: 4
title: 'Sizing and hardware recommendations'
description: 'This guide discusses our general recommendations regarding hardware, compute, memory, and disk configurations for open-source users.'
keywords: [clickhouse hardware, sizing recommendations, cpu memory disk, performance optimization, cluster sizing, resource planning]
---

# Sizing and hardware recommendations
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/bestpractices/multitenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/bestpractices/multi-tenancy
sidebar_label: 'Implement multi tenancy'
title: 'Multi tenancy'
description: 'Best practices to implement multi tenancy'
keywords: ['ClickHouse Cloud', 'multi-tenancy', 'SaaS architecture', 'tenant isolation', 'data segregation']
---

On a SaaS data analytics platform, it is common for multiple tenants, such as organizations, customers, or business units, to share the same database infrastructure while maintaining logical separation of their data. This allows different users to securely access their own data within the same platform.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/bestpractices/usagelimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/bestpractices/usage-limits
sidebar_label: 'Usage Limits'
title: 'Usage limits'
description: 'Describes the recommended usage limits in ClickHouse Cloud'
keywords: ['ClickHouse Cloud', 'usage limits', 'performance guardrails', 'service limits', 'cloud constraints']
---

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.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/account-close.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Delete Account'
slug: /cloud/manage/close_account
title: 'Account Close & Deletion'
description: 'We know there are circumstances that sometimes necessitate account closure. This guide will help you through the process.'
keywords: ['ClickHouse Cloud', 'account closure', 'delete account', 'cloud account management', 'account deletion']
---

## Account closure and deletion {#account-close--deletion}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/api/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_position: 1
title: 'ClickHouse Cloud API'
slug: /cloud/manage/api/api-overview
description: 'Learn about ClickHouse Cloud API'
keywords: ['ClickHouse Cloud', 'API overview', 'cloud API', 'REST API', 'programmatic access']
---

# ClickHouse Cloud API
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Cloud API'
slug: /cloud/manage/cloud-api
description: 'Landing page for the Cloud API section'
keywords: ['ClickHouse Cloud', 'cloud API', 'API documentation', 'REST API reference', 'cloud management API']
---

This section contains reference documentation for Cloud API and contains the following pages:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Export Backups to your Own Cloud Account'
slug: /cloud/manage/backups/export-backups-to-own-cloud-account
title: 'Export Backups to your Own Cloud Account'
description: 'Describes how to export backups to your own Cloud account'
keywords: ['ClickHouse Cloud', 'backup export', 'cloud backup', 'backup migration', 'cross-cloud backup']
---

import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge'
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Overview'
slug: /cloud/manage/billing/overview
title: 'Pricing'
description: 'Overview page for ClickHouse Cloud pricing'
keywords: ['ClickHouse Cloud', 'pricing', 'billing', 'cloud costs', 'compute pricing']
---

import ClickPipesFAQ from './jan2025_faq/_snippets/_clickpipes_faq.md'
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/cloud-tiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'ClickHouse Cloud Tiers'
slug: /cloud/manage/cloud-tiers
title: 'ClickHouse Cloud Tiers'
description: 'Cloud tiers available in ClickHouse Cloud'
keywords: ['ClickHouse Cloud', 'cloud tiers', 'service plans', 'cloud pricing tiers', 'cloud service levels']
---

# ClickHouse Cloud tiers
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Dashboards'
slug: /cloud/manage/dashboards
title: 'Dashboards'
description: 'The SQL Console''s dashboards feature allows you to collect and share visualizations from saved queries.'
keywords: ['ClickHouse Cloud', 'dashboards', 'data visualization', 'SQL console dashboards', 'cloud analytics']
---

import BetaBadge from '@theme/badges/BetaBadge';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Integrations'
slug: /manage/integrations
title: 'Integrations'
description: 'Integrations for ClickHouse'
keywords: ['ClickHouse Cloud', 'integrations', 'cloud connectors', 'data integration', 'third-party integrations']
---

To see a full list of integrations for ClickHouse, please see [this page](/integrations).
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/network-data-transfer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Data Transfer'
slug: /cloud/manage/network-data-transfer
title: 'Data Transfer'
description: 'Learn more about how ClickHouse Cloud meters data transferred ingress and egress'
keywords: ['ClickHouse Cloud', 'data transfer', 'network egress', 'cloud data costs', 'bandwidth pricing']
---

import NetworkPricing from '@site/docs/cloud/manage/_snippets/_network_transfer_rates.md';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Managing API Keys'
slug: /cloud/manage/openapi
title: 'Managing API Keys'
description: 'ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.'
keywords: ['ClickHouse Cloud', 'API keys', 'OpenAPI', 'cloud API management', 'programmatic access']
---

import image_01 from '@site/static/images/cloud/manage/openapi1.png';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/postman.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/manage/postman
sidebar_label: 'Programmatic API access with Postman'
title: 'Programmatic API access with Postman'
description: 'This guide will help you test the ClickHouse Cloud API using Postman'
keywords: ['ClickHouse Cloud', 'Postman', 'API testing', 'cloud API', 'REST API']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/service-uptime.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Service Uptime and SLA'
slug: /cloud/manage/service-uptime
title: 'Service Uptime'
description: 'Users can now see regional uptimes on the status page and subscribe to alerts on service disruptions.'
keywords: ['ClickHouse Cloud', 'service uptime', 'SLA', 'cloud reliability', 'status monitoring']
---

## Uptime alerts {#uptime-alerts}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Configuring Settings'
slug: /manage/settings
title: 'Configuring Settings'
description: 'How to configure settings for your ClickHouse Cloud service for a specific user or role'
keywords: ['ClickHouse Cloud', 'settings configuration', 'cloud settings', 'user settings', 'role settings']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Upgrades'
slug: /manage/updates
title: 'Upgrades'
description: 'With ClickHouse Cloud you never have to worry about patching and upgrades. We roll out upgrades that include fixes, new features and performance improvements on a periodic basis.'
keywords: ['ClickHouse Cloud', 'upgrades', 'cloud updates', 'automatic updates', 'service maintenance']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/migrate/upload-a-csv-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Uploading files'
slug: /cloud/migrate/upload-a-csv-file
description: 'Learn how to upload files to Cloud'
keywords: ['ClickHouse Cloud', 'file upload', 'CSV upload', 'data migration', 'cloud data import']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Architecture'
slug: /cloud/reference/architecture
title: 'ClickHouse Cloud Architecture'
description: 'This page describes the architecture of ClickHouse Cloud'
keywords: ['ClickHouse Cloud', 'cloud architecture', 'system architecture', 'cloud infrastructure', 'scalable architecture']
---

import Architecture from '@site/static/images/cloud/reference/architecture.svg';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /whats-new/cloud
sidebar_label: 'Cloud Changelog'
title: 'Cloud Changelog'
description: 'ClickHouse Cloud changelog providing descriptions of what is new in each ClickHouse Cloud release'
keywords: ['ClickHouse Cloud', 'changelog', 'cloud releases', 'what\'s new', 'cloud updates']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/changelogs-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/reference/changelogs
title: 'Changelogs'
description: 'Landing page for Cloud changelogs'
keywords: [clickhouse cloud changelog, cloud release notes, cloud updates, version history]
---

| Page | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/cloud-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /whats-new/cloud-compatibility
sidebar_label: 'Cloud Compatibility'
title: 'Cloud Compatibility'
description: 'This guide provides an overview of what to expect functionally and operationally in ClickHouse Cloud.'
keywords: [clickhouse cloud compatibility, cloud architecture, compute storage separation, auto scaling, hibernation]
---

# ClickHouse Cloud compatibility guide
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/release-notes-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/reference/changelogs/release-notes
title: 'Cloud Release Notes'
description: 'Landing page for Cloud release notes'
keywords: [clickhouse cloud release notes, cloud releases, version updates, release history]
---

<!-- The table of contents below is generated automatically from YAML front matter
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/accessing-s3-data-securely.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/security/secure-s3
sidebar_label: 'Accessing S3 Data Securely'
title: 'Accessing S3 Data Securely'
description: 'This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely.'
keywords: [clickhouse cloud s3, s3 security, role based access, aws s3 authentication, secure data access]
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Audit Logging'
slug: /cloud/security/audit-logging
title: 'Audit Logging'
description: 'This page describes Audit Logging in ClickHouse Cloud. It explains how to access and interpret the audit logs, which record changes made to a ClickHouse Cloud organization.'
keywords: [clickhouse cloud audit logging, audit logs, activity tracking, security monitoring, organization changes]
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/aws-privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'AWS PrivateLink'
description: 'This document describes how to connect to ClickHouse Cloud using AWS PrivateLink.'
slug: /manage/security/aws-privatelink
keywords: [aws privatelink, clickhouse cloud security, private connectivity, vpc endpoint, secure connection]
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Overview'
slug: /cloud/security/cloud-access-management/overview
title: 'Cloud access management'
description: 'Describes how access control in ClickHouse cloud works, including information on role types'
keywords: [ClickHouse Cloud, access control, user management, roles, permissions, console users, database users, SQL console, authentication, security, RBAC, grants, default role, organization admin, service admin]
---

import Image from '@theme/IdealImage';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Cloud Authentication'
slug: /cloud/security/cloud-authentication
title: 'Cloud Authentication'
description: 'This guide explains some good practices for configuring your authentication.'
keywords: [ClickHouse Cloud, authentication, password security, MFA, multi-factor authentication, SSO, single sign-on, Google authentication, Microsoft authentication, SAML, account recovery, NIST compliance, SHA256 hash]
---

import ScalePlanFeatureBadge from '@theme/badges/ScalePlanFeatureBadge'
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/cloud-access-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/security/cloud-access-management
title: 'Cloud access management'
description: 'Cloud Access Management Table Of Contents'
keywords: [ClickHouse Cloud, access management, authentication, SAML SSO, user management, roles, security, permissions, SQL users, organization management]
---

| Page | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/cloud-endpoints-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /manage/security/cloud-endpoints-api
sidebar_label: 'Cloud IP Addresses'
title: 'Cloud IP Addresses'
description: 'This page documents the Cloud Endpoints API security features within ClickHouse. It details how to secure your ClickHouse deployments by managing access through authentication and authorization mechanisms.'
keywords: [ClickHouse Cloud, static IP addresses, cloud endpoints, API, security, egress IPs, ingress IPs, firewall, AWS, GCP, Azure, MySQL integration, PostgreSQL integration, network security]
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/cmek.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Enhanced Encryption'
slug: /cloud/security/cmek
title: 'Customer Managed Encryption Keys (CMEK)'
description: 'Learn more about customer managed encryption keys'
keywords: [ClickHouse Cloud, CMEK, customer managed encryption keys, TDE, transparent data encryption, AWS KMS, GCP KMS, encryption at rest, key rotation, data security, AES 256, enterprise security]
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/common-access-management-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Common Access Management Queries'
title: 'Common Access Management Queries'
slug: /cloud/security/common-access-management-queries
description: 'This article shows the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns.'
keywords: [ClickHouse Cloud, SQL users, roles, permissions, GRANT, REVOKE, database security, access control, default user, admin user, passwordless authentication, granular access control, SQL console]
---

import CommonUserRolesContent from '@site/docs/_snippets/_users-and-roles-common.md';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/compliance-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Security and Compliance'
slug: /cloud/security/security-and-compliance
title: 'Security and Compliance'
description: 'This page describes the security and compliance measures implemented by ClickHouse Cloud to protect customer data.'
keywords: [ClickHouse Cloud, compliance, security, SOC 2, ISO 27001, HIPAA, PCI DSS, GDPR, CCPA, trust center, data privacy framework, privacy policy, business associate agreement, audit reports]
---

import BetaBadge from '@theme/badges/BetaBadge';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/connectivity-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/security/connectivity
title: 'connectivity overview'
description: 'Landing page for Connectivity'
keywords: [ClickHouse Cloud, connectivity, network security, IP filters, private networking, private link, S3 security, cloud endpoints, secure connections]
---

# Connectivity
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/gcp-private-service-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'GCP Private Service Connect'
description: 'This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists.'
sidebar_label: 'GCP Private Service Connect'
slug: /manage/security/gcp-private-service-connect
keywords: [ClickHouse Cloud, GCP, Google Cloud Platform, Private Service Connect, PSC, private networking, VPC, network security, service attachment, DNS, endpoint, global access, terraform, private link]
---

import Image from '@theme/IdealImage';
Expand Down
Loading