Percona Monitoring and Management (PMM) Documentation

Here are documentation source files for Percona Monitoring and Management, a free, open-source, database monitoring solution.

Note

This repository is for Percona Monitoring and Management version 2.

We welcome any contributions. This page explains how you can do that, and how to build a local copy of the documentation.

The documentation consists of Markdown files in the docs directory. We use MkDocs to convert these into a static HTML website.

Build the documentation

First

Clone this repository.
cd pmm-doc

With Docker

Install Docker.
docker run --rm -v $(pwd):/docs perconalab/pmm-doc-md
Open site/index.html in a browser to view the first page of documentation.

Tip

Documentation built this way has no styling because it is intended for hosting on percona.com. You can build a themed version for local viewing by changing the command in step 3 to:

docker run --rm -v $(pwd):/docs perconalab/pmm-doc-md mkdocs build -t material

Alternatively, you can use the MkDocs built-in web server to live preview local edits:

docker run --rm -v $(pwd):/docs -p 8000:8000 perconalab/pmm-doc-md mkdocs serve -t material --dev-addr=0.0.0.0:8000

and point your browser to http://localhost:8000.

Without Docker

Install Python 3
Install MkDocs and required extensions:
```
 pip install -r requirements.txt
```
Start the site:
```
 mkdocs serve -t material
```
View the site: visit http://localhost:8000

How to Contribute

You can change documentation yourself, or ask us to do it.

Option 1: Do it yourself

Each page of PMM 2 documentation has a link to the .md version of the page.
Click the link to be taken to the github edit page.
Make your changes and commit. Unless you are a member of the Percona team, you'll be asked to fork the repository.
Do so and make a pull request for merging your changes.

Option 2: Ask us

Create a ticket in our Jira system.
Describe the problem or improvement needed in as much detail as possible, by providing, for example:
- links to the relevant pages or sections;
- explaining what is wrong and why;
- suggesting changes or links to sources of further information.
You can use Jira to communicate with developers and technical writers, and be notified of progress.

cezmunsta/pmm-doc