Skip to content

Conversation

amotl
Copy link
Contributor

@amotl amotl commented Jul 27, 2025

What the title says.

Copy link

coderabbitai bot commented Jul 27, 2025

Summary by CodeRabbit

  • Documentation
    • Updated all references from the old "panodata/grafana-client" repository to the new "grafana-toolbox/grafana-client" across documentation, changelogs, metadata files, and example scripts.
    • Adjusted URLs for badges, issue trackers, project homepage, and development instructions to reflect the new repository location.
    • No changes to functionality, logic, or code examples beyond updating URLs and repository references.

Walkthrough

This 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

Files/Paths Change Summary
CHANGELOG.md, README.md, setup.cfg, conda/meta.yaml Updated all repository/package URLs and references from "panodata/grafana-client" to "grafana-toolbox/grafana-client".
docs/backlog.md, docs/development.md, docs/index.html Changed GitHub organization in all repository-related URLs and references.
examples/datasource-health-check.py, examples/datasource-health-probe.py, examples/grafanalib-upload-dashboard.py Updated documentation URLs in docstrings/comments to reflect new repository location.
examples/datasource-health-probe.rst Changed repository clone URL in example documentation to new organization.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

In burrows deep, a change took root,
URLs and names in neat pursuit.
From panodata’s gentle warren,
To grafana-toolbox, fresh and foreign.
No code disturbed, just links anew—
A rabbit’s hop, a lighter view!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-github-org

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jul 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.26%. Comparing base (b346242) to head (53ce7d2).
⚠️ Report is 2 commits behind head on main.

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           
Flag Coverage Δ
unittests 92.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amotl amotl marked this pull request as ready for review July 27, 2025 12:52
@amotl amotl merged commit 1d5f361 into main Jul 27, 2025
7 of 8 checks passed
@amotl amotl deleted the fix-github-org branch July 27, 2025 12:52
Copy link

@coderabbitai coderabbitai bot left a 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 MD034

markdownlint 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 to grafana-toolbox/*, good.
Minor nit: the maintainer_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 clean markdownlint 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=watchtype=star to surface the more relevant metric.

-<iframe src="https://ghbtns.com/github-btn.html?user=grafana-toolbox&amp;repo=grafana-client&amp;type=watch&amp;count=true" …
+<iframe src="https://ghbtns.com/github-btn.html?user=grafana-toolbox&amp;repo=grafana-client&amp;type=star&amp;count=true" …
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56c2098 and 53ce7d2.

📒 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 good

The new organization namespace is correct and matches the project transfer. No further action needed.

examples/datasource-health-probe.rst (1)

40-40: URL update verified

Reference now points to the new repository location – good catch.

examples/grafanalib-upload-dashboard.py (1)

29-29: Docstring URL updated correctly

The sphinx target now resolves to the new org.

examples/datasource-health-check.py (1)

4-4: Docstring link modernized

Link 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant