NO-JIRA: Update README.md with diagram #541
Conversation
WalkthroughDocumentation update: added a "Sequence Diagram(s)" section with an inline image link to an external asset in test/extended/README.md. No code, tests, or runtime behavior changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
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 pause |
✅ Actions performedReviews paused. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
test/extended/README.md (3)
8-10: Switch to Markdown image with descriptive alt text and remove fixed dimensions for better portability/responsivenessUsing raw HTML with fixed width/height can render inconsistently across viewers and isn’t responsive. Prefer Markdown image syntax with a meaningful alt text. If possible, reference a repository-local asset rather than an external URL.
Apply this diff to replace the
<img>tag:-## Sequence Diagram(s) -<img width="875" height="536" alt="image" src="https://github.com/user-attachments/assets/9e72cf2f-6f5b-4ec5-9603-a96f5de4599f" /> +## Sequence diagram +Notes:
- The alt text is an example; tailor it to what the diagram actually conveys.
- The relative path is a placeholder; please add the image to the repo (e.g., test/extended/images/) to make docs reproducible offline.
8-10: Consider embedding a Mermaid sequence diagram for versioning and reviewabilityA text-based diagram (Mermaid) keeps the source diffable, avoids binary blobs, and renders natively on GitHub. If you have the original, prefer committing it as Mermaid rather than a static screenshot.
Example replacement:
-## Sequence Diagram(s) -<img width="875" height="536" alt="image" src="https://github.com/user-attachments/assets/9e72cf2f-6f5b-4ec5-9603-a96f5de4599f" /> +## Sequence diagram + +```mermaid +sequenceDiagram + autonumber + participant Dev as Developer + participant OTE as openshift-apiserver-tests-ext + participant OCP as OpenShift Cluster + participant CI as CI Reporter + + Dev->>OTE: run / run-suite + OTE->>OCP: create resources, drive test flows + OCP-->>OTE: status/events/logs + OTE-->>CI: emit results (pass/fail, metadata/TestID) + CI-->>Dev: report outcomes +```If you must keep a static image, consider also committing the Mermaid source alongside it (e.g., test/extended/diagrams/sequence-overview.mmd).
8-10: Avoid hot-linking to user-attachments; store asset in-repo and document its source/licensingLinks under github.com/user-attachments can change ownership/availability. Storing the diagram in-repo improves longevity and complies with common docs policies. Also, please include the editable source (e.g., .mmd, .drawio) and mention its license if derived.
Follow-up:
- Add the editable diagram source under test/extended/diagrams/.
- Confirm org policy allows external image hot-linking; if not, switch to a repo-local asset.
📜 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)
test/extended/README.md(1 hunks)
|
/lgtm |
|
/assign @sanchezl |
|
@wangke19: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/approve |
openshift-ci
bot
changed the title
|
@wangke19: This pull request explicitly references no jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci-robot
added
the
jira/valid-reference
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: gangwgr, vrutkovs, wangke19 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
6 participants
Add the following diagram,
