Rebrand README for ProxySQL LLC maintainership#9
Conversation
Replace Percona fork notice with ProxySQL LLC maintainer statement, update all badge and link URLs from openark/percona to proxysql, use local logo path, add Future Vision section, add history/lineage with ProxySQL LLC entry, and link to governance files.
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request rebrands the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request effectively rebrands the project to reflect its new maintainership under ProxySQL LLC. The updates to the README, including badge URLs, documentation links, and the addition of 'Future Vision', 'History', and 'Community' sections, are well-executed. I have one suggestion regarding the dates in the 'History' section to improve clarity and consistency with the rest of the document.
| - 2024-2025 maintained by [Percona](https://percona.com) as https://github.com/percona/orchestrator | ||
| - 2026-present maintained by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator |
There was a problem hiding this comment.
The years listed for Percona (2024-2025) and ProxySQL LLC (2026-present) in the history section appear to be set in the future. This conflicts with the new banner at the top of the file stating that the project is currently 'Maintained by ProxySQL LLC'. This discrepancy could be confusing for users. Please align the dates in the history section with the current maintainership status.
| - 2024-2025 maintained by [Percona](https://percona.com) as https://github.com/percona/orchestrator | |
| - 2026-present maintained by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator | |
| - 2024 maintained by [Percona](https://percona.com) as https://github.com/percona/orchestrator | |
| - 2024-present maintained by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator |
There was a problem hiding this comment.
Pull request overview
Updates README.md to reflect ProxySQL LLC as the active maintainer of orchestrator, refreshes repository links/badges for the new proxysql/orchestrator location, and adds forward-looking and governance-oriented sections.
Changes:
- Replaces the Percona fork notice with a ProxySQL LLC maintainer statement and contribution entry point.
- Updates badges, documentation links, and logo rendering (local image path) for the
proxysql/orchestratorrepo. - Adds new “Future Vision”, expanded “History” lineage, and “Community” sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #### Community | ||
|
|
||
| - [CONTRIBUTING.md](CONTRIBUTING.md) — how to contribute | ||
| - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — community standards | ||
| - [SECURITY.md](SECURITY.md) — reporting security vulnerabilities |
There was a problem hiding this comment.
The Community section links to CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md at the repo root, but those files do not exist in this repository (only docs/contributions.md and docs/security.md are present). Please either add the referenced governance files in this PR, or update these links to point at the existing documents so the README doesn’t introduce broken links.
| > **Maintained by [ProxySQL LLC](https://proxysql.com).** We are committed to keeping orchestrator alive and moving forward. Contributions from the community are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) to get started. | ||
|
|
||
| >We are not currently entertaining external enhancements or feature requests. We do, however, believe Orchestrator has potential and are open to exploring its future as a community-driven project. We welcome collaboration with interested organizations. Our priority is determining whether sufficient resources (time and funding) can be secured to ensure Orchestrator's continued maintenance and development. We're open to discussing potential partnerships with organizations who might be interested in supporting this effort. | ||
| # orchestrator [[Documentation]](https://github.com/proxysql/orchestrator/tree/master/docs) |
There was a problem hiding this comment.
The documentation link is hard-coded to https://github.com/proxysql/orchestrator/tree/master/docs. Consider switching this to a relative link (e.g., docs/ or /docs) so it keeps working on forks and doesn’t depend on the default branch name.
| # orchestrator [[Documentation]](https://github.com/proxysql/orchestrator/tree/master/docs) | |
| # orchestrator [[Documentation]](docs/) |
| - More... | ||
|
|
||
| Read the [Orchestrator documentation](https://github.com/openark/orchestrator/tree/master/docs) | ||
| Read the [Orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) |
There was a problem hiding this comment.
This second documentation link is also hard-coded to https://github.com/proxysql/orchestrator/tree/master/docs. Using a relative link (docs/ or /docs) would avoid future rebrand/branch churn and keep the link correct for forks and local renderers.
| - 2014 at [Outbrain](http://outbrain.com) as https://github.com/outbrain/orchestrator | ||
| - 2015 at [Booking.com](http://booking.com) as https://github.com/outbrain/orchestrator | ||
| - 2016-2020 at [GitHub](http://github.com) as https://github.com/github/orchestrator |
There was a problem hiding this comment.
The History section uses plain http:// links for Outbrain/Booking.com/GitHub. Please switch these to https:// to avoid mixed-content warnings and to follow modern security best practices.
| - 2014 at [Outbrain](http://outbrain.com) as https://github.com/outbrain/orchestrator | |
| - 2015 at [Booking.com](http://booking.com) as https://github.com/outbrain/orchestrator | |
| - 2016-2020 at [GitHub](http://github.com) as https://github.com/github/orchestrator | |
| - 2014 at [Outbrain](https://outbrain.com) as https://github.com/outbrain/orchestrator | |
| - 2015 at [Booking.com](https://booking.com) as https://github.com/outbrain/orchestrator | |
| - 2016-2020 at [GitHub](https://github.com) as https://github.com/github/orchestrator |
|
Closing — superseded by PR #14 which was already merged with the README overhaul. |
Summary
openark/orchestratorandpercona/orchestratortoproxysql/orchestratordocs/images/orchestrator-logo-wide.png) instead of external GitHub URLorchestrator@percona.com)Test plan
proxysql/orchestratorand render correctlyproxysql/orchestratoropenarkorperconareferences outside the deliberate history sectionCloses #1