Skip to content

Commit 151d6ee

Browse files
BlargianBlargian
authored
Merge pull request #3482 from Blargian/validate_frontmatter
Frontmatter validation
2 parents cca3b6e + bcda027 commit 151d6ee

File tree

419 files changed

+2061
-1057
lines changed

Some content is hidden

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

419 files changed

+2061
-1057
lines changed

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ yarn.lock
2929
yarn.error-log
3030
.comments
3131
yarn-error.log
32+
frontmatter-validation-errors.log
3233

3334
# Output files used by scripts to verify links
3435
sidebar_links.txt
@@ -57,5 +58,7 @@ docs/whats-new/changelog/index.md
5758
**.translate
5859
ClickHouse/
5960

60-
# Ignore generated table of contents files
61+
62+
# Ignore table of contents files
6163
docs/cloud/reference/release-notes-index.md
64+
docs/whats-new/changelog/index.md

‎clickhouseapi.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ function groupEndpointsByPrefix(spec) {
4040
}
4141

4242
function generateDocusaurusMarkdown(spec, groupedEndpoints, prefix) {
43-
let markdownContent = `---\nsidebar_label: ${prefix.charAt(0).toUpperCase() + prefix.slice(1)}\n`;
44-
markdownContent += `title: ${prefix.charAt(0).toUpperCase() + prefix.slice(1)}\n---\n`;
43+
let markdownContent = `---\nsidebar_label: '${prefix.charAt(0).toUpperCase() + prefix.slice(1)}'\n`;
44+
markdownContent += `title: '${prefix.charAt(0).toUpperCase() + prefix.slice(1)}'\n`;
45+
markdownContent += `slug: /cloud/manage/api/${prefix}-api-reference\n`;
46+
markdownContent += `description: 'Cloud API reference documentation for ${prefix}'\n---\n`;
4547

4648
for (const path in groupedEndpoints) {
4749
for (const method in groupedEndpoints[path]) {

‎contribute/contrib-writing-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,7 @@ slug: /integrations/sql-clients/clickhouse-client-local
265265
sidebar_label: clickhouse-client
266266
title: clickhouse-client and clickhouse-local
267267
---
268+
268269
import Tabs from '@theme/Tabs';
269270
import TabItem from '@theme/TabItem';
270271

‎docs/_placeholders/changelog/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2+
description: 'Changelog for 2025'
3+
note: 'This file is autogenerated by the yarn new-build'
24
slug: /whats-new/changelog/
35
sidebar_position: 2
4-
sidebar_label: 2025
5-
title: 2025 Changelog
6-
note: This file is autogenerated by the yarn new-build
6+
sidebar_label: '2025'
7+
title: '2025 Changelog'
78
---
89

‎docs/about-us/about-faq-index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: FAQ
2+
title: 'FAQ'
33
slug: /about-us/faq
4-
description: Landing page
4+
description: 'Landing page'
55
---
66

77
| FAQ |

‎docs/about-us/adopters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
slug: /about-us/adopters
3-
sidebar_label: Adopters
4-
title: ClickHouse Adopters
3+
sidebar_label: 'Adopters'
4+
title: 'ClickHouse Adopters'
55
sidebar_position: 60
6-
description: A list of companies using ClickHouse and their success stories
6+
description: 'A list of companies using ClickHouse and their success stories'
77
---
88

99
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.

‎docs/about-us/cloud.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
slug: /about-us/cloud
3-
sidebar_label: Cloud Service
3+
sidebar_label: 'Cloud Service'
44
sidebar_position: 10
5-
description: ClickHouse Cloud
6-
title: ClickHouse Cloud
5+
description: 'ClickHouse Cloud'
6+
title: 'ClickHouse Cloud'
77
---
88

99
# ClickHouse Cloud

‎docs/about-us/distinctive-features.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
slug: /about-us/distinctive-features
3-
sidebar_label: Why is ClickHouse unique?
3+
sidebar_label: 'Why is ClickHouse unique?'
44
sidebar_position: 50
5-
description: Understand what makes ClickHouse stand apart from other database management systems
6-
title: Distinctive Features of ClickHouse
5+
description: 'Understand what makes ClickHouse stand apart from other database management systems'
6+
title: 'Distinctive Features of ClickHouse'
77
---
88

99
# Distinctive Features of ClickHouse

‎docs/about-us/history.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
slug: /about-us/history
3-
sidebar_label: ClickHouse History
3+
sidebar_label: 'ClickHouse History'
44
sidebar_position: 40
5-
description: History of ClickHouse development
6-
tags: ['history', 'development', 'Metrica']
7-
title: ClickHouse History
5+
description: 'History of ClickHouse development'
6+
keywords: ['history','development','Metrica']
7+
title: 'ClickHouse History'
88
---
99

1010
# ClickHouse History {#clickhouse-history}

‎docs/about-us/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
slug: /about
3-
title: "About ClickHouse"
4-
description: "Landing page for About ClickHouse"
3+
title: 'About ClickHouse'
4+
description: 'Landing page for About ClickHouse'
55
---
66

77
# About ClickHouse

0 commit comments

Comments
 (0)