📖 update ADOPTERS file with links that references OCM #1150
Conversation
WalkthroughRewrote the Ecosystem > Non-public adopters list in ADOPTERS.md to replace generic documentation links with specific, stable destinations; removed Jaeger and Squid entries; added Meshery. The “Adding a name” section was unchanged. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
ADOPTERS.md (4)
32-32: Avoid version-pinned doc host unless intentional.v0-16 suggests a versioned snapshot and may drift. If you intended “latest/stable,” switch to the canonical docs host.
-- [Helm](https://v0-16.open-cluster-management.io/docs/getting-started/integration/app-lifecycle/) +- [Helm](https://open-cluster-management.io/docs/getting-started/integration/app-lifecycle/)If “v0-16” is intentional (historical context), consider adding “(v0.16 docs)” in the link text.
35-35: Clarify Janus entry for discoverability.Consider naming it “Janus IDP (Backstage) – OCM backend plugin” to help readers recognize the ecosystem piece.
-- [Janus](https://www.npmjs.com/package/@janus-idp/backstage-plugin-ocm-backend) +- [Janus IDP (Backstage) – OCM backend plugin](https://www.npmjs.com/package/@janus-idp/backstage-plugin-ocm-backend)
40-41: Minor consistency check for orgs.OpenTelemetry links to the OCM addon-contrib repo, while Submariner points to the stolostron org. If there’s a canonical OCM-owned landing page for Submariner, consider aligning; otherwise keep as is.
26-41: Add CI link checking to prevent future rot.Recommend a lightweight link checker to keep these references healthy.
+name: Link Check +on: + pull_request: + schedule: + - cron: "0 6 * * 1" +jobs: + lychee: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: lycheeverse/lychee-action@v2 + with: + args: --no-progress --verbose --retry-wait 2 --max-retries 2 --markdown ADOPTERS.md + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}If you want, I can also provide a one-off script to validate these URLs locally before merging.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
ADOPTERS.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
ADOPTERS.md
[grammar] ~26-~26: There might be a mistake here.
Context: ...ludes but is not limited to: - Argo CD - [Argo CD Agent](https://argocd-agent.read...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...Resource/#how-it-works) - Argo CD Agent - [Argo Workflows](https://github.com/argop...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...tting-started/ocm-io/) - Argo Workflows - [Cluster API](https://github.com/open-clu...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...#issuecomment-1307610573) - Cluster API - [Clusternet](https://github.com/open-clus...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...ain/solutions/cluster-api) - Clusternet - [Fluid](https://github.com/open-cluster-m...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...rib/tree/main/clusternet-addon) - Fluid - [Helm](https://v0-16.open-cluster-managem...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...n-contrib/tree/main/fluid-addon) - Helm - [ICOS Meta OS](https://www.icos-project.e...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...egration/app-lifecycle/) - ICOS Meta OS - [Istio](https://github.com/open-cluster-m...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...enclustermanagementdeployment/) - Istio - [Janus](https://www.npmjs.com/package/@ja...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...anagement-io/multicluster-mesh) - Janus - [KubeStellar](https://docs.kubestellar.io...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...stage-plugin-ocm-backend) - KubeStellar - [KubeVela](https://kubevela.io/docs/platf...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...test/direct/start-from-ocm/) - KubeVela - [Kueue](https://kueue.sigs.k8s.io/docs/ta...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...em-operation/working-with-ocm/) - Kueue - [Meshery](https://docs.meshery.io/extensi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...with-open-cluster-management) - Meshery - [OpenTelemetry](https://github.com/open-c...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...pen-cluster-management) - OpenTelemetry - [Submariner](https://github.com/stolostro...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: build
- GitHub Check: unit
- GitHub Check: integration
- GitHub Check: verify
🔇 Additional comments (6)
ADOPTERS.md (6)
26-27: Good additions with OCM-specific targets.Links for Argo CD and Argo CD Agent point to concrete OCM-aware guidance. No further changes needed.
29-31: LGTM on Cluster API, Clusternet, and Fluid links.Targets are appropriate OCM addon/solution locations.
33-33: Verify external doc availability and naming.“ICOS Meta OS” spelling and the deep link look right but are long-lived? Please confirm the page returns 200 and that the project brand is spelled as intended (“Meta OS” vs “MetaOS”).
34-34: LGTM on multicluster-mesh (Istio) link.Points to the OCM org repo; consistent with other entries.
36-38: LGTM on KubeStellar, KubeVela, and Kueue links.Clear, OCM-specific integration docs.
39-39: Meshery addition looks good.Accurate integration page; alphabetical order preserved.
| - [Submariner](https://submariner.io/) | ||
| - [Argo CD](https://argo-cd.readthedocs.io/en/stable/operator-manual/applicationset/Generators-Cluster-Decision-Resource/#how-it-works) | ||
| - [Argo CD Agent](https://argocd-agent.readthedocs.io/latest/getting-started/ocm-io/) | ||
| - [Argo Workflows](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Avoid linking to issue comments; prefer stable docs.
A GitHub issue comment is brittle. If there’s no canonical doc yet, label this as “(discussion)” to set expectations, or replace with a stable doc/blog post.
-- [Argo Workflows](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573)
+- [Argo Workflows (discussion)](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573)🏁 Script executed:
#!/bin/bash
set -e
# Locate ADOPTERS.md in the repository
file=$(find . -maxdepth 4 -type f -iname "ADOPTERS.md" | head -n1)
if [ -z "$file" ]; then
echo "ADOPTERS.md not found"
exit 1
fi
echo "Found ADOPTERS.md at $file"
# Print lines around the Argo Workflows entry for context
sed -n '20,40p' "$file"Length of output: 1878
🏁 Script executed:
#!/bin/bash
set -e
# Check if a solutions directory exists and list its contents
if [ -d "solutions" ]; then
echo "solutions/:"
ls -1 solutions
else
echo "No solutions directory at repository root"
fiLength of output: 427
Label Argo Workflows entry as discussion
- [Argo Workflows](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573)
+ [Argo Workflows (discussion)](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Argo Workflows](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573) | |
| [Argo Workflows (discussion)](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573) |
🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: There might be a mistake here.
Context: ...tting-started/ocm-io/) - Argo Workflows - [Cluster API](https://github.com/open-clu...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In ADOPTERS.md around line 28, the Argo Workflows entry is currently listed as a
link to an issue comment but lacks a label; update that line to explicitly mark
it as a "discussion" (e.g., prepend or append "(discussion)" or change the
bracketed text to "Argo Workflows (discussion)") so readers know this is a
discussion rather than an adoption or implementation reference.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1150 +/- ##
=======================================
Coverage 57.94% 57.94%
=======================================
Files 211 211
Lines 20765 20765
=======================================
Hits 12033 12033
Misses 7670 7670
Partials 1062 1062
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Mike Ng <[email protected]>
mikeshng
force-pushed
the
update-adopter
branch
from
031ea51 to
2900d0e
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
ADOPTERS.md (1)
28-28: Label issue-comment links as “discussion” for stability/expectation setting.GitHub issue comments are brittle; mark it explicitly so readers know it’s a discussion thread, not canonical docs.
- - [Argo Workflows](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573) + - [Argo Workflows (discussion)](https://github.com/argoproj/argo-workflows/issues/3523#issuecomment-1307610573)
🧹 Nitpick comments (1)
ADOPTERS.md (1)
32-32: Clarify intent of version-pinned Helm docs link.If the pin to v0.16 is intentional, annotate it so readers don’t assume it’s the latest; otherwise switch to the canonical “latest”/unversioned URL.
- - [Helm](https://v0-16.open-cluster-management.io/docs/getting-started/integration/app-lifecycle/) + - [Helm (v0.16 docs)](https://v0-16.open-cluster-management.io/docs/getting-started/integration/app-lifecycle/)Optionally update to the canonical/latest docs URL if available.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
ADOPTERS.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
ADOPTERS.md
[grammar] ~26-~26: There might be a mistake here.
Context: ...ludes but is not limited to: - Argo CD - [Argo CD Agent](https://argocd-agent.read...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...Resource/#how-it-works) - Argo CD Agent - [Argo Workflows](https://github.com/argop...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...tting-started/ocm-io/) - Argo Workflows - [Cluster API](https://github.com/open-clu...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...#issuecomment-1307610573) - Cluster API - [Clusternet](https://github.com/open-clus...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...ain/solutions/cluster-api) - Clusternet - [Fluid](https://github.com/open-cluster-m...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...rib/tree/main/clusternet-addon) - Fluid - [Helm](https://v0-16.open-cluster-managem...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...n-contrib/tree/main/fluid-addon) - Helm - [ICOS Meta OS](https://www.icos-project.e...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...egration/app-lifecycle/) - ICOS Meta OS - [Istio](https://github.com/open-cluster-m...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...nt/Orchestrators/controlplane/) - Istio - [Janus](https://www.npmjs.com/package/@ja...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...anagement-io/multicluster-mesh) - Janus - [KubeStellar](https://docs.kubestellar.io...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...stage-plugin-ocm-backend) - KubeStellar - [KubeVela](https://kubevela.io/docs/platf...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...test/direct/start-from-ocm/) - KubeVela - [Kueue](https://kueue.sigs.k8s.io/docs/ta...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...em-operation/working-with-ocm/) - Kueue - [Meshery](https://docs.meshery.io/extensi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...with-open-cluster-management) - Meshery - [OpenTelemetry](https://github.com/open-c...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...pen-cluster-management) - OpenTelemetry - [Submariner](https://github.com/stolostro...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: unit
- GitHub Check: verify
- GitHub Check: integration
- GitHub Check: build
🔇 Additional comments (2)
ADOPTERS.md (2)
26-41: Solid link refresh—more specific and useful destinations.The curated targets look good and read consistently across the list.
26-41: All external links return HTTP 200 OK; ready to merge.
No typos, redirects, or 404s detected in the newly added URLs.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mikeshng, qiujian16 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit d70dd30
into
open-cluster-management-io:main
2 participants
Summary
update ADOPTERS file with links that references OCM
Related issue(s)
Fixes #
Summary by CodeRabbit