Skip to content

Commit bd6ef40

Browse files
authored
CLOUD-816 Update CONTRIBUTING.md (#1378)
* wrong info about docs * adding information about container images
1 parent 662d167 commit bd6ef40

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,19 @@ Contributions to the source tree should follow the workflow described below:
4848

4949
### 2. Contributing to documentation
5050

51-
The workflow for documentation is similar. Please take into account a few things:
51+
The workflow for documentation is similar, but we store source code for the Percona Operator for MongoDB documentation in a [separate repository](https://github.com/percona/k8spsmdb-docs). See the [Documentation Contribution Guide](https://github.com/percona/k8spsmdb-docs/blob/main/CONTRIBUTING.md) for more information.
5252

53-
1. All documentation is written using the [Sphinx engine markup language](https://www.sphinx-doc.org/). Sphinx allows easy publishing of various output formats such as HTML, LaTeX (for PDF), ePub, Texinfo, etc.
54-
2. We store the documentation as *.rst files in the [K8s-PSMDB-docs](https://github.com/percona/percona-server-mongodb-operator/tree/K8s-PSMDB-docs) branch of the Operator GitHub repository. The documentation is licensed under the [Attribution 4.0 International license (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
53+
### 3. Container images
5554

56-
After [installing Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) you can use `make html` or `make latexpdf` commands having the documentation branch as your current directory to build HTML and PDF versions of the documentation respectively.
55+
Find Operator Dockerfile in [build folder](build).
56+
57+
Our Operator uses various container images - databases, proxies, other. You can find the Dockerfiles in [percona-docker](https://github.com/percona/percona-docker) repository.
58+
59+
* Percona Server for MongoDB has various versions. Each version sits in its own folder. For example PSMDB v6 can be found here: [Dockerfiles for Percona Server for MongoDB v6](https://github.com/percona/percona-docker/tree/main/percona-server-mongodb-6.0)
60+
61+
Please note that `mongos` also uses PSMDB image.
62+
63+
* Percona Backup for MongoDB can be found here: [Dockerfiles for Percona Backup for MongoDB](https://github.com/percona/percona-docker/tree/main/percona-backup-mongodb)
5764

5865
## Code review
5966

0 commit comments

Comments
 (0)