chore: update and consolidate cli tool meta configs and add README/release notes examples #32
Conversation
…lease notes examples
WalkthroughThis pull request deletes two configuration data files ( Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
🟡 Minor comments (43)
data/readmes/cozystack-v0383.md-65-65 (1)
65-65: Fix grammatical error in contributions section.Line 65 contains a grammatical error. The phrase "express your intention to on the fix" is incomplete.
-You can express your intention to on the fix on your own. +You can express your intention to work on the fix on your own.data/readmes/devfile-v230.md-3-3 (1)
3-3: Wrap bare URL in angle brackets or convert to markdown link.Line 3 contains a bare URL which violates markdown linting rules (MD034). Wrap the URL in angle brackets
<...>or format as a markdown link[text](url).-**Repository**: https://github.com/devfile/api +**Repository**: <https://github.com/devfile/api>data/readmes/cni-genie-v30.md-38-38 (1)
38-38: Fix typo: "Kuberenets" → "Kubernetes".-CNI Genie is an add-on to [Kuberenets](https://github.com/kubernetes/kubernetes) open-source project +CNI Genie is an add-on to [Kubernetes](https://github.com/kubernetes/kubernetes) open-source projectdata/readmes/cni-genie-v30.md-24-24 (1)
24-24: Fix hyphenation in compound adjective.Use a hyphen to join the compound adjective "6-minute" modifying "demo video":
-Here is a 6 minute demo video that demonstrates 3 scenarios +Here is a 6-minute demo video that demonstrates 3 scenariosdata/readmes/cni-genie-v30.md-72-72 (1)
72-72: Fix hyphenation in compound adjective.Use a hyphen to join the compound adjective "network-level" modifying "ACLs":
-7. [CNI-Genie network policy engine](docs/network-policy/README.md) for network level ACLs +7. [CNI-Genie network policy engine](docs/network-policy/README.md) for network-level ACLsdata/readmes/dolphinscheduler-332.md-28-28 (1)
28-28: Correct grammar: use "across" instead of "cross".The sentence reads more naturally with "across" rather than "cross" in this context.
-Cloud Native, DolphinScheduler supports orchestrating workflows cross multiple clouds and data centers, and allows custom task types +Cloud Native, DolphinScheduler supports orchestrating workflows across multiple clouds and data centers, and allows custom task typesdata/readmes/dolphinscheduler-332.md-68-68 (1)
68-68: Replace non-descriptive link text with specific label.Link text should be descriptive of the target. Replace "[here]" with a more specific description.
-Check out good first issue in [here](https://github.com/apache/dolphinscheduler/contribute) if you are new to DolphinScheduler. +Check out [good first issues](https://github.com/apache/dolphinscheduler/contribute) if you are new to DolphinScheduler.data/readmes/dolphinscheduler-332.md-3-3 (1)
3-3: Format bare URL as a markdown link.Wrap the repository URL in markdown link syntax for consistency with documentation standards.
-**Repository**: https://github.com/apache/dolphinscheduler +**Repository**: [https://github.com/apache/dolphinscheduler](https://github.com/apache/dolphinscheduler)data/readmes/dolphinscheduler-332.md-20-20 (1)
20-20: Remove extra spaces inside emphasis markers.The emphasis markers have unnecessary spaces around the emphasized text.
-It is dedicated to handling complex task dependencies in data pipelines, and provides a wide range of built-in job types ** out of the box** +It is dedicated to handling complex task dependencies in data pipelines, and provides a wide range of built-in job types **out of the box**data/readmes/bpfman-v056.md-3-3 (1)
3-3: Wrap bare URL in angle brackets per markdown linting standards.Line 3 contains a bare URL which violates markdown best practices (MD034). Wrap it in angle brackets to comply with markdown linting rules and improve readability.
-**Repository**: https://github.com/bpfman/bpfman +**Repository**: <https://github.com/bpfman/bpfman>data/readmes/crossplane-v213.md-3-3 (1)
3-3: Fix bare URL: wrap with markdown link syntax.Line 3 contains a bare URL without markdown link formatting. For consistency with markdown best practices, wrap it in a link:
-**Repository**: https://github.com/crossplane/crossplane +**Repository**: [https://github.com/crossplane/crossplane](https://github.com/crossplane/crossplane)data/readmes/curve-v127-rc6.md-88-88 (1)
88-88: Fix GitHub capitalization.GitHub's official branding uses "GitHub" (capital H), not "Github".
- [Github Issues](https://github.com/openCURVE/CURVE/issues) + [GitHub Issues](https://github.com/openCURVE/CURVE/issues)data/readmes/easegress-v2101.md-94-94 (1)
94-94: Add hyphen to compound adjective.The phrase "user developed" should be hyphenated as "user-developed" when used as a compound adjective modifying "code."
Apply this diff:
-- **WebAssembly** executes user developed [WebAssembly](https://webassembly.org/) code. +- **WebAssembly** executes user-developed [WebAssembly](https://webassembly.org/) code.data/readmes/easegress-v2101.md-212-220 (1)
212-220: Use markdown headings instead of emphasis for section labels.Lines 212, 216, and 220 use bold emphasis for section labels; convert them to proper markdown headings (MD036) for better document structure and outline extraction.
Apply this diff to replace emphasis with headings:
### Screenshots -**1. Cluster Management** +#### 1. Cluster Management  -**2. Traffic Management** +#### 2. Traffic Management  -**3. Pipeline Management** +#### 3. Pipeline Management data/readmes/easegress-v2101.md-3-3 (1)
3-3: Wrap bare URL in angle brackets or convert to markdown link.Per markdown best practices (MD034), bare URLs should be explicitly marked as links.
Apply this diff to wrap the URL:
-**Repository**: https://github.com/easegress-io/easegress +**Repository**: <https://github.com/easegress-io/easegress>Alternatively, use markdown link syntax:
-**Repository**: https://github.com/easegress-io/easegress +**Repository**: [easegress](https://github.com/easegress-io/easegress)data/readmes/benthos-v4720.md-8-8 (1)
8-8: Fix inconsistent heading styles and heading level progression.Two heading style violations detected:
- Line 8: Uses setext-style heading (underline) for "Redpanda Connect" instead of atx-style (
#).- Line 43: Heading level skips from h2 to h3 without an intermediate h2; MD001 requires incremental level progression.
-Redpanda Connect -================ +## Redpanda Connect ... -### !NEW! Check Out the Latest AI Goodies +## !NEW! Check Out the Latest AI GoodiesAlso applies to: 43-43
data/readmes/benthos-v4720.md-181-184 (1)
181-184: Replace hard tabs with spaces.Lines 181–184 contain hard tabs (indentation) instead of spaces, violating MD010. Replace with spaces for consistent formatting.
docker run --rm \ - -v /path/to/your/benthos.yaml:/config.yaml \ - -v /tmp/data:/data \ - -p 4195:4195 \ - docker.redpanda.com/redpandadata/connect run /config.yaml + -v /path/to/your/benthos.yaml:/config.yaml \ + -v /tmp/data:/data \ + -p 4195:4195 \ + docker.redpanda.com/redpandadata/connect run /config.yamldata/readmes/benthos-v4720.md-3-3 (1)
3-3: Wrap bare URL in Markdown link syntax.Line 3 contains a bare URL which violates Markdown linting rules (MD034). Wrap repository URLs in proper link syntax.
-**Repository**: https://github.com/benthosdev/benthos +**Repository**: [https://github.com/benthosdev/benthos](https://github.com/benthosdev/benthos)data/readmes/carina-v0140.md-3-3 (1)
3-3: Fix markdown linting issues: bare URL and missing alt text.Line 3 contains a bare URL without markdown link syntax, and line 8 is missing alt text for the image.
- **Repository**: https://github.com/carina-io/carina + **Repository**: [https://github.com/carina-io/carina](https://github.com/carina-io/carina) - <img src="https://user-images.githubusercontent.com/88021699/130732359-4e7686a9-3010-4142-971d-b65498d9c911.jpg" width="50%"> + <img src="https://user-images.githubusercontent.com/88021699/130732359-4e7686a9-3010-4142-971d-b65498d9c911.jpg" alt="Carina Logo" width="50%">Also applies to: 8-8
data/readmes/carina-v0140.md-171-171 (1)
171-171: Fix capitalization of "WeChat" in the community section.- - For wechat users + - For WeChat usersdata/readmes/carina-v0140.md-21-21 (1)
21-21: Fix spelling and word choice errors in introductory sections.Multiple spelling errors should be corrected before release. Apply these fixes:
- stateful applications strive to be more peformant, eliminating + stateful applications strive to be more performant, eliminating - user can provison different type of disks + user can provision different type of disks - just plugin a new one + just plug in a new one - Extremly low overhead. + Extremely low overhead. - Auto tiering. Admins can configure carina to combine + Auto-tiering. Admins can configure carina to combine - so user can benifit both from capacity + so user can benefit both from capacity - There are many valueable optimizations + There are many valuable optimizations - provide extremely-low-latency and noOps storage system + provide extremely-low-latency and no-ops storage systemAlso applies to: 27-27, 28-28, 30-30, 31-31, 33-33, 36-36
data/readmes/carina-v0140.md-49-49 (1)
49-49: Fix markdown structure: heading hierarchy and table spacing.Line 49 shows a heading-increment violation (jumping from h2 to h3), and line 50 should have blank lines surrounding the table per MD058.
- ## Running Environments - * Kubernetes：(CSI_VERSION=1.5.0) - * Node OS：Linux - * Filesystems：ext4，xfs - * If Kubelet is running in containerized mode, you need to mount the host /dev:/dev directory - * Each node in the cluster has 1..N Bare disks, supporting SSDS and HDDS. (You can run the LSBLK --output NAME,ROTA command to view the disk type. If ROTA=1 is HDD,ROTA =0 is SSD.) - * The capacity of a raw disk must be greater than 10 GB - * If the server does not support the bcache kernel module, see [FAQ](docs/manual/FAQ.md), Modify yamL deployment + ## Running Environments + + * Kubernetes：(CSI_VERSION=1.5.0) + * Node OS：Linux + * Filesystems：ext4，xfs + + * If Kubelet is running in containerized mode, you need to mount the host /dev:/dev directory + * Each node in the cluster has 1..N Bare disks, supporting SSDS and HDDS. (You can run the LSBLK --output NAME,ROTA command to view the disk type. If ROTA=1 is HDD,ROTA =0 is SSD.) + * The capacity of a raw disk must be greater than 10 GB + * If the server does not support the bcache kernel module, see [FAQ](docs/manual/FAQ.md), Modify yamL deployment ### Kubernetes compatiblity + | kubernetes | v0.9 | v0.9.1 | v0.10 | v0.11.0 | v1.0 |Also applies to: 50-50
data/readmes/carina-v0140.md-41-41 (1)
41-41: Fix additional spelling errors in environment, architecture, and feature sections.Apply these corrections:
- Filesystems：ext4，xfs + Filesystems: ext4, xfs - ### Kubernetes compatiblity + ### Kubernetes compatibility - ops-free maintainess. Carina can scan + ops-free maintenance. Carina can scan - It has three componets: carina-scheduler + It has three components: carina-scheduler - is the controll plane of carina + is the control plane of carina - maintain the internal logivalVolume object. + maintain the internal logicalVolume object. - [scheduing based on capacity] + [scheduling based on capacity] - [volume tooplogy](docs/manual/topology.md) + [volume topology](docs/manual/topology.md)Also applies to: 49-49, 57-57, 63-63, 66-66, 75-75, 77-77
data/readmes/checkov-32495.md-332-332 (1)
332-332: Fix possessive pronoun: "its" vs "it's".Line 332 uses the contraction "it's" (it is) where the possessive pronoun "its" is needed.
-apply the following comment pattern inside it's scope: +apply the following comment pattern inside its scope:data/readmes/checkov-32495.md-61-61 (1)
61-61: Capitalize brand name "GitHub".Line 61 references the brand as "github" in lowercase; the official name uses capital "G" and capital "H".
-output currently available as CLI, [CycloneDX](https://cyclonedx.org), JSON, JUnit XML, CSV, SARIF and github markdown and link to remediation [guides] +output currently available as CLI, [CycloneDX](https://cyclonedx.org), JSON, JUnit XML, CSV, SARIF and GitHub markdown and link to remediation [guides]Committable suggestion skipped: line range outside the PR's diff.
data/readmes/ansible-v2201rc1.md-3-3 (1)
3-3: Wrap bare URL in markdown syntax or backticks.Line 3 contains a bare URL that should be formatted as a markdown link or wrapped in backticks to comply with markdown linting standards.
-**Repository**: https://github.com/ansible/ansible +**Repository**: [ansible/ansible](https://github.com/ansible/ansible)data/readmes/ansible-v2201rc1.md-9-9 (1)
9-9: Replace hard tabs with spaces for consistent markdown formatting.Line 9 uses hard tabs instead of spaces, which may cause rendering inconsistencies across different markdown processors and platforms.
-[](https://docs.ansible.com/ansible/latest/) +[](https://docs.ansible.com/ansible/latest/)data/readmes/dubbo-admin-060.md-49-49 (1)
49-49: Specify language for fenced code block.Line 49 contains a code block without a language specifier, making it harder for documentation renderers to apply syntax highlighting.
-``` +```sh admin.registry.address: zookeeper://172.17.0.2:2181data/readmes/dubbo-admin-060.md-123-123 (1)
123-123: Fix grammar and punctuation error.Line 123 contains mixed punctuation and unclear wording: "Specified default configuration，In addition to 'properties'..." The Chinese comma (，) should be replaced with an English punctuation mark, and the sentence structure needs clarification.
-properties` Specified default configuration，In addition to 'properties', you can customize other properties defined by Admin help chart，Here is available[Complete parameters](./deploy/helm/dubbo-admin/values.yaml)。 +properties` to specify the default configuration. In addition to 'properties', you can customize other properties defined by the Admin Helm chart. See [Complete parameters](./deploy/helm/dubbo-admin/values.yaml) for available options.Committable suggestion skipped: line range outside the PR's diff.
data/readmes/bfe-v180.md-3-3 (1)
3-3: Wrap bare URL in markdown link syntax.The bare URL should be wrapped as a proper markdown link to maintain consistency with markdown linting standards.
Apply this diff:
-**Repository**: https://github.com/bfenetworks/bfe +**Repository**: [https://github.com/bfenetworks/bfe](https://github.com/bfenetworks/bfe)data/readmes/bfe-v180.md-8-8 (1)
8-8: Use consistent atx-style heading syntax.The markdown linter expects consistent use of atx-style headings (with
#prefix) rather than setext-style (underline). Line 8 should use the atx style to match the rest of the document.Apply this diff:
-# BFE +## BFENote: If this heading should remain at level 1, adjust the subsequent section headings (lines 29, 46, etc.) to be h3 or lower to maintain proper hierarchy.
Committable suggestion skipped: line range outside the PR's diff.
data/readmes/cortex-v1201.md-15-15 (1)
15-15: Add alt text to image for accessibility.The image badge on line 15 is missing an
altattribute required for proper accessibility and markdown linting compliance.Apply this fix:
-<a href="https://bestpractices.coreinfrastructure.org/projects/6681"><img src="https://bestpractices.coreinfrastructure.org/projects/6681/badge"></a> +<a href="https://bestpractices.coreinfrastructure.org/projects/6681"><img src="https://bestpractices.coreinfrastructure.org/projects/6681/badge" alt="Core Infrastructure Best Practices Badge"></a>data/readmes/envoy-v1363.md-3-3 (1)
3-3: Wrap bare URL in angle brackets or link format.Per markdown linting (MD034), bare URLs should be wrapped for proper rendering.
-**Repository**: https://github.com/envoyproxy/envoy +**Repository**: <https://github.com/envoyproxy/envoy>data/readmes/envoy-v1363.md-88-92 (1)
88-92: Hyphenate "third party" as compound adjective.Apply consistent hyphenation for compound adjectives.
There has been several third party engagements focused on Envoy security: +There has been several third-party engagements focused on Envoy security:data/readmes/envoy-v1363.md-47-57 (1)
47-57: Apply hyphenation to compound adjectives.Compound adjectives modifying nouns should be hyphenated for correctness.
-* [envoy-announce](https://groups.google.com/forum/#!forum/envoy-announce): Low frequency mailing +* [envoy-announce](https://groups.google.com/forum/#!forum/envoy-announce): Low-frequency mailing list where we will email announcements only. -* [envoy-security-announce](https://groups.google.com/forum/#!forum/envoy-security-announce): Low frequency mailing +* [envoy-security-announce](https://groups.google.com/forum/#!forum/envoy-security-announce): Low-frequency mailing list where we will email security related announcements only. -* [envoy-users](https://groups.google.com/forum/#!forum/envoy-users): General user discussion. +* [envoy-users](https://groups.google.com/forum/#!forum/envoy-users): General user discussion. * [envoy-dev](https://groups.google.com/forum/#!forum/envoy-dev): Envoy developer discussion (APIs, feature design, etc.).Additionally, fix line 50:
- list where we will email security related announcements only. + list where we will email security-related announcements only.data/readmes/emissary-ingress-v400-rc1.md-66-67 (1)
66-67: Fix spelling error in design principles section."Kubernatives-native" should be "Kubernetes-native" (lines 66–67).
- Emissary is open-source, developer-centric, role-oriented, opinionated, and - Kubernatives-native. + Emissary is open-source, developer-centric, role-oriented, opinionated, and + Kubernetes-native.data/readmes/dragonfly-v235-beta0.md-42-42 (1)
42-42: Use correct branding for GitHub.Line 42: "Github" should be "GitHub" for correct branding.
-[discussion]: https://github.com/dragonflyoss/dragonfly/discussions +[discussion]: https://github.com/dragonflyoss/dragonfly/discussions(Note: The reference is correct; check any instances of "Github" text in the document body.)
data/readmes/cadence-workflow-v137-prerelease23.md-15-15 (1)
15-15: Fix spelling error visible to users.Line 15: "schema managment" should be "schema management".
-engine and tools including CLI, schema managment, benchmark and canary. +engine and tools including CLI, schema management, benchmark and canary.data/readmes/cadence-workflow-v137-prerelease23.md-108-108 (1)
108-108: Fix spelling errors in community section.Line 108: "discusion" appears twice and should be "discussion". Also "annoucement" should be "announcement". Additionally, "Github" should be "GitHub" on lines 107 and 109.
- * Best for Q&A, support/help, general discusion, and annoucement + * Best for Q&A, support/help, general discussion, and announcementdata/readmes/devspace-v6318.md-99-99 (1)
99-99: Fix typo: "port-fowarding" → "port-forwarding".Line 99 contains a spelling error.
- Let DevSpace automatically start port-fowarding and log streaming, so you don't have to constantly copy and paste pod ids or run 10 commands to get everything started. + Let DevSpace automatically start port-forwarding and log streaming, so you don't have to constantly copy and paste pod ids or run 10 commands to get everything started.data/readmes/cloud-custodian-09480.md-213-213 (1)
213-213: Fix typo in cask tool description.Line 213 contains a misspelling:
that provides a transparent front end to docker that mirors the regularShould be:
that provides a transparent front end to docker that mirrors the regulardata/readmes/clusterpedia-v090.md-47-49 (1)
47-49: Fix spelling errors in documentation.Three spelling errors were detected that reduce documentation quality:
- Line 47: "Automic" should be "Automatic"
- Line 91: "synchroizing" should be "synchronizing"
- Line 167: "meas" should be "means"
Apply this diff to correct the spelling:
- ### Automic conversion of different versions of Kube resources and support for multiple version of resources + ### Automatic conversion of different versions of Kube resources and support for multiple version of resources - The type and version of resources that Clusterpedia is synchroizing with can be adapted to you CRD and AA changes + The type and version of resources that Clusterpedia is synchronizing with can be adapted to your CRD and AA changes - if `<cluster name>` is `clusterpedia`, it meas it is a multi-cluster search operation. + if `<cluster name>` is `clusterpedia`, it means it is a multi-cluster search operation.Also note: "you CRD" on line 91 should likely be "your CRD".
Also applies to: 91-91, 167-167
data/readmes/armada-v02021.md-214-217 (1)
214-217: Fix spelling error on line 216."overiew" should be "overview".
Apply this diff:
- [Docker overiew](https://docs.docker.com/get-started/overview/) + - [Docker overview](https://docs.docker.com/get-started/overview/)
| * For more information about annotations, data values, overlays and other features see [Docs](https://carvel.dev/ytt/docs/latest/) page | ||
| * Slack: [#carvel in Kubernetes slack](https://slack.kubernetes.io/) | ||
| * Install: Grab prebuilt binaries from the [Releases page](https://github.com/carvel-dev/ytt/releases) or [Homebrew Carvel tap](https://github.com/carvel-dev/homebrew) | ||
| * Backlog: [See what we're up to]([https://app.zenhub.com/workspaces/carvel-backlog-6013063a24147d0011410709/board?repos=173207060). (Note: we use ZenHub which requires GitHub authorization](https://github.com/orgs/carvel-dev/projects/1/views/1?filterQuery=repo%3A%22vmware-tanzu%2Fcarvel-ytt%22)). |
There was a problem hiding this comment.
Fix malformed link structure.
Line 19 has a broken link with duplicate URL and mismatched brackets. This needs to be corrected to render properly.
Current:
* Backlog: [See what we're up to]([https://app.zenhub.com/workspaces/carvel-backlog-6013063a24147d0011410709/board?repos=173207060). (Note: we use ZenHub which requires GitHub authorization](https://github.com/orgs/carvel-dev/projects/1/views/1?filterQuery=repo%3A%22vmware-tanzu%2Fcarvel-ytt%22)).
Should be fixed to one of:
* Backlog: [See what we're up to](https://app.zenhub.com/workspaces/carvel-backlog-6013063a24147d0011410709/board?repos=173207060). (Note: we use ZenHub which requires GitHub authorization - [project view](https://github.com/orgs/carvel-dev/projects/1/views/1?filterQuery=repo%3A%22vmware-tanzu%2Fcarvel-ytt%22))
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
19-19: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In data/readmes/carvel-v0521.md around line 19, the Markdown link is malformed
with duplicated URL and mismatched brackets; replace the broken bracketed
sequence with two proper links: one inline link for "See what we're up to"
pointing to the ZenHub URL, and a parenthetical note that includes a second
properly formatted link to the GitHub project view (e.g., "Note: we use ZenHub
which requires GitHub authorization - [project view](...)" ), ensuring
parentheses and square brackets are balanced and no URLs are duplicated.
| distribution. | ||
|
|
||
| To use Linux checkpoint and restore features, you will need `criu` installed on | ||
| your system. See more details in [Checkpoint and Restore](#checkpoint-and-restore). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cat -n data/readmes/containerd-v220.md | head -150Repository: O1ahmad/cli-parser
Length of output: 9430
🏁 Script executed:
grep -i "checkpoint\|restore" data/readmes/containerd-v220.mdRepository: O1ahmad/cli-parser
Length of output: 225
🏁 Script executed:
wc -l data/readmes/containerd-v220.mdRepository: O1ahmad/cli-parser
Length of output: 97
Remove or fix the broken internal link reference.
Line 88 references an anchor #checkpoint-and-restore that does not exist in this file. Either add a "Checkpoint and Restore" section with this heading, or change the link to point to external documentation if the content belongs elsewhere.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
88-88: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In data/readmes/containerd-v220.md around line 88, the link uses a non-existent
anchor "#checkpoint-and-restore"; either add a section with the exact heading
"Checkpoint and Restore" (so the internal anchor resolves) near an appropriate
place in this file, or replace the link with a correct external URL or an
existing internal anchor that points to the intended documentation; update the
link text if needed to match the target and run a quick markdown link check to
confirm it resolves.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.