[docs] Write a full release post for v0.31.0 - #999

docs/changelogs/v0.31.0.md (11)

1-3: Fix trailing space before final period

There's an extra space before the period in line 2 ("greater stability ."). Remove the space to correct the punctuation.

---

16-19: Remove outdated HTML comment block

The commented-out bullet list under the GPU support section duplicates content and should be removed to keep the changelog concise.

---

29-33: Remove stale commented Cilium list

Delete the HTML comment block in the Cilium improvements section to reduce clutter.

---

43-48: Eliminate redundant Cross-Architecture comment

The HTML comment block for cross-architecture builds duplicates the section's items and should be removed.

---

57-63: Remove legacy VPA comment block

The commented-out VPA list is no longer needed—please remove it.

---

72-75: Delete commented HelmRelease snippet

The HTML comments under the Tenant HelmRelease section duplicate existing prose; consider removing them.

---

92-97: Remove legacy VM improvements list

Please delete the commented block for VM improvements to streamline the docs.

---

106-107: Add missing article

Change "provide more stable and predictable lifecycle" to "provide a more stable and predictable lifecycle" for grammatical correctness.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~106-~106: Possible missing article found.
Context: ...ck release cycle is changing to provide more stable and predictable lifecycle to cus...

(AI_HYDRA_LEO_MISSING_A)

---

116-117: Insert clarifying comma

Add a comma after "introduced automation" to read:

"To implement these new changes, we have rebuilt our CI/CD workflows, and introduced automation enabling automatic backports."

🧰 Tools

🪛 LanguageTool

[uncategorized] ~116-~116: Possible missing comma found.
Context: ...uilt our CI/CD workflows and introduced automation enabling automatic backports. Read more...

(AI_HYDRA_LEO_MISSING_COMMA)

---

38-40: Convert PR URLs into markdown links

The raw PR URLs in parentheses should be turned into inline links, e.g.:

Makefile improvements ([#907](https://github.com/cozystack/cozystack/pull/907))  
and multi-arch Docker image builds ([#932](https://github.com/cozystack/cozystack/pull/932), [#970](https://github.com/cozystack/cozystack/pull/970))

This will resolve markdownlint’s no-bare-urls rule and improve readability.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

38-38: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

52-54: Embed Cilium PR links

Wrap the raw URL(s) in the Cilium section as markdown links, for example:

We thank Zdenek Janda @zdenekjanda for contributing this feature in [#924](https://github.com/cozystack/cozystack/pull/924).

This avoids bare URLs and provides consistent link styling.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

52-52: Bare URL used
null

(MD034, no-bare-urls)

---

53-53: Bare URL used
null

(MD034, no-bare-urls)

---

54-54: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (1)

152-152: Acknowledged past suggestion on MetalLB images.
The entry “MetalLB images are now built in-tree based on version 0.14.9 with additional critical patches” aligns with the earlier feedback and looks good.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

152-152: Bare URL used
null

(MD034, no-bare-urls)

docs/changelogs/v0.31.0.md (7)

1-3: Add a top-level heading for clarity.
The document currently begins with body text and lacks an H1. Most release notes benefit from a clear title—e.g.:

# Cozystack v0.31.0 Release Notes

Cozystack v0.31.0 is a significant release...

This will improve navigation and consistency with other changelog files.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~2-~2: Possible missing comma found.
Context: ... release process for greater stability. Below we outline the highlights in each area ...

(AI_HYDRA_LEO_MISSING_COMMA)

---

9-10: Broaden the GPU use-case description.
The phrase “GPU-powered applications for AI/ML” can imply AI/ML are the only workloads. Consider rephrasing to something like:

This allows platform users to run GPU-accelerated workloads (e.g., AI/ML) in their own clusters.

---

12-14: Convert bare URLs and PR references to Markdown links.
Markdownlint flags bare URLs throughout the document. For consistency and readability, please replace instances like:

(@kvaps in https://github.com/cozystack/cozystack/pull/834)

with

[@kvaps in PR #834](https://github.com/cozystack/cozystack/pull/834)

Similarly, convert YouTube and other links to descriptive [text](URL) form across all sections.

Also applies to: 24-27, 36-39, 53-56, 70-71, 81-86, 90-91, 100-102, 123-125, 146-148, 152-153

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

---

106-107: Add missing articles and improve phrasing.
Change:

Cozystack release cycle is changing to provide more stable and predictable lifecycle to customers...

to:

The Cozystack release cycle is changing to provide a more stable and predictable lifecycle for customers...

This adds the missing “The” and “a” for smoother reading.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~106-~106: You might be missing the article “a” here.
Context: ...ck release cycle is changing to provide more stable and predictable lifecycle to cus...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

---

116-116: Insert a comma for readability.
In:

...rebuilt our CI/CD workflows and introduced automation enabling automatic backports.

consider:

...rebuilt our CI/CD workflows and introduced automation, enabling automatic backports.

This comma clarifies the relationship between the clauses.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~116-~116: Possible missing comma found.
Context: ...uilt our CI/CD workflows and introduced automation enabling automatic backports. Read more...

(AI_HYDRA_LEO_MISSING_COMMA)

---

170-170: Clarify “Introduce” vs “Integrate” for cozytest.
Saying “Introduce cozytest” may imply original development of the BATS framework. Consider:

* Adopt the `cozytest` BATS-based testing framework. (@kvaps in PR #982)

to indicate Cozystack’s integration of an existing solution.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

170-170: Bare URL used
null

(MD034, no-bare-urls)

---

147-147: Clarify the tenant docs review entry.
“Review the tenant Kubernetes cluster docs” could be more actionable. For example:

* [docs] Updated and corrected tenant Kubernetes cluster documentation. (@NickVolynkin in PR #969)

so readers know what changed.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

147-147: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (1)

10-10: Broaden GPU use-case wording.
Consider replacing “GPU-powered AI/ML applications” with “GPU-powered workloads” to avoid implying GPUs are only for AI/ML.

docs/changelogs/v0.31.0.md (22)

1-3: Add a quick highlights summary.
The opening paragraph is clear, but consider adding a brief bullet list of top three to five highlights (e.g., GPU support, ARM64 builds, new release lifecycle) for readers to quickly grasp the key changes.

---

9-12: Use consistent PR link formatting.
Avoid bare URLs in parentheses; convert (@kvaps in https://github.com/cozystack/cozystack/pull/834) to a markdown link like (@kvaps in [#834](https://github.com/cozystack/cozystack/pull/834)) for consistency with other sections.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

---

16-19: Remove commented-out block.
The HTML comment wrapping the old bullet list is redundant now that the narrative describes the feature. Please remove it to clean up the changelog.

---

20-28: Standardize PR references and improve phrasing.

• Replace bare URLs (e.g., in https://github.com/cozystack/cozystack/pull/924) with [ #924 ](…).
• Rephrase “for contributing this feature in” to “for contributing this feature via” or “to” for clearer English.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~24-~24: The preposition “to” seems more likely in this position.
Context: ...enekjanda for contributing this feature in https://github.com/cozystack/cozystack/...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

🪛 markdownlint-cli2 (0.17.2)

24-24: Bare URL used
null

(MD034, no-bare-urls)

---

27-27: Bare URL used
null

(MD034, no-bare-urls)

---

29-33: Clean up commented-out legacy bullets.
Remove the commented-out list of Cilium changes; the prose above now fully covers these enhancements.

---

34-42: Polish wording and link style.

• Use the idiom “paves the way” instead of “paves the road” for smoother English.
• Convert bare PR links (#907, #932, #970) into markdown link shorthand ([#907], [#932], [#970]).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

38-38: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

43-48: Remove outdated commented-out content.
The legacy Makefile/Docker image bullet is commented out and no longer needed. Please delete that block.

---

49-56: Normalize PR references in VPA section.
Replace bare URLs with markdown link references, for example: (@klinch0 in [#806](https://github.com/cozystack/cozystack/pull/806)), etc., to align with the rest of the changelog.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

52-52: Bare URL used
null

(MD034, no-bare-urls)

---

53-53: Bare URL used
null

(MD034, no-bare-urls)

---

54-54: Bare URL used
null

(MD034, no-bare-urls)

---

57-63: Strip commented-out VPA bullet list.
Remove the commented-out list format; the narrative summary above already captures these details.

---

64-71: Link PR #870 consistently.
Use markdown shorthand [@klinch0 in [#870](https://github.com/cozystack/cozystack/pull/870)] instead of a bare URL to maintain uniform style.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

70-70: Bare URL used
null

(MD034, no-bare-urls)

---

72-75: Eliminate commented-out controller snippet.
The commented-out HelmRelease reconcile controller block can be removed to reduce noise.

---

76-85: Consistent PR linking and clarity tweaks.

• Format PR #905 and PR #808 as markdown link references: [#905], [#808].
• For “KubeVirt VM Export”, clarify that it enables snapshot/back-up of VM images.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

81-81: Bare URL used
null

(MD034, no-bare-urls)

---

85-85: Bare URL used
null

(MD034, no-bare-urls)

---

86-92: Format PR #974 and refine wording.

• Convert the bare PR link to [#974].
• Consider replacing “lets you pick” with “enables choosing” for conciseness.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

90-90: Bare URL used
null

(MD034, no-bare-urls)

---

98-103: Refactor bullet PR references.
Standardize all PR links here to markdown shorthand (e.g., [#929]). Verify each list item follows the pattern * [component] Description (PR, @author).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

100-100: Bare URL used
null

(MD034, no-bare-urls)

---

101-101: Bare URL used
null

(MD034, no-bare-urls)

---

102-102: Bare URL used
null

(MD034, no-bare-urls)

---

104-111: Fix missing article and tighten prose.
Add “The” before “Cozystack release lifecycle” (“The Cozystack release lifecycle is changing…”). Optionally shorten “provide a more stable and predictable lifecycle to customers” to “provide a more stable, predictable lifecycle for mission-critical users.”

🧰 Tools

🪛 LanguageTool

[uncategorized] ~105-~105: You might be missing the article “the” here.
Context: ...ck/pull/935) ## New Release Lifecycle Cozystack release lifecycle is changing to provid...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

121-149: Standardize PR references in Fixes.
The Fixes section currently embeds bare URLs for many PRs—switch to [ #PR ] shorthand (e.g., [#862]). To improve structure, consider grouping by component (e.g., Virtual Machine, Platform, Kubernetes).

🧰 Tools

🪛 LanguageTool

[uncategorized] ~140-~140: You might be missing the article “the” here.
Context: ...ystack/pull/956) * [monitoring] Remove legacy label "POD" from the exclude filter in ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

123-123: Bare URL used
null

(MD034, no-bare-urls)

---

124-124: Bare URL used
null

(MD034, no-bare-urls)

---

125-125: Bare URL used
null

(MD034, no-bare-urls)

---

126-126: Bare URL used
null

(MD034, no-bare-urls)

---

127-127: Bare URL used
null

(MD034, no-bare-urls)

---

128-128: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

130-130: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

132-132: Bare URL used
null

(MD034, no-bare-urls)

---

133-133: Bare URL used
null

(MD034, no-bare-urls)

---

134-134: Bare URL used
null

(MD034, no-bare-urls)

---

135-135: Bare URL used
null

(MD034, no-bare-urls)

---

136-136: Bare URL used
null

(MD034, no-bare-urls)

---

137-137: Bare URL used
null

(MD034, no-bare-urls)

---

138-138: Bare URL used
null

(MD034, no-bare-urls)

---

139-139: Bare URL used
null

(MD034, no-bare-urls)

---

139-139: Bare URL used
null

(MD034, no-bare-urls)

---

140-140: Bare URL used
null

(MD034, no-bare-urls)

---

141-141: Bare URL used
null

(MD034, no-bare-urls)

---

141-141: Bare URL used
null

(MD034, no-bare-urls)

---

142-142: Bare URL used
null

(MD034, no-bare-urls)

---

143-143: Bare URL used
null

(MD034, no-bare-urls)

---

144-144: Bare URL used
null

(MD034, no-bare-urls)

---

145-145: Bare URL used
null

(MD034, no-bare-urls)

---

146-146: Bare URL used
null

(MD034, no-bare-urls)

---

147-147: Bare URL used
null

(MD034, no-bare-urls)

---

148-148: Bare URL used
null

(MD034, no-bare-urls)

---

150-163: Convert dependency PR links to markdown references.
Replace bare URLs in dependency updates with link shorthand (e.g., [#945]). For better readability, consider a table format listing component and version side by side.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

152-152: Bare URL used
null

(MD034, no-bare-urls)

---

153-153: Bare URL used
null

(MD034, no-bare-urls)

---

154-154: Bare URL used
null

(MD034, no-bare-urls)

---

155-155: Bare URL used
null

(MD034, no-bare-urls)

---

156-156: Bare URL used
null

(MD034, no-bare-urls)

---

157-157: Bare URL used
null

(MD034, no-bare-urls)

---

157-157: Bare URL used
null

(MD034, no-bare-urls)

---

158-158: Bare URL used
null

(MD034, no-bare-urls)

---

159-159: Bare URL used
null

(MD034, no-bare-urls)

---

159-159: Bare URL used
null

(MD034, no-bare-urls)

---

160-160: Bare URL used
null

(MD034, no-bare-urls)

---

160-160: Bare URL used
null

(MD034, no-bare-urls)

---

161-161: Bare URL used
null

(MD034, no-bare-urls)

---

161-161: Bare URL used
null

(MD034, no-bare-urls)

---

162-162: Bare URL used
null

(MD034, no-bare-urls)

---

168-172: Link formatting for Testing improvements.
Switch the bare PR link for cozytest to markdown shorthand ([#982]). Ensure the “[BATS-based]” link remains descriptive.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

170-170: Bare URL used
null

(MD034, no-bare-urls)

---

173-177: Link formatting for Testing fixes.
Convert bare PR URLs in each bullet to markdown shorthand ([#896], [#858], [#962]) and align bullet casing (start with lowercase after the asterisk).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

174-174: Bare URL used
null

(MD034, no-bare-urls)

---

175-175: Bare URL used
null

(MD034, no-bare-urls)

---

176-176: Bare URL used
null

(MD034, no-bare-urls)

---

178-201: Clean up CI/CD change links and grouping.

• Replace all bare PR URLs with markdown shorthand ([#816], [#886], etc.).
• Consider collapsing minor CI tweaks into sub-bullets to reduce list length.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

182-182: Bare URL used
null

(MD034, no-bare-urls)

---

183-183: Bare URL used
null

(MD034, no-bare-urls)

---

184-184: Bare URL used
null

(MD034, no-bare-urls)

---

184-184: Bare URL used
null

(MD034, no-bare-urls)

---

184-184: Bare URL used
null

(MD034, no-bare-urls)

---

185-185: Bare URL used
null

(MD034, no-bare-urls)

---

186-186: Bare URL used
null

(MD034, no-bare-urls)

---

187-187: Bare URL used
null

(MD034, no-bare-urls)

---

187-187: Bare URL used
null

(MD034, no-bare-urls)

---

191-191: Bare URL used
null

(MD034, no-bare-urls)

---

191-191: Bare URL used
null

(MD034, no-bare-urls)

---

191-191: Bare URL used
null

(MD034, no-bare-urls)

---

192-192: Bare URL used
null

(MD034, no-bare-urls)

---

193-193: Bare URL used
null

(MD034, no-bare-urls)

---

194-194: Bare URL used
null

(MD034, no-bare-urls)

---

195-195: Bare URL used
null

(MD034, no-bare-urls)

---

196-196: Bare URL used
null

(MD034, no-bare-urls)

---

197-197: Bare URL used
null

(MD034, no-bare-urls)

---

198-198: Bare URL used
null

(MD034, no-bare-urls)

---

199-199: Bare URL used
null

(MD034, no-bare-urls)

---

200-200: Bare URL used
null

(MD034, no-bare-urls)

---

202-203: Link the full changelog URL.
Wrap the comparison link in markdown, e.g.:

[Full Changelog](https://github.com/cozystack/cozystack/compare/v0.30.0...v0.31.0-rc.3)

to satisfy the no-bare-urls rule.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

202-202: Bare URL used
null

(MD034, no-bare-urls)

---

204-215: Standardize community links.
Use markdown shorthand for PR references (e.g., [#838]) and link contributor handles ([@klinch0](https://github.com/klinch0)). Optionally, split “Repository Maintenance” and “New Contributors” into distinct subsections for clarity.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

208-208: Bare URL used
null

(MD034, no-bare-urls)

---

212-212: Bare URL used
null

(MD034, no-bare-urls)

---

213-213: Bare URL used
null

(MD034, no-bare-urls)

---

214-214: Bare URL used
null

(MD034, no-bare-urls)

---

215-215: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (14)

9-12: Generalize GPU workload description
“AI/ML applications” suggests GPUs are only used for AI/ML. Consider broadening to “GPU-accelerated workloads” or “GPU-powered applications” to accurately reflect other use cases.
Example:

- This enables platform users to run GPU-powered AI/ML applications in their own clusters.
+ This enables platform users to run GPU-accelerated workloads in their own clusters.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

---

14-15: Convert bare YouTube URL into markdown link
Replace the raw URL with link text for readability and lint compliance:

- Check out Andrei Kvapil's CNCF webinar [showcasing the GPU support by running Stable Diffusion in Cozystack](https://www.youtube.com/watch?v=S__h_QaoYEk).
+ Check out Andrei Kvapil's CNCF webinar [“GPU Support with Stable Diffusion in Cozystack”](https://www.youtube.com/watch?v=S__h_QaoYEk).

---

23-27: Replace bare GitHub URLs with PR references
Markdownlint flags the raw URLs. Use concise PR link syntax:

- We thank Zdenek Janda @zdenekjanda for contributing this feature in https://github.com/cozystack/cozystack/pull/924.
+ We thank Zdenek Janda @zdenekjanda for contributing this feature in [#924](https://github.com/cozystack/cozystack/pull/924).

🧰 Tools

🪛 LanguageTool

[uncategorized] ~24-~24: The preposition “to” seems more likely in this position.
Context: ...enekjanda for contributing this feature in https://github.com/cozystack/cozystack/...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

🪛 markdownlint-cli2 (0.17.2)

24-24: Bare URL used
null

(MD034, no-bare-urls)

---

27-27: Bare URL used
null

(MD034, no-bare-urls)

---

36-40: Convert build-related links to concise PR references
Refactor the multi-arch links into PR numbers:

- Changes include Makefile improvements (https://github.com/cozystack/cozystack/pull/907)
- and multi-arch Docker image builds (https://github.com/cozystack/cozystack/pull/932 and https://github.com/cozystack/cozystack/pull/970).
+ Changes include Makefile improvements ([#907](https://github.com/cozystack/cozystack/pull/907))
+ and multi-arch Docker image builds ([#932](https://github.com/cozystack/cozystack/pull/932) and [#970](https://github.com/cozystack/cozystack/pull/970)).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

38-38: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

51-56: Convert VPA links to PR references
Replace raw URLs for consistency:

- Specifically, VPA was added for tenant Kubernetes control planes (@klinch0 in https://github.com/cozystack/cozystack/pull/806),
- the Cozystack Dashboard (https://github.com/cozystack/cozystack/pull/828),
- and the Cozystack etcd-operator (https://github.com/cozystack/cozystack/pull/850).
+ Specifically, VPA was added for tenant Kubernetes control planes (@klinch0 in [#806]),
+ the Cozystack Dashboard ([#828]),
+ and the Cozystack etcd-operator ([#850]).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

52-52: Bare URL used
null

(MD034, no-bare-urls)

---

53-53: Bare URL used
null

(MD034, no-bare-urls)

---

54-54: Bare URL used
null

(MD034, no-bare-urls)

---

66-70: Convert HelmRelease controller link to reference
Use a PR reference instead of a bare URL:

- (@klinch0 in https://github.com/cozystack/cozystack/pull/870)
+ (@klinch0 in [#870])

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

70-70: Bare URL used
null

(MD034, no-bare-urls)

---

100-103: Convert raw links in “Other Features”
Replace the PR URLs with link references:

- * [platform] Introduce options … (@kvaps in https://github.com/cozystack/cozystack/pull/929)
- * [cozystack-controller] Record … (@lllamnyp in https://github.com/cozystack/cozystack/pull/831)
- * [apps] Remove … (@lllamnyp in https://github.com/cozystack/cozystack/pull/935)
+ * [platform] Introduce options … (@kvaps in [#929])
+ * [cozystack-controller] Record … (@lllamnyp in [#831])
+ * [apps] Remove … (@lllamnyp in [#935])

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

100-100: Bare URL used
null

(MD034, no-bare-urls)

---

101-101: Bare URL used
null

(MD034, no-bare-urls)

---

102-102: Bare URL used
null

(MD034, no-bare-urls)

---

108-116: Add missing “The” and convert release workflow URL

1. Prepend “The” for smoother prose:

- Cozystack release lifecycle is changing to provide a more stable…
+ The Cozystack release lifecycle is changing to provide a more stable…

2. Replace the docs link with a markdown reference:

- read the [Cozystack Release Workflow](https://github.com/cozystack/cozystack/blob/main/docs/release.md) documentation.
+ read the [Cozystack Release Workflow][release-workflow] documentation.

---

123-149: Convert Fixes section URLs to references
Numerous raw URLs trigger markdown lint warnings. Standardize on PR references:

- * [virtual-machine] Set PortList method by default. (@kvaps in https://github.com/cozystack/cozystack/pull/996)
+ * [virtual-machine] Set PortList method by default. (@kvaps in [#996])
... repeat for all entries ...

🧰 Tools

🪛 LanguageTool

[uncategorized] ~141-~141: You might be missing the article “the” here.
Context: ...ystack/pull/956) * [monitoring] Remove legacy label "POD" from the exclude filter in ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

123-123: Bare URL used
null

(MD034, no-bare-urls)

---

124-124: Bare URL used
null

(MD034, no-bare-urls)

---

125-125: Bare URL used
null

(MD034, no-bare-urls)

---

126-126: Bare URL used
null

(MD034, no-bare-urls)

---

127-127: Bare URL used
null

(MD034, no-bare-urls)

---

128-128: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

130-130: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

132-132: Bare URL used
null

(MD034, no-bare-urls)

---

133-133: Bare URL used
null

(MD034, no-bare-urls)

---

134-134: Bare URL used
null

(MD034, no-bare-urls)

---

135-135: Bare URL used
null

(MD034, no-bare-urls)

---

136-136: Bare URL used
null

(MD034, no-bare-urls)

---

137-137: Bare URL used
null

(MD034, no-bare-urls)

---

138-138: Bare URL used
null

(MD034, no-bare-urls)

---

139-139: Bare URL used
null

(MD034, no-bare-urls)

---

140-140: Bare URL used
null

(MD034, no-bare-urls)

---

140-140: Bare URL used
null

(MD034, no-bare-urls)

---

141-141: Bare URL used
null

(MD034, no-bare-urls)

---

142-142: Bare URL used
null

(MD034, no-bare-urls)

---

142-142: Bare URL used
null

(MD034, no-bare-urls)

---

143-143: Bare URL used
null

(MD034, no-bare-urls)

---

144-144: Bare URL used
null

(MD034, no-bare-urls)

---

145-145: Bare URL used
null

(MD034, no-bare-urls)

---

146-146: Bare URL used
null

(MD034, no-bare-urls)

---

147-147: Bare URL used
null

(MD034, no-bare-urls)

---

148-148: Bare URL used
null

(MD034, no-bare-urls)

---

149-149: Bare URL used
null

(MD034, no-bare-urls)

---

153-161: Convert Dependencies URLs to references
Replace the raw URLs with PR or release references:

- * MetalLB images are now built in-tree based on version 0.14.9 with additional critical patches. (@lllamnyp in https://github.com/cozystack/cozystack/pull/945)
+ * MetalLB images are now built in-tree based on version 0.14.9 with additional critical patches. (@lllamnyp in [#945])
... and so on for each dependency ...

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

153-153: Bare URL used
null

(MD034, no-bare-urls)

---

154-154: Bare URL used
null

(MD034, no-bare-urls)

---

155-155: Bare URL used
null

(MD034, no-bare-urls)

---

156-156: Bare URL used
null

(MD034, no-bare-urls)

---

157-157: Bare URL used
null

(MD034, no-bare-urls)

---

158-158: Bare URL used
null

(MD034, no-bare-urls)

---

158-158: Bare URL used
null

(MD034, no-bare-urls)

---

159-159: Bare URL used
null

(MD034, no-bare-urls)

---

160-160: Bare URL used
null

(MD034, no-bare-urls)

---

160-160: Bare URL used
null

(MD034, no-bare-urls)

---

161-161: Bare URL used
null

(MD034, no-bare-urls)

---

161-161: Bare URL used
null

(MD034, no-bare-urls)

---

169-178: Convert Testing section URLs
Standardize the BATS and e2e test URLs to references:

- * Introduce `cozytest` - a new [BATS-based](https://github.com/bats-core/bats-core) testing framework. (@kvaps in https://github.com/cozystack/cozystack/pull/982)
+ * Introduce `cozytest` - a new [BATS-based][bats-core] testing framework. (@kvaps in [#982])

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

171-171: Bare URL used
null

(MD034, no-bare-urls)

---

175-175: Bare URL used
null

(MD034, no-bare-urls)

---

176-176: Bare URL used
null

(MD034, no-bare-urls)

---

177-177: Bare URL used
null

(MD034, no-bare-urls)

---

183-189: Convert CI/CD section URLs
Replace raw URLs with PR references for clarity:

- * Use release branches `release-X.Y` ... (@kvaps in https://github.com/cozystack/cozystack/pull/816)
+ * Use release branches `release-X.Y` ... (@kvaps in [#816])

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

183-183: Bare URL used
null

(MD034, no-bare-urls)

---

184-184: Bare URL used
null

(MD034, no-bare-urls)

---

185-185: Bare URL used
null

(MD034, no-bare-urls)

---

185-185: Bare URL used
null

(MD034, no-bare-urls)

---

185-185: Bare URL used
null

(MD034, no-bare-urls)

---

186-186: Bare URL used
null

(MD034, no-bare-urls)

---

187-187: Bare URL used
null

(MD034, no-bare-urls)

---

188-188: Bare URL used
null

(MD034, no-bare-urls)

---

188-188: Bare URL used
null

(MD034, no-bare-urls)

---

208-216: Convert Community section URLs
Link PRs and contributor profiles by reference:

- Added @klinch0 to CODEOWNERS. (@kvaps in https://github.com/cozystack/cozystack/pull/838)
+ Added @klinch0 to CODEOWNERS. (@kvaps in [#838])

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

208-208: Bare URL used
null

(MD034, no-bare-urls)

---

212-212: Bare URL used
null

(MD034, no-bare-urls)

---

213-213: Bare URL used
null

(MD034, no-bare-urls)

---

214-214: Bare URL used
null

(MD034, no-bare-urls)

---

215-215: Bare URL used
null

(MD034, no-bare-urls)

---

217-220: Convert Full Changelog link
Wrap the compare URL in descriptive link text:

- See https://github.com/cozystack/cozystack/compare/v0.30.0...v0.31.0
+ See the [full changelog on GitHub][compare-v0.30.0...v0.31.0].

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

219-219: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (2)

78-83: Convert inline bold titles to sub-headings
This section uses **Bold**: titles to introduce VM improvements. To improve readability and match other sections, switch to markdown sub-headings (####), e.g.:

- **Configurable KubeVirt CPU Overcommit**: The CPU allocation ratio ...
+ #### Configurable KubeVirt CPU Overcommit
+ The CPU allocation ratio ...

This was suggested in a previous review but not yet applied.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

81-81: Bare URL used
null

(MD034, no-bare-urls)

---

147-147: Capitalize the verb in the Fixes entry
In the Fixes section, the “[dx] remove version_map…” entry starts with a lowercase verb. Please capitalize to match the style of other entries:

- * [dx] remove version_map and building for library charts. (@kvaps in https://github.com/cozystack/cozystack/pull/998)
+ * [dx] Remove version_map and building for library charts. (@kvaps in https://github.com/cozystack/cozystack/pull/998)

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

147-147: Bare URL used
null

(MD034, no-bare-urls)

docs/changelogs/v0.31.0.md (5)

7-7: Use Title Case for Section Heading
For consistency with other headings (e.g., “Cilium Improvements,” “Virtual Machine Improvements”), please capitalize “Support” and “Tenant Kubernetes Clusters” in the GPU section title:

- ### GPU support for tenant Kubernetes clusters
+ ### GPU Support for Tenant Kubernetes Clusters

---

9-12: Broaden phrasing around GPU workloads
The current line restricts GPU usage to “AI/ML” applications. Consider a more inclusive phrasing to cover other GPU-accelerated workloads. For example:

- This enables platform users to run GPU-powered AI/ML applications in their own clusters.
+ This enables platform users to run GPU-accelerated workloads (e.g., AI/ML) in their own clusters.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

---

14-14: Refine webinar link presentation
The link text is very long. For readability, consider renaming the link target and shortening the anchor. E.g.:

- Check out Andrei Kvapil's CNCF webinar [showcasing the GPU support by running Stable Diffusion in Cozystack](https://www.youtube.com/watch?v=S__h_QaoYEk).
+ Check out Andrei Kvapil's CNCF webinar on **Stable Diffusion GPU support**: [Watch on YouTube](https://www.youtube.com/watch?v=S__h_QaoYEk).

---

16-19: Remove stale HTML comments
There are multiple HTML-commented-out bullet lists throughout the file. These fragments clutter the final changelog and should be cleaned up before release.

Also applies to: 29-32, 43-47, 57-62, 72-74, 92-96

---

12-153: Consistent PR reference formatting
PR references are currently shown as full URLs in parentheses, which makes the text noisy. Consider standardizing to a shorter, linkified form—e.g.:

(@kvaps in [#834](https://github.com/cozystack/cozystack/pull/834))

This approach reduces visual clutter and aligns with common changelog conventions.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~24-~24: The preposition “to” seems more likely in this position.
Context: ...enekjanda for contributing this feature in https://github.com/cozystack/cozystack/...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

---

[uncategorized] ~105-~105: You might be missing the article “the” here.
Context: ...ck/pull/935) ## New Release Lifecycle Cozystack release lifecycle is changing to provid...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[uncategorized] ~141-~141: You might be missing the article “the” here.
Context: ...ystack/pull/956) * [monitoring] Remove legacy label "POD" from the exclude filter in ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

---

24-24: Bare URL used
null

(MD034, no-bare-urls)

---

27-27: Bare URL used
null

(MD034, no-bare-urls)

---

38-38: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

39-39: Bare URL used
null

(MD034, no-bare-urls)

---

52-52: Bare URL used
null

(MD034, no-bare-urls)

---

53-53: Bare URL used
null

(MD034, no-bare-urls)

---

54-54: Bare URL used
null

(MD034, no-bare-urls)

---

70-70: Bare URL used
null

(MD034, no-bare-urls)

---

81-81: Bare URL used
null

(MD034, no-bare-urls)

---

85-85: Bare URL used
null

(MD034, no-bare-urls)

---

90-90: Bare URL used
null

(MD034, no-bare-urls)

---

100-100: Bare URL used
null

(MD034, no-bare-urls)

---

101-101: Bare URL used
null

(MD034, no-bare-urls)

---

102-102: Bare URL used
null

(MD034, no-bare-urls)

---

123-123: Bare URL used
null

(MD034, no-bare-urls)

---

124-124: Bare URL used
null

(MD034, no-bare-urls)

---

125-125: Bare URL used
null

(MD034, no-bare-urls)

---

126-126: Bare URL used
null

(MD034, no-bare-urls)

---

127-127: Bare URL used
null

(MD034, no-bare-urls)

---

128-128: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

129-129: Bare URL used
null

(MD034, no-bare-urls)

---

130-130: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

131-131: Bare URL used
null

(MD034, no-bare-urls)

---

132-132: Bare URL used
null

(MD034, no-bare-urls)

---

133-133: Bare URL used
null

(MD034, no-bare-urls)

---

134-134: Bare URL used
null

(MD034, no-bare-urls)

---

135-135: Bare URL used
null

(MD034, no-bare-urls)

---

136-136: Bare URL used
null

(MD034, no-bare-urls)

---

137-137: Bare URL used
null

(MD034, no-bare-urls)

---

138-138: Bare URL used
null

(MD034, no-bare-urls)

---

139-139: Bare URL used
null

(MD034, no-bare-urls)

---

140-140: Bare URL used
null

(MD034, no-bare-urls)

---

140-140: Bare URL used
null

(MD034, no-bare-urls)

---

141-141: Bare URL used
null

(MD034, no-bare-urls)

---

142-142: Bare URL used
null

(MD034, no-bare-urls)

---

142-142: Bare URL used
null

(MD034, no-bare-urls)

---

143-143: Bare URL used
null

(MD034, no-bare-urls)

---

144-144: Bare URL used
null

(MD034, no-bare-urls)

---

145-145: Bare URL used
null

(MD034, no-bare-urls)

---

146-146: Bare URL used
null

(MD034, no-bare-urls)

---

147-147: Bare URL used
null

(MD034, no-bare-urls)

---

148-148: Bare URL used
null

(MD034, no-bare-urls)

---

149-149: Bare URL used
null

(MD034, no-bare-urls)

---

153-153: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (3)

9-10: Broaden GPU use-case description
Consider removing “AI/ML” to avoid implying GPU support is limited to AI workloads. For example:

- This enables platform users to run GPU-powered AI/ML applications in their own clusters.
+ This enables platform users to run GPU-powered applications in their own clusters.

---

78-91: Use sub-headings instead of bold inline titles
To improve readability and maintain consistency with other sections, convert the bold inline titles under “Virtual Machine Improvements” into markdown sub-headings. For example:

- **Configurable KubeVirt CPU Overcommit**: The CPU allocation ratio in KubeVirt ...
+ #### Configurable KubeVirt CPU Overcommit
+ The CPU allocation ratio in KubeVirt ...

- **KubeVirt VM Export**: Cozystack now allows exporting KubeVirt virtual machines.
+ #### KubeVirt VM Export
+ Cozystack now allows exporting KubeVirt virtual machines.

- **Support for various storage classes in Virtual Machines**: ...
+ #### Storage Class Flexibility for VMs
+ ...

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

81-81: Bare URL used
null

(MD034, no-bare-urls)

---

85-85: Bare URL used
null

(MD034, no-bare-urls)

---

90-90: Bare URL used
null

(MD034, no-bare-urls)

---

148-148: Fix capitalization in Fixes section
Capitalize the entry verb to match other Fixes entries:

- * [dx] remove version_map and building for library charts. (@kvaps in https://github.com/cozystack/cozystack/pull/998)
+ * [dx] Remove version_map and building for library charts. (@kvaps in https://github.com/cozystack/cozystack/pull/998)

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

148-148: Bare URL used
null

(MD034, no-bare-urls)

docs/changelogs/v0.31.0.md (2)

16-18: Remove legacy HTML comment blocks
These HTML comment sections contain outdated bullet lists and clutter the document. Removing them will clean up the changelog and avoid confusion.

Also applies to: 29-32, 43-47, 57-62, 73-74, 93-96

---

36-38: Use idiomatic English
Replace “paves the road” with “paves the way” for more natural phrasing:

- This paves the road to running Cozystack on ARM64 servers.
+ This paves the way for running Cozystack on ARM64 servers.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

38-38: Bare URL used
null

(MD034, no-bare-urls)

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

docs/changelogs/v0.31.0.md (1)

78-91: Use markdown sub-headings for VM improvements instead of bold inline titles
Switching from **Bold**: to #### sub-headings aligns this section with the rest of the document’s structure and improves scanability.

Suggested pattern:

- **Configurable KubeVirt CPU Overcommit**: The CPU allocation ratio ...
+ #### Configurable KubeVirt CPU Overcommit
+ The CPU allocation ratio ...

- **KubeVirt VM Export**: Cozystack now allows exporting KubeVirt virtual machines.
+ #### KubeVirt VM Export
+ Cozystack now allows exporting KubeVirt virtual machines.

- **Support for various storage classes in Virtual Machines**: ...
+ #### Storage Class Flexibility for VMs
+ The `virtual-machine` application now supports …

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

81-81: Bare URL used
null

(MD034, no-bare-urls)

---

85-85: Bare URL used
null

(MD034, no-bare-urls)

---

90-90: Bare URL used
null

(MD034, no-bare-urls)

docs/changelogs/v0.31.0.md (4)

13-13: Convert bare PR URLs to markdown links
Replacing full URLs with [#[PR number]](URL) notation improves readability and consistency across the changelog.

Apply these diffs:

- (@kvaps in https://github.com/cozystack/cozystack/pull/834)
+ (@kvaps in [#834](https://github.com/cozystack/cozystack/pull/834))

- (@lllamnyp in https://github.com/cozystack/cozystack/pull/917)
+ (@lllamnyp in [#917](https://github.com/cozystack/cozystack/pull/917))

Also applies to: 27-27

---

24-24: Use proper preposition and convert PR link to markdown
“Attributing contributions” is usually phrased with “to” rather than “in”. Also switch the bare URL to link syntax.

- We thank Zdenek Janda @zdenekjanda for contributing this feature in https://github.com/cozystack/cozystack/pull/924.
+ We thank Zdenek Janda @zdenekjanda for contributing this feature to [#924](https://github.com/cozystack/cozystack/pull/924).

🧰 Tools

🪛 LanguageTool

[uncategorized] ~24-~24: The preposition “to” seems more likely in this position.
Context: ...enekjanda for contributing this feature in https://github.com/cozystack/cozystack/...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

🪛 markdownlint-cli2 (0.17.2)

24-24: Bare URL used
null

(MD034, no-bare-urls)

---

105-106: Add missing article for clarity
Prepending “The” makes the sentence read more naturally.

- Cozystack release lifecycle is changing to provide a more stable and predictable lifecycle...
+ The Cozystack release lifecycle is changing to provide a more stable and predictable lifecycle...

🧰 Tools

🪛 LanguageTool

[uncategorized] ~105-~105: You might be missing the article “the” here.
Context: ...ck/pull/935) ## New Release Lifecycle Cozystack release lifecycle is changing to provid...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

148-148: Capitalize verbs in Fixes entries for consistency
All bullets in the Fixes section should begin with an uppercase verb. Also convert the PR URL to a markdown link.

- * [dx] remove version_map and building for library charts. (@kvaps in https://github.com/cozystack/cozystack/pull/998)
+ * [dx] Remove version_map and building for library charts. (@kvaps in [#998](https://github.com/cozystack/cozystack/pull/998))

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

148-148: Bare URL used
null

(MD034, no-bare-urls)

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