Help With MariaDB Docs

Know stuff about databases and SQL? Then we could use your help on the Knowledgebase for MariaDB. MariaDB is a community-developed fork of the popular MySQL database (now owned by Oracle). A top-notch database deserves top-notch documentation, and a community project needs contributors like you and me.

Getting involved is easy. Just create an account or log in with your existing OpenID account. Then pick a page and start editing. And don’t forget to keep in touch. Join the #maria channel on Freenode, and join the Maria Docs group and mailing list on Launchpad. Don’t forget to introduce yourself!

We’re working on getting a public TODO list online to make it easier to contribute. Until then, here’s a short list of things you can help with:

  • CREATE TABLE
    • Add a section about PRIMARY KEY. Include a brief description of what it does. Provide a reference for both the PRIMARY KEY keyword on a single column and defining multi-column keys.
    • Add a section about FOREIGN KEY and REFERENCES. Include a brief description of what it does. Provide a reference for both the REFERENCES keyword on a single column and defining multi-column foreign keys.
    • Add a section about INDEX, including SPATIAL and FULLTEXT. (Should these have separate sections? It depends on how full the sections get.) It’s probably worth putting all the detailed information about indexes on the CREATE INDEX page and just link there from CREATE TABLE and ALTER TABLE.
    • Create a section describing TEMPORARY tables.
    • Write documentation for the various table options and the partition options. Some of these require more in-depth experience using MariaDB or MySQL.
  • CREATE EVENT
    • Explain the various SCHEDULE options thoroughly, possibly with examples.
    • Explain the time units.
    • Explain the ON COMPLETION, ENABLE, and DISABLE keywords.
  • CREATE DATABASE
    • Write documentation about CHARACTER SET and COLLATE.

This is just a sampling of a few easy places to get involved. I have more; ping me (shaunm) on IRC. Or leave a comment here.

Creative Commons Attribution 3.0 United States
This work by Shaun McCance is licensed under a Creative Commons Attribution 3.0 United States.