[apps] Give examples of new resources in managed app README's - #1120

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

46-54: Same improvement repeated – nothing to add

Changes mirror the API-server section and stay consistent.

---

71-79: Consistent copy-editing

Scheduler block follows the new convention; looks good.

---

99-107: Konnectivity wording aligns with others

No functional impact, keeps docs uniform.

packages/apps/kubernetes/values.yaml (2)

123-133: Controller-manager & scheduler blocks consistent

The repetition across components is deliberate; wording is uniform.

---

135-140: Konnectivity comments sync’d

No issues spotted.

packages/apps/redis/values.yaml (1)

15-22: Remove trailing whitespace to satisfy YAML-lint

yamllint flags a trailing space in the example block (current line 20). It’s harmless at runtime but fails CI in stricter pipelines.

- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/redis/README.md (1)

34-35: Avoid repeating the allowed-values sentence

Lines 24 and 34 state the same “Allowed values …” information; the duplication can be dropped to keep the README concise.

-Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.
-This value is ignored if the corresponding `resources` value is set.
+This value is ignored if the corresponding `resources` value is set.

packages/apps/rabbitmq/values.yaml (1)

48-48: Remove trailing whitespace to satisfy YAML-lint

Line 48 ends with an extra space that trips the lint check.

- 
+

packages/apps/http-cache/values.yaml (1)

25-32: Minor naming consistency nitpick.

In the surrounding comments we mix “nginx” (lower-case) and “Nginx” (capitalised). Consider consistently capitalising the product name in comments for readability.

-## @param nginx.resources Explicit CPU and memory configuration for each nginx replica. ...
+## @param nginx.resources Explicit CPU and memory configuration for each Nginx replica. ...

packages/apps/http-cache/values.schema.json (1)

58-66: Capitalisation nitpick mirrored in schema.

For consistency with the public product name, consider “Nginx” instead of “nginx” inside the description string.

-"description": "Explicit CPU and memory configuration for each nginx replica. When left empty, the preset defined in `resourcesPreset` is applied.",
+"description": "Explicit CPU and memory configuration for each Nginx replica. When left empty, the preset defined in `resourcesPreset` is applied.",

packages/apps/http-cache/README.md (1)

16-16: Fix remaining “HAproxy” capitalisation.

One occurrence still uses the old casing.

-HAproxy plays a vital role in this setup by directing incoming traffic...
+HAProxy plays a vital role in this setup by directing incoming traffic...

packages/apps/tcp-balancer/values.yaml (1)

47-53: Example block doesn’t follow standard K8s “requests/limits” structure

The provided example shows flat cpu / memory keys, whereas most Helm users expect the canonical structure with requests and limits. If the chart really consumes a flat map that’s fine, but the example can mis-lead newcomers who copy-paste it into other charts.

-# resources:
-#   cpu: 4000m
-#   memory: 4Gi
+# resources:
+#   requests:
+#     cpu: 500m
+#     memory: 1Gi
+#   limits:
+#     cpu: 4000m
+#     memory: 4Gi

Consider switching to, or at least documenting, the standard layout to avoid surprise.

packages/apps/tcp-balancer/README.md (1)

28-28: Minor grammar / double-space nit

“Secure HTTP by enabling client networks whitelisting” has a double space and reads a bit awkwardly.

-| `whitelistHTTP`                  | Secure HTTP by enabling  client networks whitelisting                                                                                     | `false` |
+| `whitelistHTTP`                  | Secure HTTP by enabling client network whitelisting                                                                                       | `false` |

packages/apps/kafka/values.schema.json (2)

30-31: Specify expected keys & units in the resources object

The description tells users when the field is applied but not how to fill it in. It would be useful to mention that the object normally exposes cpu and memory keys (matching standard K8s notation) and that values must follow Kubernetes quantity formats (4000m, 4Gi, etc.).

---

70-76: Inconsistent capitalisation of “ZooKeeper”

Line 70 uses “Zookeeper” (lower-case k) while earlier descriptions in the same file use “ZooKeeper”. Please pick one spelling and use it consistently across the chart (schema, values.yaml, README).

packages/apps/kafka/values.yaml (2)

17-23: YAML example is misleading – needs nesting under kafka:

The sample shows a top-level resources: block, but the actual configuration key is kafka.resources. Consider adding a short example such as:

kafka:
  resources:
    cpu: 4000m
    memory: 4Gi

to avoid copy-paste mistakes.

---

29-35: Consistent naming: “ZooKeeper” vs “Zookeeper”

Same capitalisation mismatch as in the JSON schema – please harmonise the spelling in comments to match the chosen style.

packages/apps/kafka/README.md (2)

21-27: Typo & wrong nesting in example block

1. karka.resources → kafka.resources
2. The YAML snippet should be nested the same way users configure it in values.yaml.

-Example of `karka.resources` and `zookeeper.resources`:
+Example of `kafka.resources` and `zookeeper.resources`:
 
 ```yaml
-kafka:
-  resources:
-    cpu: 4000m
-    memory: 4Gi
+kafka:
+  resources:
+    cpu: 4000m
+    memory: 4Gi
 zookeeper:
   resources:
     cpu: 2000m
     memory: 2Gi

---

7-20: Minor consistency issues in parameter table

The table mixes “ZooKeeper”/“Zookeeper” and uses different capitalisation for Kafka/Zookeeper descriptions compared with the rest of the docs. A quick pass to unify capitalisation will make the docs look more polished.

packages/apps/vpn/values.schema.json (1)

11-13: Use integer instead of number for replica count

Replica counts cannot be fractional. Declaring the type as integer communicates this constraint to tooling and prevents invalid (e.g., 1.5) values from passing validation.

-        "type": "number",
+        "type": "integer",

packages/apps/vpn/README.md (4)

3-4: Tighten wording in the intro paragraph

A couple of articles are missing.

-Managed VPN Service simplifies the deployment and management of VPN server, enabling you to establish secure connections with ease.
+Managed VPN Service simplifies the deployment and management of a VPN server, enabling you to establish secure connections with ease.

---

10-13: Fix dangling modifier in Shadowbox sentence

The current wording starts with a modifier that lacks a subject.

-Internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers.
+It is internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers.

---

33-35: Consistency: missing comma in externalIPs description

Mirror the schema/values.yaml fix here.

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of external IPs for the service. Optional. If not specified, a LoadBalancer service will be used by default.                     | `[]`   |

---

63-64: Consider removing duplicate sentence

Line 63 enumerates allowed presets; line 64 repeats the same idea. One sentence is enough.

packages/apps/vpn/values.yaml (1)

22-22: Comma & article in externalIPs comment

Align wording with schema/README.

-## @param externalIPs [array] List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.
+## @param externalIPs [array] List of external IPs for the service. Optional. If not specified, a LoadBalancer service will be used by default.

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

87-88: Avoid future drift by removing the hard-coded enum list from the description
The allowed values are already enforced by the enum block (lines 89-97). Re-listing them in prose invites divergence the next time the enum is touched.

-"description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.",
+"description": "Default sizing preset used when `resources` is omitted.",

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

56-58: Same duplication concern as in the schema
Consider trimming the exhaustive value list from the comment to avoid maintenance overhead should presets evolve.

-## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.
+## @param resourcesPreset Default sizing preset used when `resources` is omitted.

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

6-19: Minor wording tweak for readability

-### How to restore backup from S3
+### How to restore a backup from S3

The missing article was flagged by LanguageTool and reads more naturally with “a”.

packages/apps/ferretdb/values.yaml (2)

52-57: Clarify units in the commented-out resources example

Kubernetes expects CPU values like 4000m and memory values with units such as 4Gi. Consider adding the units to the sample so copy-paste users don’t accidentally omit them.

 # resources:
-#   cpu: 4000m
-#   memory: 4Gi
+#   cpu: "4000m"   # milli-cores
+#   memory: "4Gi"  # gigabytes

---

5-6: Spell out the entity for which the replicas are counted

The new wording is shorter but may leave users wondering whether it counts FerretDB pods or backing Postgres instances. A tiny clarification avoids ambiguity:

-## @param replicas Number of replicas
+## @param replicas Number of FerretDB replicas (pods)

packages/apps/ferretdb/values.schema.json (2)

15-19: Use integer instead of number for fields that cannot be fractional

replicas cannot be a floating-point value; marking it as integer tightens validation and improves UX in IDEs.

-            "type": "number",
+            "type": "integer",

Apply the same change to minSyncReplicas and maxSyncReplicas below for consistency.

---

85-89: Optional: constrain resources with a schema

Right now resources is an unconstrained object. If the chart expects exactly cpu and memory keys, adding a minimal schema prevents typos:

"resources": {
  "type": "object",
  "properties": {
    "cpu": { "type": "string" },
    "memory": { "type": "string" }
  },
  "additionalProperties": false,
  "description": "Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied.",
  "default": {}
}

packages/apps/ferretdb/README.md (1)

3-6: Minor language polish

1. “open source” → “open-source” when used as a compound adjective
2. Missing “the” before FerretDB service.

-FerretDB is an open source MongoDB alternative.
-It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
-Internally, FerretDB service is backed by Postgres.
+FerretDB is an open-source MongoDB alternative.
+It translates MongoDB wire-protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
+Internally, the FerretDB service is backed by Postgres.

packages/apps/postgres/values.schema.json (1)

127-138: Enum description repeats the allowed values – consider DRY

Since the enum already enumerates the allowed strings, you could shorten the sentence to avoid duplication and future drift:

-"description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.",
+"description": "Default sizing preset used when `resources` is omitted.",

packages/apps/postgres/values.yaml (1)

96-98: Good clarification, but watch wording consistency

Everywhere else you start the sentence with an uppercase character (“Default”), but the second sentence starts with lower-case “Allowed”. Minor, but easy to harmonise.

packages/apps/postgres/README.md (3)

3-5: Tone is a bit marketing-heavy

Phrases like “leading choice”, “highly acclaimed” read as promotional copy and may feel out of place in technical docs.
Consider tightening to a neutral, matter-of-fact tone.

---

108-115: Table update is accurate but reorder for grouping

resources & resourcesPreset logically belong under “Common parameters” with size/replicas, not under Bootstrap. Consider moving the rows to avoid reader confusion.

---

116-124: Explicit example helps – maybe add units hint

Many users forget that CPU is in millicores and memory must include a unit suffix (Mi, Gi). A short note could save troubleshooting time.

-  cpu: 4000m
-  memory: 4Gi
+  cpu: 4000m   # 4 vCPU
+  memory: 4Gi  # 4 GiB RAM

packages/apps/nats/values.yaml (1)

68-70: Remove trailing whitespace to satisfy YAML-lint

Line 70 contains two trailing spaces that break the linter.

- #   memory: 4Gi␠␠
+ #   memory: 4Gi

packages/apps/nats/README.md (1)

3-5: Use a hyphen in “high-performance”

Compound adjectives preceding a noun should be hyphenated.

-NATS is an open-source, simple, secure, and high performance messaging system.
+NATS is an open-source, simple, secure, and high-performance messaging system.

packages/apps/mysql/values.yaml (1)

58-65: Remove trailing whitespace to satisfy YAML-lint

YAML-lint flags a trailing space on line 63. Cleaning this up will keep CI green and avoid noisy diffs later.

- #   memory: 4Gi␠
+ #   memory: 4Gi

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

packages/apps/postgres/values.yaml (1)

90-95: Trailing spaces still breaking yamllint

Line 95 contains whitespace that keeps failing CI, exactly as flagged in the previous review. Please strip it (and any other trailing spaces) so the linter passes.

- #   memory: 4Gi␠␠
+#   memory: 4Gi
-

packages/apps/mysql/README.md (1)

99-107: YAML example still malformed – list items need deeper indentation
Previous feedback remains unresolved. - user1 and - user2 must be children of their parent keys, otherwise the snippet cannot be parsed.

   roles:
-      admin:
-      - user1
-      readonly:
-      - user2
+      admin:
+        - user1
+      readonly:
+        - user2

packages/apps/nats/README.md (1)

12-14: replicas description is still wrong – it denotes pod count, not volume size

This exact issue was flagged in the previous review but the wording remains unchanged. Please update to avoid misleading users.

-| `replicas`          | Persistent Volume size for NATS                                                                                                   | `2`     |
+| `replicas`          | Number of NATS pod replicas                                                                                                        | `2`     |

packages/apps/redis/values.yaml (1)

15-20: Strip trailing whitespace to satisfy YAMLlint

Line 20 is flagged by YAMLlint for trailing spaces. Removing them keeps the file lint-clean and avoids noisy CI warnings.

- #   memory: 4Gi␠␠
+ #   memory: 4Gi

packages/apps/rabbitmq/values.yaml (1)

43-48: Remove the trailing whitespace on the empty line to keep YAMLlint happy

YAMLlint is flagging line 48 for trailing spaces – the sole lint issue in this file.
Deleting the stray spaces avoids unnecessary CI noise.

- 
+

packages/apps/vpn/README.md (3)

6-6: Replace bare URL with Markdown link.

The linter (MD034) rightfully flags this. Converting to a clickable Markdown link keeps the style consistent with the rest of the repo’s READMEs.

-- VPN client applications: https://shadowsocks5.github.io/en/download/clients.html
+- VPN client applications: [Shadowsocks clients](https://shadowsocks5.github.io/en/download/clients.html)

---

29-35: Tighten wording and fix missing comma in externalIPs description.

LanguageTool is correct — the sentence needs a comma after the subordinate clause.
While you’re here, consider aligning description wording with other apps (short imperative phrases).

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | Optional list of IPs to expose via the Service. If omitted, a `LoadBalancer` Service is created by default.                           | `[]`   |

---

63-64: Drop redundant sentence—already conveyed in the table.

Lines 63-64 restate the “ignored if resources is set” rule that appears in the table row for resourcesPreset. Removing duplication keeps the README concise.

-Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.
-This value is ignored if the corresponding `resources` value is set.

packages/apps/mysql/values.yaml (1)

58-65: Strip the trailing whitespace to satisfy yamllint

yamllint rightfully flags an unnecessary trailing space on line 63.
Cleaning it keeps CI green and avoids churn in future diffs.

- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/mysql/README.md (1)

50-51: Convert bare URL to Markdown link

Rule MD034 complains about the plain‐text URL.
Linkify it for lint-clean docs and better UX.

- - https://blog.aenix.io/restic-effective-backup-from-stdin-4bc1e8f083c1
+- [Restic: effective backup from stdin](https://blog.aenix.io/restic-effective-backup-from-stdin-4bc1e8f083c1)

packages/apps/ferretdb/README.md (4)

3-5: Polish wording & apply compound-adjective rules.

Small grammar/clarity tweaks:

-FerretDB is an open source MongoDB alternative.
-It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
-Internally, FerretDB service is backed by Postgres.
+FerretDB is an **open-source** MongoDB alternative.
+It translates MongoDB wire-protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
+Internally, **the** FerretDB service is backed by Postgres.

---

18-18: Tweak phrasing for precision.

“Must be lower than …” reads awkwardly; “must be less than …” is the standard comparative for numeric constraints.

-Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the total number of replicas)
+Maximum number of synchronous replicas that can acknowledge a transaction (must be less than the total number of replicas)

---

26-41: Move resources settings out of the Backup parameters table.

CPU/memory sizing has nothing to do with backups; keeping it inside the “Backup parameters” section is misleading and makes navigation harder.
Recommend introducing a dedicated subsection, e.g. “### Resource parameters”, with its own table.

-### Backup parameters
-
-| Name                     | Description                                                                                                                           | Value                                                  |
-| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
-...
-| `backup.resticPassword`  | The password for Restic backup encryption                                                                                             | `ChaXoveekoh6eigh4siesheeda2quai0`                     |
-| `resources`              | Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}`                                                   |
-| `resourcesPreset`        | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.     | `nano`                                                 |
+### Backup parameters
+
+| Name                     | Description                                                                                                                           | Value                                                  |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
+...
+| `backup.resticPassword`  | The password for Restic backup encryption                                                                                             | `ChaXoveekoh6eigh4siesheeda2quai0`                     |
+
+### Resource parameters
+
+| Name              | Description                                                                                                                                                                       | Value  |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
+| `resources`       | Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied.                                              | `{}`   |
+| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.                                 | `nano` |

---

42-51: Avoid duplication & refine YAML example.

1. The allowed-values sentence (lines 50-51) repeats what’s in the table – consider removing to reduce noise.
2. Typical Kubernetes resource blocks include requests/limits; if the chart expects flat cpu/memory, emphasise that to avoid confusion.

 Example of `resources`:
 
 ```yaml
 resources:
-  cpu: 4000m
-  memory: 4Gi
+  cpu: "4000m"   # milli-cores
+  memory: 4Gi    # bytes

-Allowed values for resourcesPreset are none, nano, micro, small, medium, large, xlarge, 2xlarge.
-This value is ignored if the corresponding resources value is set.
+The resourcesPreset value is ignored whenever an explicit resources map is provided.

</blockquote></details>
<details>
<summary>packages/apps/nats/values.yaml (1)</summary><blockquote>

`65-70`: **Strip trailing whitespace to keep YAMLlint happy**

Line 70 has a stray space that YAMLlint already complained about. Trim it to avoid failing CI and keep the file clean.

```diff
- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/nats/README.md (1)

3-4: Hyphenate “high-performance”

Minor copy-editing: the standard form is “high-performance messaging system”.

- NATS is an open-source, simple, secure, and high performance messaging system.
+ NATS is an open-source, simple, secure, and high-performance messaging system.

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

6-6: Fix heading level + missing article

Jumping from an H1 to an H3 breaks the Markdown heading hierarchy (MD001) and the phrase is missing the article “a”.

-### How to restore backup from S3
+## How to restore a backup from S3

---

53-55: Wording is slightly inconsistent

Row 53 says “When left empty, the preset defined in resourcesPreset is applied.”
Row 54 then talks about “when resources is omitted”. Use one phrase (omitted is clearer) in both places to avoid confusion.

-| `resources`              | Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` |
+| `resources`              | Explicit CPU and memory configuration for each ClickHouse replica. When **omitted**, the preset defined in `resourcesPreset` is applied. | `{}` |

---

64-66: Drop the duplicated sentence

Lines 64-66 repeat information already present in the table directly above. Removing the repetition keeps the README concise.

-Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.
-This value is ignored if the corresponding `resources` value is set. 

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

packages/apps/ferretdb/values.yaml (1)

48-50: Example credentials look like real secrets – replace with obvious placeholders

backup.s3AccessKey, backup.s3SecretKey, and backup.resticPassword contain random-looking strings that trigger Gitleaks. Even if they’re dummy, scanners (and future readers) will treat them as leaked keys. Swap them for unmistakable placeholders to avoid false positives and bad copy-paste habits.

-  s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu
-  s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog
-  resticPassword: ChaXoveekoh6eigh4siesheeda2quai0
+  s3AccessKey: <S3_ACCESS_KEY>
+  s3SecretKey: <S3_SECRET_KEY>
+  resticPassword: <RESTIC_PASSWORD>

packages/apps/postgres/values.yaml (1)

92-95: Trailing whitespace still breaks yamllint – please strip it

Line 95 is a “blank” line that actually contains spaces. This is the exact issue flagged in the previous review and still causes the trailing-spaces error shown by YAMLlint.

-␠␠␠␠     # (spaces only)
+

Delete the spaces so the line is truly empty (or remove the line altogether).

packages/apps/nats/README.md (1)

10-15: replicas description is still wrong (duplicate of earlier review)

The table row still describes replicas as “Persistent Volume size for NATS”, but it actually represents the number of pod replicas.

-| `replicas`          | Persistent Volume size for NATS                                                                                                   | `2`     |
+| `replicas`          | Number of NATS pod replicas                                                                                                        | `2`     |

packages/apps/rabbitmq/values.yaml (2)

49-50: Minor wording / consistency nitpick

You list none as an allowed value but default to nano. If none truly means “no preset → no limits/requests”, you may want to:

1. Explicitly state that behaviour in the comment, or
2. Change the default to none for symmetry.

Not blocking, but worth double-checking for consistency across charts.

---

48-48: Trailing whitespace causes YAML-lint error

Line 48 is an empty line containing two spaces, tripping the linter (trailing-spaces). Remove them:

- 
+

packages/apps/redis/values.yaml (1)

20-20: Remove trailing spaces to appease YAMLlint
Line 20 contains whitespace only, which triggers the linter’s trailing-spaces rule. A clean blank line avoids the warning.

-␠␠
+

packages/apps/mysql/values.yaml (1)

58-66: Clean up trailing spaces & re-check the example resource block.

1. YAML lint flags trailing spaces on line 63 – remove them to keep CI green.
2. The commented example puts cpu/memory directly under resources, which differs from the standard Kubernetes structure (resources.limits / resources.requests). If the chart really expects the flat form, add a short note; otherwise, update the example:

 # resources:
-#   cpu: 4000m
-#   memory: 4Gi
+#   limits:
+#     cpu: "4000m"
+#     memory: "4Gi"

3. In the comment, say “each MySQL replica” instead of “MariaDB replica” to match the chart’s name and avoid user confusion.

packages/apps/nats/values.yaml (1)

65-72: Strip trailing spaces flagged by YAMLlint

Line 70 ends with superfluous whitespace, tripping the linter. Remove it to keep the file clean.

- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/nats/README.md (1)

3-5: Hyphenate “high-performance”

Minor copy-editing: compound adjective before a noun should be hyphenated.

-... secure, and high performance messaging system.
+... secure, and high-performance messaging system.

packages/apps/vpn/README.md (4)

6-6: Convert bare URL to a Markdown link

markdownlint (MD034) flags this as a bare URL. Wrapping it in Markdown makes the link accessible and keeps linters quiet.

- - VPN client applications: https://shadowsocks5.github.io/en/download/clients.html
+ - [VPN client applications](https://shadowsocks5.github.io/en/download/clients.html)

---

10-13: Tighten wording & merge the fragmented sentences

The current four-line block duplicates context (“Outline Server” vs “Shadowbox”) and reads as a series of fragments. A compact paragraph improves flow and removes redundancy.

-The VPN Service is powered by the Outline Server, an advanced and user-friendly VPN solution.
-Internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers.
-It operates by launching Shadowsocks instances on demand.
-Furthermore, Shadowbox is compatible with standard Shadowsocks clients, providing flexibility and ease of use for your VPN requirements.
+The VPN service is powered by Outline Server—internally codenamed **Shadowbox**—an advanced, user-friendly platform that streamlines the setup and sharing of Shadowsocks servers.  
+It launches Shadowsocks instances on demand and is fully compatible with standard Shadowsocks clients, providing flexibility and ease of use for your VPN deployments.

---

33-33: Add the missing comma & clarify wording

LanguageTool’s hint is correct: the sentence needs a comma after “specified”. While touching the line, converting “LoadBalancer” to code style and trimming wording make it sharper.

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of `externalIPs` for the service (optional). If not specified, a `LoadBalancer` service is used by default.                        | `[]`   |

---

35-36: Deduplicate the allowed-values note

The same resourcesPreset explanation appears in the table (line 35) and again at the bottom (line 63). Keeping a single, concise note prevents drift.

-Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.
-This value is ignored if the corresponding `resources` value is set.
+_Note:_ `resourcesPreset` is ignored when `resources` is explicitly defined.

Also applies to: 63-64

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

6-6: Use H2 instead of H3 to keep heading levels consistent

### jumps directly from the H1 title to H3, which violates Markdown-lint rule MD001.
Changing it to ## How to restore backup from S3 avoids the skipped level.

---

8-9: Minor grammar tweak – add an article before “snapshot”

“Find the snapshot” reads more naturally (and satisfies the LanguageTool hint) than “Find snapshot”.
Same applies to subsequent list items if you copy the wording.

---

43-52: Mask example credentials with obvious placeholders

Even though the keys are fake, publishing anything that looks like real secrets encourages copy-pasting sensitive data into repos.
Consider replacing them with <ACCESS_KEY>, <SECRET_KEY>, <RESTIC_PASSWORD> to set a safer precedent.

---

53-55: Make the precedence relationship crystal-clear

The current wording (“ignored if … is set”) could be read two ways:

1. resourcesPreset is ignored when any replica has resources set.
2. It’s evaluated per-replica.

If it’s the first case (chart-wide), explicitly state “ignored entirely when resources is non-empty”. If it’s per-replica, clarify that nuance.

packages/apps/ferretdb/README.md (2)

3-3: Add hyphen in compound adjective “open-source”

Minor docs nit:

-FerretDB is an open source MongoDB alternative.
+FerretDB is an open-source MongoDB alternative.

---

5-5: Insert article “the” before “FerretDB service”

-Internally, FerretDB service is backed by Postgres.
+Internally, the FerretDB service is backed by Postgres.

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

packages/apps/nats/README.md (1)

13-13: replicas description still incorrect (duplicate of earlier feedback)

replicas represents the number of NATS pod replicas, not “Persistent Volume size”. This was flagged in a previous review but remains unfixed.

-| `replicas`          | Persistent Volume size for NATS                                                                                                   | `2`     |
+| `replicas`          | Number of NATS pod replicas                                                                                                        | `2`     |

packages/apps/redis/values.yaml (1)

18-20: Trim the trailing whitespace flagged by YAML lint

Line 20 (# memory: 4Gi) contains superfluous trailing spaces, which violates the repo’s YAML lint rules and will keep the CI red.
Removing them is straightforward and prevents distracting noise in future diffs.

- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/rabbitmq/values.yaml (2)

43-47: Clarify expected keys / units for resources

The new wording is clearer, but it still omits what structure and units the chart expects (cpu, memory, millicores vs cores, Mi vs Gi, etc.). A short hint – e.g. “keys: cpu (in millicores), memory (Mi/Gi)” – would prevent mis-configuration and keep this in sync with the sample block below.

---

48-48: Remove trailing whitespace flagged by YAMLlint

Line 48 contains only spaces. This triggers trailing-spaces in YAMLlint.

-
+

packages/apps/mysql/values.yaml (1)

64-65: Clarify resourcesPreset default vs. allowed values.

The comment lists none among allowed presets, yet the default is nano.
If none is intended to mean “do not apply any preset,” consider:

1. Explicitly documenting that none disables preset sizing.
2. Evaluating whether the default should be none instead of nano to avoid an implicit sizing assumption.

This avoids confusion for chart consumers.

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

69-70: Parameter name typo: resourcePreset → resourcesPreset

The README consistently uses the plural form (resourcesPreset) elsewhere, but this bullet switches to the singular form. This can confuse users (and search-replace tools).

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

---

6-6: Minor grammar tweak

Insert the article “a” for smoother reading.

-### How to restore backup from S3
+### How to restore a backup from S3

---

72-80: Consider clarifying CPU units in the preset table

The presets mix m suffix (millicores) and plain integers.
To avoid ambiguity, append m to whole-core values or add a note that plain integers mean cores.

Example:

-| `large`     | `1`    | `2Gi`   |
+| `large`     | `1000m`| `2Gi`   |

packages/apps/nats/values.yaml (1)

65-72: Remove trailing whitespace to satisfy linters

YAMLlint flags line 70 for trailing spaces. While harmless at runtime, it breaks CI in repos with strict linting.

- 
+

packages/apps/nats/README.md (2)

3-4: Grammar: “high-performance” needs hyphen

Compound adjective before a noun should be hyphenated.

-open-source, simple, secure, and high performance messaging system
+open-source, simple, secure, and high-performance messaging system

---

36-38: Spelling mismatch: resourcePreset → resourcesPreset

The explanation drops the “s”, contradicting the actual field name and the table above.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/postgres/README.md (1)

100-102: Parameter name typo – missing “s” in resourcesPreset.

The prose uses resourcePreset (singular) while the actual key is resourcesPreset. This inconsistency can trip up copy-pasting users.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/ferretdb/README.md (2)

3-6: Hyphenate “open-source” and add missing article
Minor wording improvements for flow and correctness.

-FerretDB is an open source MongoDB alternative.
-It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
-Internally, FerretDB service is backed by Postgres.
+FerretDB is an open-source MongoDB alternative.
+It translates MongoDB wire-protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
+Internally, the FerretDB service is backed by Postgres.

---

59-67: Add missing none preset row & align CPU unit notation
The text above (line 39) lists none as an allowed value, but the table omits it. Also, for consistency, use explicit units (1 → 1 or 1000m).

-| Preset name | CPU    | memory  |
-|-------------|--------|---------|
-| `nano`      | `100m` | `128Mi` |
-| `micro`     | `250m` | `256Mi` |
-| `small`     | `500m` | `512Mi` |
-| `medium`    | `500m` | `1Gi`   |
-| `large`     | `1`    | `2Gi`   |
-| `xlarge`    | `2`    | `4Gi`   |
-| `2xlarge`   | `4`    | `8Gi`   |
+| Preset name | CPU    | memory |
+|-------------|--------|--------|
+| `none`      | —      | —      |
+| `nano`      | `100m` | `128Mi` |
+| `micro`     | `250m` | `256Mi` |
+| `small`     | `500m` | `512Mi` |
+| `medium`    | `500m` | `1Gi`   |
+| `large`     | `1`    | `2Gi`   |
+| `xlarge`    | `2`    | `4Gi`   |
+| `2xlarge`   | `4`    | `8Gi`   |

packages/apps/vpn/README.md (3)

4-4: Add missing article for grammatical correctness

The sentence is missing the article “a” before “VPN server.”

-Managed VPN Service simplifies the deployment and management of VPN server, enabling you to establish secure connections with ease.
+Managed VPN Service simplifies the deployment and management of a VPN server, enabling you to establish secure connections with ease.

---

11-11: Rewrite fragment to a full sentence

The current wording is a fragment; prepend the subject to improve readability.

-Internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers.
+It is internally known as "Shadowbox", and it simplifies the process of setting up and sharing Shadowsocks servers.

---

33-33: Insert comma and pronoun for clarity

Minor grammar: add a comma after “specified” and the pronoun “it”.

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of externalIPs for service. Optional. If not specified, it will use a LoadBalancer service by default.                            | `[]`   |

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

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

packages/apps/postgres/values.yaml (1)

92-95: Trailing whitespace is still breaking yamllint.

CI will remain red until the stray spaces on the otherwise-blank line 95 are deleted.
Same issue was raised earlier ⬆️ — please clean it up:

- 
+

packages/apps/ferretdb/README.md (1)

56-57: Parameter name still inconsistent (resourcePreset vs resourcesPreset)

The singular form here contradicts the plural resourcesPreset introduced earlier (line 39) and elsewhere in the repo.

Same remark was given on the previous commit and still applies.

packages/apps/vpn/README.md (1)

50-51: Parameter name still inconsistent (resourcePreset → resourcesPreset)
Previous review already flagged this; singular form remains. Please update for consistency with the rest of the doc and chart values.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/mysql/values.yaml (1)

63-63: Trailing whitespace still present – linter will fail.

Same issue flagged earlier; please strip the lone space on this otherwise blank line.

- 
+

packages/apps/nats/README.md (1)

10-14: replicas description still incorrect – it denotes pod count, not PVC size.

This copy-paste error was raised in an earlier review but hasn’t been fixed yet.

-| `replicas`          | Persistent Volume size for NATS                                                                                                   | `2`     |
+| `replicas`          | Number of NATS pod replicas                                                                                                        | `2`     |

packages/apps/rabbitmq/values.yaml (2)

48-48: Remove trailing whitespace to satisfy YAML lint.
YAMLlint flags line 48 for trailing spaces.

- #   memory: 4Gi␠
+ #   memory: 4Gi

---

49-50: Double-check the preset list stays in sync across charts.
If another chart later adds or removes a preset, keeping this list manually could drift. Consider creating a single source of truth (e.g., a shared README snippet or schema enum) and referencing it here.

packages/apps/ferretdb/README.md (1)

3-6: Minor style fixes: add hyphen & definite article

Consider tightening the opening paragraph:

-FerretDB is an open source MongoDB alternative.
-It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
-Internally, FerretDB service is backed by Postgres.
+FerretDB is an open-source MongoDB alternative.
+It translates MongoDB wire-protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
+Internally, the FerretDB service is backed by Postgres.

packages/apps/redis/values.yaml (1)

18-20: Trim the trailing whitespace to satisfy YAML linting

yamllint is flagging line 20 for trailing spaces. Although harmless at runtime, it will fail CI linting. Simply remove the extra spaces on the blank line.

- 
+

packages/apps/vpn/README.md (1)

33-34: Comma missing after the introductory clause
Readability suffers a bit here—add a comma after “specified”.

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of externalIPs for service. Optional. If not specified, will use a LoadBalancer service by default.                               | `[]`   |

packages/apps/mysql/values.yaml (1)

58-62: Documentation for resources is precise now – consider aligning the example indentation.

Nice clarification that presets apply when the map is empty.
Minor nit: the commented-out example block is indented one space deeper than the actual key, which can look inconsistent when users copy/paste.

- # resources:
- #   cpu: 4000m
- #   memory: 4Gi
+ # resources:
+ #   cpu: 4000m
+ #   memory: 4Gi

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

6-6: Add missing article for grammatical clarity

### How to restore backup from S3 → ### How to restore a backup from S3
Minor grammar fix that improves readability without altering meaning.

-### How to restore backup from S3
+### How to restore a backup from S3

packages/apps/nats/values.yaml (1)

65-72: Trim trailing whitespace & keep YAML lint-clean.

Line 70 (# memory: 4Gi␠) has a trailing space that YAMLlint is already flagging. Please drop it to keep the chart lint-clean.

- #   memory: 4Gi␠
+ #   memory: 4Gi

packages/apps/nats/README.md (1)

3-5: Hyphenate “high-performance”.

Minor terminology nit: “high-performance” is a compound adjective and should be hyphenated.

-NATS is an open-source, simple, secure, and high performance messaging system.
+NATS is an open-source, simple, secure, and high-performance messaging system.

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

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: lllamnyp
PR: cozystack/cozystack#1092
File: .github/workflows/pull-requests.yaml:90-94
Timestamp: 2025-06-23T11:01:31.400Z
Learning: In GitHub Actions YAML workflows, multi-line strings under `run:` without block scalars (| or >) are automatically folded by YAML into single-line commands. This is correct behavior and doesn't require using block scalars with backslashes for line continuation.

packages/apps/vpn/README.md (1)

50-52: Inconsistent parameter name – still uses singular form.

Earlier lines (34-35) correctly use resourcesPreset; here it reverts to resourcePreset. This repeats the issue flagged in the last review.

packages/apps/mysql/values.yaml (1)

60-63: Trailing whitespace still breaks YAML-lint.

Line 63 contains stray spaces that keep failing YAMLlint (see previous review). Please trim them:

- 
+

packages/apps/ferretdb/README.md (1)

56-57: Parameter name typo – still using singular resourcePreset

The earlier table (line 39) introduces the parameter as resourcesPreset (plural). Using the singular form here breaks copy-paste consistency and will confuse users.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/postgres/values.yaml (1)

95-95: Trailing whitespace still breaks yamllint – please delete it.

CI will stay red until the blank line 95 is truly empty (no spaces/tabs). This was already flagged in previous review rounds but the whitespace remains.

- 
+

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

69-70: Spelling still inconsistent with the rest of the docs

Property is written as resourcePreset; everywhere else (including the table header on line 54) it is resourcesPreset.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/nats/values.yaml (1)

4-6: replicas description is still incorrect (copy-paste artefact).
As raised in earlier reviews, this comment should describe the number of NATS pod replicas, not a “Persistent Volume size”.

packages/apps/nats/README.md (2)

10-14: replicas row still uses the wrong description.
The table should say “Number of NATS pod replicas”, not “Persistent Volume size for NATS”.

---

36-38: Property name typo persists – should be resourcesPreset.

-`resourcePreset` sets named CPU and memory configurations for each replica.
+`resourcesPreset` sets named CPU and memory configurations for each replica.

packages/apps/rabbitmq/values.yaml (1)

46-49: Trim trailing whitespace to satisfy YAML-lint

Line 48 contains only spaces, triggering the reported trailing-spaces lint error.

- 
+

packages/apps/vpn/README.md (2)

6-6: Avoid bare URLs – convert to Markdown links.

Inline URLs violate MD034 and reduce readability. Replace with a markdown-formatted link:

- - VPN client applications: https://shadowsocks5.github.io/en/download/clients.html
+- [VPN client applications](https://shadowsocks5.github.io/en/download/clients.html)

---

33-34: Minor punctuation fix improves clarity.

Add a comma after “Optional” to separate the clause:

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of externalIPs for service. Optional, if not specified will use a LoadBalancer service by default.                                | `[]`   |

packages/apps/redis/values.yaml (1)

21-22: Minor phrasing improvement (optional).

To keep the wording parallel with the previous comment, consider adding “when” so both comments read consistently:

-## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.
+## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.

(This is purely stylistic; feel free to skip if you prefer the current wording.)

packages/apps/ferretdb/README.md (1)

3-6: Minor wording polish

Hyphenate the compound adjective “open-source” and add the definite article for clarity.

-FerretDB is an open source MongoDB alternative.
+FerretDB is an open-source MongoDB alternative.

-Internally, FerretDB service is backed by Postgres.
+Internally, the FerretDB service is backed by Postgres.

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

6-6: Fix heading level to comply with Markdown lint rule

### jumps two levels after the top-level #.
Change to ## to satisfy MD001 and keep the outline flat.

-### How to restore backup from S3
+## How to restore backup from S3

packages/apps/nats/values.yaml (1)

70-70: Strip trailing whitespace.
YAML lint flags an unnecessary trailing space on this blank line; remove it to stay tidy.

- 
+

packages/apps/nats/README.md (2)

3-5: Hyphenate the compound adjective “high-performance”.

-NATS is an open-source, simple, secure, and high performance messaging system.
+NATS is an open-source, simple, secure, and high-performance messaging system.

---

41-45: Values in the preset table look inconsistent.

• small and medium both list 500m CPU – likely a copy error.
• large/xlarge/2xlarge show integer cores without unit; consider using 1000m, 2000m, 4000m for consistency with other rows.

-| `small`     | `500m` | `512Mi` |
-| `medium`    | `500m` | `1Gi`   |
-| `large`     | `1`    | `2Gi`   |
+| `small`     | `500m`  | `512Mi` |
+| `medium`    | `1000m` | `1Gi`   |
+| `large`     | `2000m` | `2Gi`   |

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

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: lllamnyp
PR: cozystack/cozystack#1092
File: .github/workflows/pull-requests.yaml:90-94
Timestamp: 2025-06-23T11:01:31.400Z
Learning: In GitHub Actions YAML workflows, multi-line strings under `run:` without block scalars (| or >) are automatically folded by YAML into single-line commands. This is correct behavior and doesn't require using block scalars with backslashes for line continuation.

packages/apps/redis/values.yaml (1)

20-20: Remove trailing whitespace to satisfy yamllint.

packages/apps/postgres/values.yaml (1)

94-95: Trailing whitespace still breaks yamllint

Line 95 is an empty line that ends with one or more space characters. CI will remain red until those are removed.

- 
+

packages/apps/rabbitmq/values.yaml (1)

48-48: Strip trailing whitespace to keep yamllint green

yamllint still reports trailing-spaces on this otherwise-blank line. Delete the stray spaces/tabs altogether.

-
+

packages/apps/nats/values.yaml (2)

4-6: replicas docstring still says “Persistent Volume size” – should describe pod count

This was flagged in earlier reviews but hasn’t been fixed. It should read “Number of NATS pod replicas” to avoid confusing operators.

-## @param replicas Persistent Volume size for NATS
+## @param replicas Number of NATS pod replicas

---

70-70: Trailing whitespace breaks YAML-lint

Line 70 contains an invisible space that continues to fail the trailing-spaces rule and will keep CI red.

-␠
+

packages/apps/nats/README.md (1)

13-14: Parameter table still uses wrong description for replicas

It should identify the number of pod replicas, not a volume size.

-| `replicas`          | Persistent Volume size for NATS                                                                                                   | `2`     |
+| `replicas`          | Number of NATS pod replicas                                                                                                        | `2`     |

packages/apps/mysql/values.yaml (1)

60-64: Strip the trailing whitespace at line 63 to appease YAMLlint

The blank line currently ends with a stray space, and YAMLlint still flags trailing-spaces.
Please delete the whitespace char.

- 
+

packages/apps/mysql/README.md (1)

141-148: Fix invalid YAML indentation in the databases example

List items must be nested under their role keys; otherwise the example will not parse.

       admin:
-      - user1
+        - user1
       readonly:
-      - user2
+        - user2

packages/apps/ferretdb/README.md (1)

3-6: Minor wording tweaks for clarity & style

Small grammar polish:

-FerretDB is an open source MongoDB alternative.
+FerretDB is an open-source MongoDB alternative.

-Internally, FerretDB service is backed by Postgres.
+Internally, the FerretDB service is backed by Postgres.

Hyphenates the compound adjective and adds the missing article.
No functional impact—purely readability.

packages/apps/postgres/values.yaml (2)

90-97: Minor wording / behaviour mismatch

resourcesPreset docs list the value none, yet the comment above states the preset is applied only “when resources is omitted”.
Clarify whether setting resourcesPreset: none should completely disable limits or whether an empty string is required.

---

60-64: Typo: “pereiodic” → “periodic”

-## @param backup.enabled Enable pereiodic backups
+## @param backup.enabled Enable periodic backups

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

6-6: Grammar tweak: add the missing determiner

How to restore backup from S3 → How to restore **a** backup from S3
Minor readability nit.

---

72-80: Include the none preset in the reference table

The description lists none as an allowed value, but the table omits it.
Add a row (CPU/memory left blank or -) so users see the full set of options.

---

63-67: Provide a matching resourcesPreset YAML snippet

You show a flat-format resources example, but not the corresponding preset usage. A quick snippet helps users copy-paste correctly.

resourcesPreset: "large"

Consider appending this right after the resources example block.

packages/apps/rabbitmq/values.yaml (1)

49-50: Consider adding "none" to the example list

Since "none" is an allowed value, showing it explicitly in the list keeps the docs self-contained and avoids guesswork.

packages/apps/nats/README.md (1)

3-4: Hyphenate compound adjective “high-performance”

Minor style nit: “high-performance messaging system” reads better and matches docs elsewhere.

-NATS is an open-source, simple, secure, and high performance messaging system.
+NATS is an open-source, simple, secure, and high-performance messaging system.

packages/apps/vpn/README.md (4)

6-6: Prefer Markdown reference-style links over bare URLs

lint-rule MD034 flags this bare URL.
Switching to [VPN client applications](https://shadowsocks5.github.io/en/download/clients.html) keeps the doc compliant and renders nicer.

- - VPN client applications: https://shadowsocks5.github.io/en/download/clients.html
+ - [VPN client applications](https://shadowsocks5.github.io/en/download/clients.html)

---

33-34: Insert a comma for grammatical clarity

The LanguageTool hint is right – a comma after “specified” avoids a run-on sentence.

-| `externalIPs`     | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.                                   | `[]`   |
+| `externalIPs`     | List of externalIPs for service. Optional. If not specified, will use a LoadBalancer service by default.                              | `[]`   |

---

41-48: Clarify how flat cpu / memory keys are mapped

Readers unfamiliar with Cozy-lib might wonder whether these flat keys become requests, limits, or both. A short note avoids ambiguity and aligns with the behavior described in cozy-lib.resources.sanitize.

-`resources` sets explicit CPU and memory configurations for each replica.
+`resources` sets explicit CPU and memory requests/limits for each replica.  
+Flat keys (`cpu`, `memory`) are automatically applied to *both* `requests` and `limits` by `cozy-lib.resources.sanitize`.

---

53-61: Use consistent CPU units in the preset table

Most rows use m units; the small/medium rows switch to bare integers. Stick to one style (e.g., 1000m) for readability.

-| `small`     | `1`    | `512Mi` |
-| `medium`    | `1`    | `1Gi`   |
+| `small`     | `1000m`| `512Mi` |
+| `medium`    | `1000m`| `1Gi`   |

packages/apps/mysql/README.md (1)

50-50: Replace bare URL with a Markdown link to satisfy MD034

Markdown-lint warns on bare URLs. Re-format the bullet as:

-- https://blog.aenix.io/restic-effective-backup-from-stdin-4bc1e8f083c1
+- [Restic: effective backup from stdin](https://blog.aenix.io/restic-effective-backup-from-stdin-4bc1e8f083c1)

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

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/clickhouse/README.md:60-67
Timestamp: 2025-07-03T05:54:50.989Z
Learning: The `cozy-lib.resources.sanitize` function in packages/library/cozy-lib/templates/_resources.tpl supports both standard Kubernetes resource format (with limits:/requests: sections) and flat format (direct resource specifications). The flat format takes priority over nested values. CozyStack apps include cozy-lib as a chart dependency through symlinks in packages/apps/*/charts/cozy-lib directories.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/clickhouse/README.md:60-67
Timestamp: 2025-07-03T05:54:50.989Z
Learning: The `cozy-lib.resources.sanitize` function in packages/library/cozy-lib/templates/_resources.tpl supports both standard Kubernetes resource format (with limits:/requests: sections) and flat format (direct resource specifications). The flat format takes priority over nested values. CozyStack apps include cozy-lib as a chart dependency through symlinks in packages/apps/*/charts/cozy-lib directories.

Learnt from: lllamnyp
PR: cozystack/cozystack#1025
File: packages/apps/kafka/charts/cozy-lib:1-1
Timestamp: 2025-06-04T06:22:17.306Z
Learning: Files in packages/apps/*/charts/cozy-lib that contain the path "../../../library/cozy-lib" are symbolic links, not regular files. Git diffs may display symlinks as regular files with their target path as content, which can be misleading in code review.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/clickhouse/README.md:60-67
Timestamp: 2025-07-03T05:54:50.989Z
Learning: The `cozy-lib.resources.sanitize` function in packages/library/cozy-lib/templates/_resources.tpl supports both standard Kubernetes resource format (with limits:/requests: sections) and flat format (direct resource specifications). The flat format takes priority over nested values. CozyStack apps include cozy-lib as a chart dependency through symlinks in packages/apps/*/charts/cozy-lib directories.

Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/clickhouse/README.md:60-67
Timestamp: 2025-07-03T05:54:50.989Z
Learning: The `cozy-lib.resources.sanitize` function in packages/library/cozy-lib/templates/_resources.tpl supports both standard Kubernetes resource format (with limits:/requests: sections) and flat format (direct resource specifications). The flat format takes priority over nested values. CozyStack apps include cozy-lib as a chart dependency through symlinks in packages/apps/*/charts/cozy-lib directories.

Learnt from: lllamnyp
PR: cozystack/cozystack#1092
File: .github/workflows/pull-requests.yaml:90-94
Timestamp: 2025-06-23T11:01:31.400Z
Learning: In GitHub Actions YAML workflows, multi-line strings under `run:` without block scalars (| or >) are automatically folded by YAML into single-line commands. This is correct behavior and doesn't require using block scalars with backslashes for line continuation.

Learnt from: lllamnyp
PR: cozystack/cozystack#1092
File: .github/workflows/pull-requests.yaml:90-94
Timestamp: 2025-06-23T11:01:31.400Z
Learning: In GitHub Actions YAML workflows, multi-line strings under `run:` without block scalars (| or >) are automatically folded by YAML into single-line commands. This is correct behavior and doesn't require using block scalars with backslashes for line continuation.