Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (108 loc) · 7.36 KB

CONTRIBUTING.md

File metadata and controls

171 lines (108 loc) · 7.36 KB

Contributing guide

Welcome to Percona Backup for MongoDB documentation!

We're glad that you would like to become a Percona community member and participate in keeping open source open.

Percona Backup for MongoDB (PBM) is a distributed, low-impact solution for achieving consistent backups of MongoDB sharded clusters and replica sets.

This repository contains the source file for PBM documentation and this document explains how you can contribute to it.

If you'd like to submit a code patch, follow the Contributing guide in PBM code repository.

By contributing, you agree to the Percona Community code of conduct.

How to contribute

You can contribute to documentation in the following ways:

1. Request a doc change through a Jira issue

If you've spotted a doc issue (a typo, broken links, inaccurate instructions, etc.) but don't have time nor desire to fix it yourself - let us know about it.

  1. Click the Jira issue tracker in your browser.
  2. Sign in (create a Jira account if you don't have one).
  3. (Optional but recommended) Search if the issue you want to report is already reported.
  4. Click the Create issue shortcut to create an issue
  5. Select the Percona Backup for MongoDB in the Project dropdown and the issue type in the Issue Type dropdown. Click Next.
  6. Describe the issue you have detected in the Summary, Description, Steps To Reproduce, Affects Version fields.
  7. Click Create.

2. Leave your feedback

We'd like to hear from you. Click Rate this page and leave your feedback. We will appreciate you leaving your email so that we can reach out to you with clarifications or updates, if needed.

  1. Contribute to documentation yourself

Contributing to documentation

Percona Backup for MongoDB 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.

Before you start, learn what git, MkDocs and Docker are and what Markdown is and how to write it. For your convenience, there's also a cheat sheet to help you with the syntax.

The doc files are in the docs directory.

Edit documentation online via GitHub

  1. Click the Edit this page link on the sidebar. 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

This option is for users who prefer to work from their computer and / or have the full control over the documentation process.

The steps are the following:

  1. Fork this repository
  2. Clone the repository on your machine:
git clone git@github.com:<your_name>/pbm-docs.git
  1. Change the directory to pbm-docs and add the remote upstream repository:
git remote add upstream git@github.com:percona/pbm-docs.git
  1. Pull the latest changes from upstream
git fetch upstream
git merge upstream/main

Always pull the latest changes before you start editing the documentation.

  1. Create a separate branch for your changes. If there is a Jira ticket related to your contribution, name your branch in the following way: <Jira issue number>-<short description>. For example
git checkout -b PBM-123-My-fix

  1. Make changes. See the Repository structure for details what files this repo contains and their purpose.

  2. Check your changes. Some editors (Sublime Text, VSCode and others) have the Markdown preview which you can use to check how the page is rendered. Alternatively, you can build the documentation to know exactly how the documentation looks on the web site.

  3. Commit your changes. The commit message guidelines will help you with writing great commit messages

  4. 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.

Preconditions

  1. Install Python.

  2. Install MkDocs and required extensions:

    pip install -r requirements.txt

Build the site

  1. To build the site, run:

    mkdocs build

  2. Open site/index.html

Live preview

To view your changes as you make them, run the following command:

mkdocs serve

Paste the http://127.0.0.1:8000 in your browser and you will see the documentation. The page reloads automatically as you make changes.

PDF

To build the PDF documentation, open the site/print_page.html in your browser. Save it 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.

After your pull request is merged

Once your pull request is merged, you are an official Percona Community Contributor. Welcome to the community!

Repository structure

The repository includes the following directories and files:

  • mkdocs-base.yml - the base configuration file. It includes general settings and documentation structure.
  • mkdocs.yml - configuration file. Contains the settings for building the docs with the Material theme.
  • docs:
    • *.md - Source markdown files.
    • _images - Images, logos and favicons
    • _templates - The PDF cover page template
    • css - Styles
    • js - Javascript files
    • fonts - Fonts used in the docs
  • _resource - The set of Material theme templates with our customizations
    • .icons - Custom icons used in the documentation
    • overrides:
      • partials - The layout templates for various parts of the documentation such as header, copyright and others.
      • main.html - The layout template for hosting the documentation on Percona website
  • _resourcepdf - The set of Material theme templates with our customizations for PDF builds
  • site - This is where the output HTML files are put after the build