Build Status: Add badges about "About CrateDB" and "CrateDB MCP"#256
Build Status: Add badges about "About CrateDB" and "CrateDB MCP"#256
Conversation
WalkthroughThe documentation for build status was updated to include additional repositories involved in end-to-end QA integration tests, a new section for documentation-related tooling, corrections to workflow badge URLs, and the addition of a new badge for the CrateDB MCP repository. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsStatusPage
User->>DocsStatusPage: View build status documentation
DocsStatusPage->>DocsStatusPage: Display corrected Admin UI badge URL
DocsStatusPage->>DocsStatusPage: Show new CrateDB MCP badge under CLI/UI
DocsStatusPage->>DocsStatusPage: Present new Documentation section with About CrateDB badge
Possibly related PRs
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
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: 0
🧹 Nitpick comments (3)
docs/status.md (3)
166-168: Refine wording for modern usage.Consider replacing the phrase “amongst others” with “among others” to improve readability and modernize the language.
🧰 Tools
🪛 LanguageTool
[style] ~167-~167: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...s that assemble the documentation tree, amongst others.
... (AMONGST)
169-194: Approve new “Technical writing” section; add alt text to badges.This new table consolidates documentation-tool repositories nicely. For accessibility, please add
alt="..."attributes to each<img>tag (e.g.,alt="Build status badge for About CrateDB").🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
178-178: Images should have alternate text (alt text)
null(MD045, no-alt-text)
180-180: Images should have alternate text (alt text)
null(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null(MD045, no-alt-text)
188-188: Images should have alternate text (alt text)
null(MD045, no-alt-text)
209-216: Approve CrateDB MCP badge addition; ensure badge attributes.The new CrateDB MCP badge integrates the MCP repository CI status as intended. Consider adding alt text to the
<img>tag and verifying thatactions/workflows/tests.ymlexists in the cratedb-mcp repo.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
210-210: Images should have alternate text (alt text)
null(MD045, no-alt-text)
212-212: Images should have alternate text (alt text)
null(MD045, no-alt-text)
214-214: Images should have alternate text (alt text)
null(MD045, no-alt-text)
216-216: Images should have alternate text (alt text)
null(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro📒 Files selected for processing (1)
docs/status.md(3 hunks)🧰 Additional context used
🪛 LanguageTool
docs/status.md
[style] ~167-~167: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...s that assemble the documentation tree, amongst others.
... (AMONGST)
🪛 markdownlint-cli2 (0.17.2)
docs/status.md
178-178: Images should have alternate text (alt text)
null(MD045, no-alt-text)
180-180: Images should have alternate text (alt text)
null(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null(MD045, no-alt-text)
188-188: Images should have alternate text (alt text)
null(MD045, no-alt-text)
210-210: Images should have alternate text (alt text)
null(MD045, no-alt-text)
212-212: Images should have alternate text (alt text)
null(MD045, no-alt-text)
214-214: Images should have alternate text (alt text)
null(MD045, no-alt-text)
216-216: Images should have alternate text (alt text)
null(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (1)
docs/status.md (1)
28-30: Approve integration tests description update.The addition clarifies that end-to-end QA integration tests run on behalf of other auxiliary repositories, improving accuracy. Looks good.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/status.md (1)
166-167: Duplicate suggestion applied: documentation tree text
The phrasing “repositories that assemble the documentation tree, among others” matches the previous recommendation. Thanks for incorporating it.
🧹 Nitpick comments (1)
docs/status.md (1)
178-188: Add alt text to images for accessibility
Several<img>tags lack analtattribute, which is flagged by markdownlint (MD045). Please include descriptive alt text on each badge. For example:- <img src="https://img.shields.io/github/actions/workflow/status/crate/about/tests.yml?branch=main&label=Tool: About CrateDB" loading="lazy"> + <img src="https://img.shields.io/github/actions/workflow/status/crate/about/tests.yml?branch=main&label=Tool: About CrateDB" alt="Tool: About CrateDB badge" loading="lazy">And similarly for the CrateDB MCP badge under CLI/UI.
Also applies to: 210-216
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
178-178: Images should have alternate text (alt text)
null(MD045, no-alt-text)
180-180: Images should have alternate text (alt text)
null(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null(MD045, no-alt-text)
188-188: Images should have alternate text (alt text)
null(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/status.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/status.md
178-178: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
180-180: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
188-188: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
210-210: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
212-212: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
214-214: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
216-216: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (4)
docs/status.md (4)
29-30: Expand integration description
Good addition to mention “other auxiliary repositories” alongside the existing examples and course. This makes the scope of the QA tests clearer.
169-194: Added new Technical writing section for documentation tooling badges
This new table neatly surface-levels the CI status of our documentation-assembly tools and repos. It aligns well with the rest of the “Build Status” page.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
178-178: Images should have alternate text (alt text)
null(MD045, no-alt-text)
180-180: Images should have alternate text (alt text)
null(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null(MD045, no-alt-text)
188-188: Images should have alternate text (alt text)
null(MD045, no-alt-text)
209-209: Corrected CrateDB Admin UI badge workflow file name
The badge now points totests.ymlinstead ofmain.yml, which aligns with the actual workflow filename in thecrate-adminrepo.
215-216:Details
✅ Verification successful
Add CrateDB MCP badge
Great to see the MCP repo included. Please verify that thetests.ymlworkflow exists on themainbranch ofcrate/cratedb-mcpto ensure the badge shows a valid status.You can run this quick check:
Expect an HTTP/200 response if the path is correct.
🏁 Script executed:
#!/bin/bash # Verify existence of the MCP workflow file curl -I https://raw.githubusercontent.com/crate/cratedb-mcp/main/.github/workflows/tests.ymlLength of output: 1285
Confirmed:
tests.ymlworkflow exists
Thecurl -Icheck returned HTTP/200 for
https://raw.githubusercontent.com/crate/cratedb-mcp/main/.github/workflows/tests.yml,
so the badge indocs/status.md(lines 215–216) will display a valid status.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
216-216: Images should have alternate text (alt text)
null(MD045, no-alt-text)
bmunkholm
left a comment
bmunkholm
left a comment
There was a problem hiding this comment.
The PR title and description should probably reflect that we are adding build status for our docs.
I'm fine with everything else but adding build status about our docs. While it's useful for us, I'm not sure any of our users cares about that in our docs? Perhaps it would be better to add to our github readme for docs?
|
Hi Brian. Nobody will care, i.e. "which users?", and so we have it all on a single page. ;] |
|
I've diverted the relevant content into another patch. |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/status.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/status.md
180-180: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
182-182: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
184-184: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
186-186: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
220-220: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
| <tr> | ||
| <td> | ||
| <b>Documentation</b> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/crate/about/actions/workflows/tests.yml"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/crate/about/tests.yml?branch=main&label=About CrateDB" loading="lazy"></a> | ||
| </td> | ||
| </tr> |
There was a problem hiding this comment.
@bmunkholm: The only leftover item is not exclusively a documenation artefact, as it also includes code.
2 participants
Two new public repositories surfaced recently.