Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
132 lines (90 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

132 lines (90 loc) · 5.49 KB

Contributing guide

Welcome to pg_stat_monitor - the Query Performance Monitoring tool for PostgreSQL! This guide explains how to contribute to the pg_stat_monitor documentation.

We welcome contributors from all users and the community. By contributing, you agree to the Percona Community code of conduct.

If you want to contribute code, see the Code contribution guide.

You can contribute to documentation in the following ways:

  1. Request documentation changes through Jira:
  • Open the Jira issue tracker for the project.
  • Sign in (create a Jira account if you don’t have one).
  • Click Create to create an issue.
  • (Optional but recommended) Search if the issue you want to report is already reported.
  • Select PostgreSQL PG in the Project dropdown and the work type.
  • Describe the issue in the Summary and Description fields. Optionally, you can also fill in the Steps To Reproduce and Affects Version fields.
  1. Contribute to documentation on GitHub.

Contribute directly on GitHub

To contribute to the documentation, basic familiarity with the following tools is useful:

  • Markdown. The documentation is written in Markdown.
  • MkDocs documentation generator. We use it to convert source .md files to html and PDF documents.
  • git and [GitHub]

pg_stat_monitor documentation is written in Markdown language, so you can edit it online via GitHub. If you wish to have more control over the doc process, jump to how to edit documentation locally.

The doc files are located in the docs directory.

Edit documentation online via GitHub

  1. Click the Edit this page icon next to the page title. The source .md file of the page opens in GitHub editor in your browser. If you haven’t worked with the repository before, GitHub creates a fork of it for you.
  2. Edit the page. You can check your changes on the Preview tab.
  3. Commit your changes.
    • In the Commit changes section, describe your changes.
    • Select the Create a new branch for this commit and start a pull request option
    • Click Propose changes.
  4. GitHub creates a branch and a commit for your changes. It loads a new page on which you can open a pull request to Percona. The page shows the base branch - the one you offer your changes for, your commit message and a diff - a visual representation of your changes against the original page. This allows you to make a last-minute review. When you are ready, click the Create pull request button.
  5. Someone from our team reviews the pull request and if everything is correct, merges it into the documentation. Then it gets published on the site.

Edit documentation locally

If you want to work on your computer locally, follow these steps:

  1. Fork this repository
  2. Clone the repository on your machine:
git clone git@github.com:<your_name>/pgsm-docs.git
cd pgsm-docs
  1. Add the upstream (Percona) repository as a remote:
git remote add upstream git@github.com:percona/pgsm-docs.git
  1. Pull the latest changes
git fetch upstream
git merge upstream/main
  1. Create a separate branch for your changes. If you work on a Jira issue, please follow this pattern for a branch name: <PG-123>-short-description:
git checkout -b <PG-123>-short-description upstream/<target-branch>
  1. Make a commit mentioning the Jira issue in the commit message if any:
git add .
git commit -m "PG-123-<my_fixes>"
git push -u origin <my_branch_name>
  1. Open a pull request to Percona

Building the documentation

To verify how your changes look, generate the static site with the documentation. This process is called building.

NOTE Learn more about the documentation structure in the Repository structure section.

To verify how your changes look, you can generate a static site locally:

  1. Install pip
  2. Install MkDocs.
  3. Install all the required dependencies:
pip install -r requirements-doc.txt
  1. While in the root directory of the documentation project, run the following command to build the documentation:
mkdocs build
  1. Go to the site directory and open the index.html file in your web browser to see the documentation.
  2. To automatically rebuild the documentation and reload the browser as you make changes, run the following command:
mkdocs serve

  1. To build the PDF documentation, do the following:

     mkdocs build

This creates a single HTML page for the whole doc project. You can find the page in the site/print_page.html directory.

  1. Open the site/print_page.html in your browser and save as PDF. Depending on the browser, you may need to select the Export to PDF, Print - Save as PDF or just Save and select PDF as the output format.