Skip to content
/ server Public

MDEV-38935: Improved README with Detailed Project Overview and Documentation Links #4709

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

Open
Tuppudukeerthana wants to merge 1 commit into
base: main
Choose a base branch
from
Open

MDEV-38935: Improved README with Detailed Project Overview and Documentation Links #4709

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
64 changes: 25 additions & 39 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,14 @@
# Code status:
MariaDB: The innovative open source database

* [![Appveyor CI status](https://ci.appveyor.com/api/projects/status/4u6pexmtpuf8jq66?svg=true)](https://ci.appveyor.com/project/rasmushoj/server) ci.appveyor.com
MariaDB is a community-developed, open source relational database management system (RDBMS) designed as a drop-in replacement for MySQL(R). It provides enhanced performance, improved scalability, additional storage engines, and new features while maintaining high compatibility with MySQL applications.
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

We've been trying to remove the "drop-in replacement" for years as it hasn't applied for a while. Something like https://mariadb.org/en/ as the intro. The relation to MySQL shouldn't be a dominate component of this README.


## MariaDB: The innovative open source database
MariaDB is brought to you by the MariaDB Foundation and the MariaDB Corporation. Please read the CREDITS file for details about the MariaDB Foundation and the developers contributing to MariaDB.

MariaDB was designed as a drop-in replacement for MySQL(R) with more
features, new storage engines, fewer bugs, and better performance.
MariaDB is developed by many of the original developers of MySQL who now work for the MariaDB Corporation, the MariaDB Foundation, and by numerous contributors from the global open source community.
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

There's been a lot of employment churn over years, Perhaps more accurate is something along these lines, though I'm not tied to the wording.

MariaDB is developed as open source by many developers in the community and the MariaDB Corporation (some of whom worked previously at MySQL). We attract a large number fo community contribution to enhance our codebase.


MariaDB is brought to you by the MariaDB Foundation and the MariaDB Corporation.
Please read the CREDITS file for details about the MariaDB Foundation,
and who is developing MariaDB.
MySQL, which serves as the original base of MariaDB, is a product and trademark of Oracle Corporation, Inc. For a list of developers and other contributors, see the Credits appendix. You can also run SHOW authors to get a list of active contributors.
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

Stronger emphasis on MariaDB"

draft:

MariaDB forked from MySQL (tm - Oracle Corporation), and has been developed as an independent fork since 2013. See the GitHub contributor statistics for an up to date representation of our code contributor community.

rational:

"independent fork" is Monty's term from https://monty-says.blogspot.com/2026/01/the-concepts-of-forking.html.
2013 is the rough times of the 10.0 release.


MariaDB is developed by many of the original developers of MySQL who
now work for the MariaDB Corporation, the MariaDB Foundation and by
many people in the community.

MySQL, which is the base of MariaDB, is a product and trademark of Oracle
Corporation, Inc. For a list of developers and other contributors,
see the Credits appendix. You can also run 'SHOW authors' to get a
list of active contributors.

A description of the MariaDB project and a manual can be found at:
A full description of the MariaDB project and its documentation can be found at:
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

Note KB links below are broken or redirectects. Can you update these?

If this is just a list covering installation and overview that would be find. There' s excessive focus on MySQL here.


https://mariadb.org

Expand All @@ -32,38 +20,36 @@ https://mariadb.com/kb/en/mariadb-versus-mysql-compatibility/

https://mariadb.com/kb/en/new-and-old-releases/

# Getting the code, building it and testing it
Getting the code, building it and testing it

Refer to the following guide:
https://mariadb.org/get-involved/getting-started-for-developers/get-code-build-test/

Refer to the following guide: https://mariadb.org/get-involved/getting-started-for-developers/get-code-build-test/
which outlines how to build the source code correctly and run the MariaDB testing framework,
as well as which branch to target for your contributions.
This guide outlines how to correctly clone and build the source code, run the MariaDB testing framework (MTR), and determine which branch to target for contributions.

# Help
Help
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

This was a Markdownfile, Why are the # header and line syntaxes being remove?


More help is available from the Maria Discuss mailing list
https://lists.mariadb.org/postorius/lists/discuss.lists.mariadb.org/ and MariaDB's Zulip
instance, https://mariadb.zulipchat.com/
More help is available from the Maria Discuss mailing list:
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

MariaDB* correction.

https://lists.mariadb.org/postorius/lists/discuss.lists.mariadb.org/

# Licensing
And MariaDB’s Zulip instance:
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

or something like https://mariadb.com/docs/general-resources/community/community/faq/getting-help-with-mariadb

https://mariadb.zulipchat.com/

***************************************************************************
Licensing

MariaDB is specifically available only under version 2 of the GNU
General Public License (GPLv2). (I.e. Without the "any later version"
clause.) This is inherited from MySQL. Please see the README file in
the MySQL distribution for more information.
MariaDB is specifically available only under version 2 of the GNU General Public License (GPLv2), without the "any later version" clause. This licensing model is inherited from MySQL.
Copy link
Member

@grooverdan grooverdan Mar 2, 2026

Choose a reason for hiding this comment

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

simplify:

MariaDB is specifically available only under version 2 of the GNU General Public License (GPLv2).


License information can be found in the COPYING file. Third party
license information can be found in the THIRDPARTY file.
Please see the README file in the MySQL distribution for additional background information.

***************************************************************************
Complete license information can be found in the COPYING file. Third-party license details are available in the THIRDPARTY file.

# Bug Reports
Bug Reports

Bug and/or error reports regarding MariaDB should be submitted at:
https://jira.mariadb.org

For reporting security vulnerabilities, see our [security-policy](https://mariadb.org/about/security-policy/).
For reporting security vulnerabilities, see the security policy:
https://mariadb.org/about/security-policy/

The code for MariaDB, including all revision history, can be found at:
https://github.com/MariaDB/server
The source code for MariaDB, including full revision history, is available at:
https://github.com/MariaDB/server