MDEV-38935: Improved README with Detailed Project Overview and Documentation Links#4709
MDEV-38935: Improved README with Detailed Project Overview and Documentation Links#4709Tuppudukeerthana wants to merge 1 commit intoMariaDB:mainfrom
Conversation
|
|
grooverdan
left a comment
grooverdan
left a comment
There was a problem hiding this comment.
Thanks for addressing this. It was a bit messy, and still is in some ways.
While you have addressed many things, let's attempt to say:
- What MariaDB is?
- How to get MariaDB - https://mariadb.org/download/
- What MariaDB community is?
- How to get help?
*How to contribute?
In a concise manner.
| MariaDB: The innovative open source database | ||
|
|
||
| * [](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. |
There was a problem hiding this comment.
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 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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
| 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: |
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
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: |
| https://lists.mariadb.org/postorius/lists/discuss.lists.mariadb.org/ | ||
|
|
||
| # Licensing | ||
| And MariaDB’s Zulip instance: |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
simplify:
MariaDB is specifically available only under version 2 of the GNU General Public License (GPLv2).
gkodinov
added
the
External Contribution
gkodinov
changed the title
gkodinov
left a comment
gkodinov
left a comment
There was a problem hiding this comment.
Thank you for your contribution! This is a preliminary review.
Please keep working with Daniel on his review. Couple of extra points to address:
Please rebase this against 10.6: The README should be an unified document for all versions.
Please also add a commit message to your commit that complies with CODING_STYLE.md
4 participants
This update enhances the README file by providing a clearer and more structured overview of the MariaDB Server project.
Changes Made:
Improved overall project description
Added clear explanation of MariaDB and its purpose
Organized documentation and resource links
Updated build and contribution instructions section
Improved formatting for better readability
Purpose:
The goal of this update is to make the README more informative and beginner-friendly, helping contributors and users better understand the project structure, documentation resources, and contribution process.