Skip to content

Commit b090fd8

Browse files
Blargianclaude
Blargian
and
claude
authored
docs: add Mintlify frontmatter to docs pages (#192)
docs: add Mintlify frontmatter to docs pages Restores YAML frontmatter (slug, title, keywords, description, doc_type, position/sidebarTitle) on docs pages so the Mintlify sync workflow preserves it instead of repeatedly trying to remove it on each sync. Also updates the autogen API reference template (gv_list.tpl) to emit the same frontmatter shape, so regenerated api-reference.mdx stays consistent. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 14b8f47 commit b090fd8

8 files changed

Lines changed: 61 additions & 2 deletions

File tree

‎docs/guides/configuration.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
position: 2
3+
slug: /clickhouse-operator/guides/configuration
4+
title: 'Configuration'
5+
keywords: ['kubernetes']
6+
description: 'This guide covers how to configure ClickHouse and Keeper clusters using the ClickHouse operator.'
7+
doc_type: 'guide'
8+
---
9+
110
# ClickHouse Operator configuration guide
211

312
This guide covers how to configure ClickHouse and Keeper clusters using the operator.

‎docs/guides/introduction.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
position: 1
3+
slug: /clickhouse-operator/guides/introduction
4+
title: 'Introduction'
5+
keywords: ['kubernetes']
6+
description: 'This document provides an overview of key concepts and usage patterns for the ClickHouse Operator.'
7+
doc_type: 'guide'
8+
---
9+
110
# Introduction to the ClickHouse Operator
211

312
This document provides an overview of key concepts and usage patterns for the ClickHouse Operator.

‎docs/install/helm.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
slug: /clickhouse-operator/install/helm
3+
title: 'Install the ClickHouse Operator with Helm'
4+
keywords: ['kubernetes']
5+
description: 'This guide covers installing the ClickHouse Operator using Helm charts.'
6+
doc_type: 'guide'
7+
sidebarTitle: 'Helm'
8+
---
9+
110
This guide covers installing the ClickHouse Operator using Helm charts.
211

312
## Prerequisites {#prerequisites}

‎docs/install/kubectl.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
slug: /clickhouse-operator/install/kubectl
3+
title: 'Install the ClickHouse Operator with kubectl'
4+
keywords: ['kubernetes']
5+
description: 'This guide covers installing the ClickHouse Operator using kubectl and manifest files.'
6+
doc_type: 'guide'
7+
sidebarTitle: 'kubectl'
8+
---
9+
110
This guide covers installing the ClickHouse Operator using kubectl and manifest files.
211

312
## Prerequisites {#prerequisites}

‎docs/install/olm.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
slug: /clickhouse-operator/install/olm
3+
title: 'Install the ClickHouse Operator with Operator Lifecycle Manager (OLM)'
4+
keywords: ['kubernetes']
5+
description: 'This guide covers installing the ClickHouse Operator using kubectl and manifest files.'
6+
doc_type: 'guide'
7+
sidebarTitle: 'OLM'
8+
---
9+
110
This guide covers installing the ClickHouse Operator using Operator Lifecycle Manager (OLM).
211

312
## Prerequisites {#prerequisites}

‎docs/overview.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
position: 1
3+
slug: /clickhouse-operator/overview
4+
title: 'ClickHouse Operator'
5+
keywords: ['kubernetes']
6+
description: 'Overview page for the ClickHouse Operator - a Kubernetes operator that automates the deployment, configuration, and management of ClickHouse clusters and ClickHouse Keeper clusters on Kubernetes.'
7+
doc_type: 'guide'
8+
sidebarTitle: 'Overview'
9+
---
10+
111
The ClickHouse Operator is a Kubernetes operator that automates the deployment, configuration, and management of ClickHouse clusters and ClickHouse Keeper clusters on Kubernetes.
212
It provides declarative cluster management through custom resources, enabling users to easily create highly-available ClickHouse deployments.
313

‎docs/reference/api-reference.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2+
position: 1
23
slug: /clickhouse-operator/reference/api-reference
34
title: 'ClickHouse Operator API reference'
4-
keywords: ['kubernetes', 'operator', 'API reference']
5+
keywords: ['kubernetes']
56
description: 'This document provides detailed API reference for the ClickHouse Operator custom resources.'
7+
doc_type: 'reference'
68
sidebarTitle: 'API reference'
79
---
810

‎docs/templates/gv_list.tpl‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
{{- define "gvList" -}}
22
{{- $groupVersions := . -}}
33
---
4+
position: 1
45
slug: /clickhouse-operator/reference/api-reference
56
title: 'ClickHouse Operator API reference'
6-
keywords: ['kubernetes', 'operator', 'API reference']
7+
keywords: ['kubernetes']
78
description: 'This document provides detailed API reference for the ClickHouse Operator custom resources.'
9+
doc_type: 'reference'
810
sidebarTitle: 'API reference'
911
---
1012

0 commit comments

Comments
 (0)