Contributing Documentation

Instructions on how to contribute to MariaDB documentation

The documentation for MariaDB products is

• written in standard American English,

• using Markdown format,

• stored in Git.

While the documentation is mainly maintained by the documentation team at MariaDB plc, we are happy to get contributions. Being stored in Git, it allows anyone to contribute to the documentation. You need a GitHub account, a basic knowledge of Markdown, and some expertise in what you’re writing about. You also have to agree to our contributor agreement.

Contributing is as simple as this:

• Access this repository, log in with your GitHub account.

• Find the page in the documentation that you want to edit, correct, or amend.

• Make a pull request, edit, and submit.

The MariaDB documentation team will review your edits, smooth out any rough edges (language and style), and incorporate your contribution into the documentation. Don’t be afraid to submit imperfect contributions, as long as they’re factually correct.

Before you start making larger contributions, make yourself familiar with the basics of technical writing (a 1-minute read). This is about using proper tone and content, language and grammar, as well as formatting, punctuation, and organization.

The source format of pages is Markdown. How to format text is on this GitBook page. A Markdown cheat sheet with a 10-minute tutorial and a Markdown "playground" can be found here.

Read our style guide, too. (It's short!)