Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PSMDB-1487 Updated Readme and Contributing guides for 8.0 #937

Open
wants to merge 2 commits into
base: 8.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributing Guide

Thank you for deciding to contribute and help us improve Percona Server for MongoDB documentation!
Expand Down Expand Up @@ -30,10 +29,12 @@ There are several active versions of the documentation. Each version has a branc

- 3.6 (EOL)
- 4.0 (EOL)
- 4.2
- 4.4
- 4.2 (EOL)
- 4.4 (EOL)
- 5.0
- 6.0
- 7.0
- 8.0

The .md files are in the ``docs`` directory.

Expand Down Expand Up @@ -78,7 +79,7 @@ git fetch upstream
git merge upstream/<branch>
```

Make sure that your local branch and the branch you merge changes from are the same. So if you are on ``6.0`` branch, merge changes from ``upstream/6.0``.
Make sure that your local branch and the branch you merge changes from are the same. So if you are on ``0.0`` branch, merge changes from ``upstream/8.0``.
nastena1606 marked this conversation as resolved.
Show resolved Hide resolved

5. Create a separate branch for your changes

Expand Down Expand Up @@ -129,21 +130,30 @@ The PDF document is in the ``site/pdf`` folder.

#### Install MkDocs and build locally

In order not to break your running workflows, it's recommended to install MkDocs in a virtual environment.

1. Install [pip](https://pip.pypa.io/en/stable/installing/)
2. Install [MkDocs](https://www.mkdocs.org/getting-started/#installation).
3. While in the root directory of the doc project, run the following command to build the documentation:
3. Install all required dependencies:

```sh
pip install -r requirements.txt
```

4. While in the root directory of the doc project, run the following command to build the documentation:

```sh
mkdocs build
```
4. Go to the ``site`` directory and open the ``index.html`` file in your web browser to see the documentation.
5. To automatically rebuild the documentation and reload the browser as you make changes, run the following command:

5. Go to the ``site`` directory and open the ``index.html`` file in your web browser to see the documentation.
6. To automatically rebuild the documentation and reload the browser as you make changes, run the following command:

```sh
mkdocs serve
```

6. To build the PDF documentation, do the following:
7. To build the PDF documentation, do the following:
- Install [mkdocs-with-pdf plugin](https://pypi.org/project/mkdocs-with-pdf/)
- Run the following command

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Percona Server for MongoDB is a free, enhanced, fully compatible, open source, d

The Percona Server for MongoDB code is [here](https://github.com/percona/percona-server-mongodb).

This repository contains the source files for [Percona Server for MongoDB documentation](https://docs.percona.com/percona-server-for-mongodb/6.0/). The documentation is written in [Markdown](https://www.markdownguide.org/basic-syntax/) and is created using [MkDocs Static Site Generator](https://https://www.mkdocs.org/getting-started/).
This repository contains the source files for [Percona Server for MongoDB documentation](https://docs.percona.com/percona-server-for-mongodb/8.0/). The documentation is written in [Markdown](https://www.markdownguide.org/basic-syntax/) and is created using [MkDocs Static Site Generator](https://https://www.mkdocs.org/getting-started/).

## Contributing

We welcome all contributors. For how to contribute to documentation, read the [Contributing guide](https://github.com/percona/psmdb-docs/blob/6.0/CONTRIBUTING.md).
We welcome all contributors. For how to contribute to documentation, read the [Contributing guide](https://github.com/percona/psmdb-docs/blob/8.0/CONTRIBUTING.md).

## License

Expand Down