Skip to content

Rebrand README for ProxySQL LLC maintainership #14

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.

Sign up for GitHub

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

Merged
renecannao merged 1 commit into from
Mar 23, 2026
Merged

Rebrand README for ProxySQL LLC maintainership #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 29 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
![](https://github.com/openark/orchestrator/workflows/CI/badge.svg)
![](https://github.com/openark/orchestrator/workflows/upgrade/badge.svg)
![](https://github.com/openark/orchestrator/workflows/system%20tests/badge.svg)
[![downloads](https://img.shields.io/github/downloads/openark/orchestrator/total.svg)](https://github.com/openark/orchestrator/releases) [![release](https://img.shields.io/github/release/openark/orchestrator.svg)](https://github.com/openark/orchestrator/releases)
![](https://github.com/proxysql/orchestrator/workflows/CI/badge.svg)
![](https://github.com/proxysql/orchestrator/workflows/upgrade/badge.svg)
![](https://github.com/proxysql/orchestrator/workflows/system%20tests/badge.svg)
Comment on lines +1 to +3
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to badge images for accessibility.

The CI/workflow badge images lack alt text, which prevents screen reader users from understanding the build status. Line 4 demonstrates the correct pattern with descriptive alt text.

♿ Proposed fix to add descriptive alt text 
-![](https://github.com/proxysql/orchestrator/workflows/CI/badge.svg)
-![](https://github.com/proxysql/orchestrator/workflows/upgrade/badge.svg)
-![](https://github.com/proxysql/orchestrator/workflows/system%20tests/badge.svg)
+![CI](https://github.com/proxysql/orchestrator/workflows/CI/badge.svg)
+![upgrade](https://github.com/proxysql/orchestrator/workflows/upgrade/badge.svg)
+![system tests](https://github.com/proxysql/orchestrator/workflows/system%20tests/badge.svg)
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 1-1: Images should have alternate text (alt text)

(MD045, no-alt-text)

[warning] 2-2: Images should have alternate text (alt text)

(MD045, no-alt-text)

[warning] 3-3: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 1 - 3, The markdown badges at the top use image
syntax without alt text; update each badge image token (for example the three
lines containing the URLs
https://github.com/proxysql/orchestrator/workflows/CI/badge.svg,
.../upgrade/badge.svg, and .../system%20tests/badge.svg) to include descriptive
alt text (e.g., "CI build status", "upgrade workflow status", "system tests
status") by adding an alt string inside the square brackets for each image.

[![downloads](https://img.shields.io/github/downloads/proxysql/orchestrator/total.svg)](https://github.com/proxysql/orchestrator/releases) [![release](https://img.shields.io/github/release/proxysql/orchestrator.svg)](https://github.com/proxysql/orchestrator/releases)

> **NOTE:** This is a fork of the abandoned [Orchestrator](https://github.com/openark/orchestrator) project. Percona is not the public maintainer of the Orchestrator project. We modify this fork almost exclusively for use in our Kubernetes Operators, but we make our changes available to the open-source community if they suit your needs.
> **Maintained by [ProxySQL LLC](https://proxysql.com).** Orchestrator is actively maintained and open to contributions. We believe in orchestrator's potential as the go-to MySQL HA tool, especially when paired with ProxySQL. Bug reports, feature requests, and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify governance files referenced in README exist

echo "Checking for governance files..."
for file in CONTRIBUTING.md CODE_OF_CONDUCT.md SECURITY.md MAINTAINERS.md; do
  if [ -f "$file" ]; then
    echo "✓ $file exists"
  else
    echo "✗ $file NOT found"
  fi
done

echo -e "\nIf files are missing, consider:"
echo "1. Merging Task 3 first (as noted in PR test plan)"
echo "2. Or add a comment in the Community section: '(governance files coming in #<task3-pr-number>)'"

Repository: ProxySQL/orchestrator

Length of output: 387

Governance files are missing, creating broken links in the README.

The governance files referenced in line 6 (CONTRIBUTING.md) and the Community section (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, MAINTAINERS.md) do not exist in the current branch, so the links will be broken when this PR merges.

Since the PR test plan indicates these files "will work once Task 3 merges," either:

  1. Ensure Task 3 is merged before this PR, or
  2. Add a note in the README indicating these governance files are coming in Task 3 to set expectations for users who encounter the broken links.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 6, The README currently links to governance files
(CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, MAINTAINERS.md) that do not
exist yet; update the README (edit the paragraph around the "Maintained by" /
Community section where CONTRIBUTING.md is referenced) to add a short note
stating that these governance files will be added as part of Task 3 and that
links will be available after Task 3 merges, or alternatively wait to merge this
PR until Task 3 is merged so the links are valid—make the change to the
README.md text near the existing CONTRIBUTING.md reference to clearly set
expectations for users.


>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)
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation link hard-codes tree/master/docs, but this repository’s base branch appears to be main (and the README later uses a relative /docs/... link). To avoid broken links if the default branch name changes, prefer a relative link like docs/ (or /docs/README.md) instead of https://github.com/.../tree/master/docs.

Suggested change
# orchestrator [[Documentation]](https://github.com/proxysql/orchestrator/tree/master/docs)
# orchestrator [[Documentation]](docs/)

Copilot uses AI. Check for mistakes.

>If you or your organization are willing to contribute resources or funding, please reach out to orchestrator@percona.com.


# orchestrator [[Documentation]](https://github.com/percona/orchestrator/tree/master/docs)


![Orchestrator logo](https://github.com/openark/orchestrator/raw/master/docs/images/orchestrator-logo-wide.png)
![Orchestrator logo](docs/images/orchestrator-logo-wide.png)

`orchestrator` is a MySQL high availability and replication management tool, runs as a service and provides command line access, HTTP API and Web interface. `orchestrator` supports:

Expand Down Expand Up @@ -61,17 +55,34 @@ recovery itself.
- Datacenter/physical location awareness
- MySQL-Pool association
- HTTP security/authentication methods
- There is also an [orchestrator-mysql](https://groups.google.com/forum/#!forum/orchestrator-mysql) Google groups forum to discuss topics related to orchestrator
- More...

Read the [Orchestrator documentation](https://github.com/openark/orchestrator/tree/master/docs)
#### Future Vision

- **ProxySQL-native integration** — built-in hooks and topology awareness for seamless orchestrator + ProxySQL HA workflows, no custom scripts needed.
- **PostgreSQL exploration** — a database-provider abstraction layer to support PostgreSQL streaming replication alongside MySQL.

Read the [Orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs)
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This second documentation link also hard-codes tree/master/docs. For consistency and to prevent branch-name related breakage, switch this to the same relative docs link used elsewhere in the README (e.g., docs/).

Suggested change
Read the [Orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs)
Read the [Orchestrator documentation](docs/)

Copilot uses AI. Check for mistakes.

#### Lineage

Authored by [Shlomi Noach](https://github.com/shlomi-noach):

- 2020- as https://github.com/openark/orchestrator
- 2016-2020 at [GitHub](http://github.com) as https://github.com/github/orchestrator
- 2015 at [Booking.com](http://booking.com) as https://github.com/outbrain/orchestrator
- 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
- 2020- as https://github.com/openark/orchestrator

Maintained by [Percona](https://percona.com) as https://github.com/percona/orchestrator

Maintained since 2026 by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The year 2026 is in the future and appears to be a typo. To avoid confusion, I suggest removing the year for now, making it consistent with the format of the 'Maintained by Percona' line. The correct year can be added later.

Suggested change
Maintained since 2026 by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator
Maintained by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator


#### Community

- [Contributing Guide](CONTRIBUTING.md) — how to file issues, submit PRs, and coding standards
- [Code of Conduct](CODE_OF_CONDUCT.md) — expected behavior in the community
- [Security Policy](SECURITY.md) — how to report vulnerabilities
- [Maintainers](MAINTAINERS.md) — current project maintainers
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new Community links point to CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, and MAINTAINERS.md, but those files are not present in this repo. This makes the README links 404. Either add these governance files in this PR, or update the links to existing equivalents (e.g., docs/contributions.md, docs/security.md) and omit links that don’t exist yet.

Suggested change
- [Maintainers](MAINTAINERS.md) — current project maintainers
- Maintainers — current project maintainers

Copilot uses AI. Check for mistakes.

#### Related projects

Expand Down
Loading