Google Season of Docs 2019

MariaDB applied to participate in the first Google Season of Docs. Unfortunately, as a pilot project, Google were only able to accept a limited number of applications, and we were unsuccessful.

Where to Start

Please join us on Zulip to mingle with the community. You can also subscribe to maria-docs@lists.launchpad.net, the documentation mailing list.

List of Tasks

Stored Procedures Documentation

The Stored Procedures capabilities of MariaDB Server are critical to producing large-scale applications. The current documentation lacks sufficient examples, and the examples warrant testing. Getting Started content would make this easier to adopt. MariaDB's implementation is based on ISO SQL/PSM.

Getting Started with Connector/C and Connector/J

MariaDB Connector/C and MariaDB Connector/J provide the ability to access a MariaDB Server from applications built in C/C++ and Java, respectively. The current documentation for these connectors lacks Getting Started guides.

Spider Documentation

The Spider Storage Engine uses partitioning to provide data sharding through multiple servers. This task involves greatly expanding the existing documentation, including more detail about when to use Spider, basic usage, updating the Spider Feature Matrix, detailed examples of the effects of the server system variables and table system variables, as well as the Spider functions. You will also ensure changes in the most recent Spider releases are properly documented.

Mroonga Documentation

Mroonga is a full text search storage engine based on Groonga, which is an open-source CJK-ready fulltext search engine using column base. This project involves greatly expanding the existing MariaDB documentation on the use of this storage engine. A detailed tutorial and user guide, including examples of the various Mroonga user-defined functions, system variables and the effects of changing their settings, as well as the parser and parser settings.

Translation

You will choose a major language and ensure that a substantial subsection of the documentation is translated into that language. See translations.

Migration Documentation

You will choose a major relational DBMS, and, focusing on the most recent stable releases, document the process to migrate to MariaDB, including MariaDB equivalents to features in that system, and a detailed list of features that exist in one but not the other, as well as possible workarounds. For an example, see the documentation on migrating from MySQL to MariaDB (bearing that MariaDB is a MySQL fork, and is substantially more similar to MySQL than to other systems).

Suggest a Task

Do you have an idea of your own, not listed above? Do let us know!

Comments

Comments loading...