-
Notifications
You must be signed in to change notification settings - Fork 37
Naming things: The project was transferred to the grafana-toolbox
org
#231
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary by CodeRabbit
WalkthroughThis update systematically replaces all references to the old GitHub organization and package namespace "panodata/grafana-client" with the new "grafana-toolbox/grafana-client" across documentation, metadata, and example files. No functional code, logic, or public API was modified; only URLs and textual references were updated for consistency. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 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 (
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #231 +/- ##
=======================================
Coverage 92.26% 92.26%
=======================================
Files 27 27
Lines 1822 1822
=======================================
Hits 1681 1681
Misses 141 141
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:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/backlog.md (1)
8-15
: Optional – replace bare URLs with Markdown links to satisfy MD034markdownlint flags these lines for “bare URL used”.
If you want to silence the linter and improve readability, wrap the URLs in link syntax:- See https://github.com/grafana-toolbox/grafana-client/issues/72 +See [grafana-client #72](https://github.com/grafana-toolbox/grafana-client/issues/72)Same for the pull-request reference a few lines below.
setup.cfg (1)
14-17
: URLs updated, consider maintainer metadata
The project, source and tracker URLs were switched tografana-toolbox/*
, good.
Minor nit: themaintainer_email
on line 12 still carries the old domain (@panodata.org
). If that address is no longer monitored, update it for consistency.CHANGELOG.md (1)
283-292
: Changelog links switched – watch markdown-lint noise
The diff only replaces the organisation prefix, which is fine.
Static-analysis now flags unordered-list style (*
vs-
) around these edited lines. If you aim for a cleanmarkdownlint
run, switch the asterisks to dashes; otherwise feel free to ignore.Also applies to: 309-317
README.md (1)
345-345
: Wrap bare URL to satisfy markdown-lint
mdlint (MD034
) complains about the bare URL. Wrapping it in angle brackets keeps the plain look while silencing the check.-The issue tracker URL is: https://github.com/grafana-toolbox/grafana-client/issues +The issue tracker URL is: <https://github.com/grafana-toolbox/grafana-client/issues>docs/index.html (3)
37-41
: Replace RawGit CDN – service is discontinued and may break documentation.All three script/style tags above still point to
cdn.rawgit.com
. RawGit was sunset in 2019 and now serves a deprecation banner or 404 for new requests. Consider switching to jsDelivr’s GitHub CDN or another maintained mirror to avoid broken docs.Example quick fix:
- <script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/legacy.js'></script> - <script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/flatdoc.js'></script> - <link href='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/style.css' rel='stylesheet'> - <script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/script.js'></script> + <script src='https://cdn.jsdelivr.net/gh/rstacruz/flatdoc@v0.9.0/legacy.js'></script> + <script src='https://cdn.jsdelivr.net/gh/rstacruz/flatdoc@v0.9.0/flatdoc.js'></script> + <link href='https://cdn.jsdelivr.net/gh/rstacruz/flatdoc@v0.9.0/theme-white/style.css' rel='stylesheet'> + <script src='https://cdn.jsdelivr.net/gh/rstacruz/flatdoc@v0.9.0/theme-white/script.js'></script>
45-51
: Update visible project metadata from placeholders.
<h1>Your Project</h1>
and the<meta property="og:title">
tag still show placeholder text. Now that the repo has moved and been renamed, replace these with “grafana-client” (or a more user-friendly title) to ensure correct branding and search-engine snippets.No functional impact, but worth cleaning up before publishing the docs.
54-56
: Consider using “star” instead of deprecated “watch” GitHub button.GitHub replaced the classical “watch” count with “star” for most projects. The current iframe will show zero if watching is disabled. Swap
type=watch
→type=star
to surface the more relevant metric.-<iframe src="https://ghbtns.com/github-btn.html?user=grafana-toolbox&repo=grafana-client&type=watch&count=true" … +<iframe src="https://ghbtns.com/github-btn.html?user=grafana-toolbox&repo=grafana-client&type=star&count=true" …
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
CHANGELOG.md
(23 hunks)README.md
(4 hunks)conda/meta.yaml
(1 hunks)docs/backlog.md
(1 hunks)docs/development.md
(1 hunks)docs/index.html
(2 hunks)examples/datasource-health-check.py
(1 hunks)examples/datasource-health-probe.py
(1 hunks)examples/datasource-health-probe.rst
(1 hunks)examples/grafanalib-upload-dashboard.py
(1 hunks)setup.cfg
(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
examples/datasource-health-check.py (2)
test/elements/test_datasource_health.py (1)
DatasourceHealthCheckTestCase
(35-1154)grafana_client/elements/datasource.py (1)
health
(31-41)
🪛 markdownlint-cli2 (0.17.2)
docs/backlog.md
8-8: Bare URL used
(MD034, no-bare-urls)
10-10: Bare URL used
(MD034, no-bare-urls)
14-14: Bare URL used
(MD034, no-bare-urls)
CHANGELOG.md
285-285: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
286-286: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
287-287: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
289-289: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
289-289: Bare URL used
(MD034, no-bare-urls)
388-388: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
418-418: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
476-476: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
530-530: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
538-538: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
626-626: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
661-661: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
README.md
345-345: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (8)
docs/development.md (1)
7-7
: Clone-URL update looks goodThe new organization namespace is correct and matches the project transfer. No further action needed.
examples/datasource-health-probe.rst (1)
40-40
: URL update verifiedReference now points to the new repository location – good catch.
examples/grafanalib-upload-dashboard.py (1)
29-29
: Docstring URL updated correctlyThe sphinx target now resolves to the new org.
examples/datasource-health-check.py (1)
4-4
: Docstring link modernizedLink relocation is accurate and consistent with the repo transfer.
examples/datasource-health-probe.py (1)
4-4
: Doc-link correctly updated
The URL now points to the new organisation – nothing else changed. ✅conda/meta.yaml (1)
30-36
: Conda recipe links aligned with new repo
All three metadata URLs now target the new organisation. Looks good.README.md (2)
3-6
: Badge URLs updated correctly
All CI / coverage / license badges now reference the new repository – good.Also applies to: 13-13
316-317
: Application list link corrected
grafana-wtf
link now points to the new org – looks fine.
What the title says.