Skip to content
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

Add comparison matrix to Velocity comparison page #222

Merged
merged 6 commits into from
Sep 10, 2023

Conversation

Malfrador
Copy link
Member

@Malfrador Malfrador commented Aug 20, 2023

A question that gets asked often is "Should I use Velocity, Waterfall or BungeeCord". While the existing page already answer that, its a lot to read and contains plenty of details that most server owners just looking for a simple answer aren't interested in.

This PR adds a small markdown table with a comparison matrix to the top of that doc page. It makes it easy to see at a glance what Velocity does, and what it doesn't do - mainly, supporting plugins made for BungeeCord, another question that gets asked very often.

chrome_PdzuRM5Us1

Goal of this PR is to have an easy to understand overview for someone just looking for a simple answer to the aforementioned question. Those interested in more in-depth information can just continue reading the docs page.
With the table added, the docs page can simply be linked everytime someone asks that question, and contains a quick answer for them.

docs/velocity/admin/reference/comparison.md Outdated Show resolved Hide resolved
docs/velocity/admin/reference/comparison.md Outdated Show resolved Hide resolved
docs/velocity/admin/reference/comparison.md Outdated Show resolved Hide resolved
@olijeffers0n
Copy link
Member

Two rows for velocity and bungee plugins seem redundant but i can’t think of a better way to do this. Also, surely there must be another pro to Bungee over velocity? Seems rather one sided that’s all 😄

@MiniDigger
Copy link
Member

MiniDigger commented Aug 21, 2023

that table should somehow also show a difference between bungee and waterfall (not that I would know something to add there, lol)

also, maybe some kinda sentence introducing the table, bla bla, quick overview of the differences, read below for more detail.

@A248
Copy link
Contributor

A248 commented Aug 25, 2023

If you haven't any differences between BungeeCord and Waterfall, or you aren't willing to document them, you may want to remove one of the columns entirely.

There are differences. Waterfall guarantees Slf4j and exposes it in the API. On BungeeCord this library happens to be provided, but only due to the recent circumstance of library loading. Moreover, Waterfall has miscellaneous performance improvements to the implementation. I believe there might be a few new events. If we can get PaperMC/Waterfall#812 merged, then we can also say BungeeCord doesn't address some thread safety bugs -- which would be true.

By the way, Velocity can run some BungeeCord plugins via Snap. You may want to consider, thus, a mixed marker between a checkmark and an X.

Finally, in Velocity's favor, I strongly suggest adding a "Recommended by A248" row to your comparison matrix.

docs/velocity/admin/reference/comparison.md Outdated Show resolved Hide resolved
docs/velocity/admin/reference/comparison.md Outdated Show resolved Hide resolved
@olijeffers0n olijeffers0n merged commit 5173641 into PaperMC:main Sep 10, 2023
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.

6 participants