[docs] Review the Clickhouse app docs - #1059

packages/apps/clickhouse/values.yaml (4)

3-6: Unify product casing: “ClickHouse” vs “Clickhouse”
The inline docs for shards and replicas use “Clickhouse,” but the official name is ClickHouse. Please update both descriptions to ClickHouse.

---

32-39: Recommend secure handling of backup credentials
Storing S3 access/secret keys and the Restic password directly in values.yaml poses a security risk. Advise users to inject these sensitive values via Kubernetes Secrets or Helm Secret plugins instead of embedding them in plain text.

---

50-52: Unify product casing: “ClickHouse”
The description for resources refers to “the Clickhouse service.” Please change it to ClickHouse for consistency.

---

60-62: Consider listing allowed resourcesPreset values
For clarity, you could enumerate the supported presets (none, nano, micro, small, medium, large, xlarge, 2xlarge) in the doc comment for resourcesPreset.

packages/apps/clickhouse/values.schema.json (3)

15-23: Unify product casing: “ClickHouse” vs “Clickhouse”
The JSON schema descriptions for both shards and replicas refer to Clickhouse. Update them to ClickHouse to match official naming.

---

82-84: Unify product casing: “ClickHouse”
The description for resources currently reads “Clickhouse service.” Please update it to ClickHouse for consistency.

---

85-89: Enforce valid resourcesPreset values via JSON Schema
To validate the resourcesPreset field, consider adding an enum with the allowed values:

"resourcesPreset": {
  "type": "string",
  "description": "Use a common resources preset when `resources` is not set explicitly.",
  "enum": ["none","nano","micro","small","medium","large","xlarge","2xlarge"],
  "default": "nano"
}

packages/apps/clickhouse/README.md (5)

3-6: Improve grammar and article usage in introduction

• Hyphenate “open-source” and add commas for readability.
• Include “the” before “Cozystack platform” and capitalize “Operator.”
  Example:

- ClickHouse is an open source high-performance and column-oriented SQL database management system (DBMS).
+ ClickHouse is an open-source, high-performance, column-oriented SQL database management system (DBMS).
- Cozystack platform uses Altinity operator to provide ClickHouse.
+ The Cozystack platform uses the Altinity Operator to provide ClickHouse.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~4-~4: You might be missing the article “the” here.
Context: ...or online analytical processing (OLAP). Cozystack platform uses Altinity operator to prov...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

7-7: Fix heading level and remove trailing colon
Change ### How to restore backup: to:

## How to restore backup

This restores proper heading hierarchy and removes the unnecessary colon.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

---

7-7: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

10-12: Specify language for fenced code blocks
Add a language identifier (e.g., bash) to both Restic command blocks:

- ```
+ ```bash

Also applies to: 15-17

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

10-10: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

25-32: Unify product casing in parameter table
In the “Common parameters” table, update all instances of Clickhouse to ClickHouse, especially for shards and replicas.

---

52-53: Separate resource parameters into their own table
The resources and resourcesPreset rows are currently under "Backup parameters." For clarity, move them into a dedicated "Resource parameters" section/table.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro