You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-27Lines changed: 12 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ You can contribute to documentation in the following ways:
17
17
18
18
## Contribute to documentation yourself
19
19
20
-
Percona Distribution for PostgreSQL documentation is written in [Markdown](https://www.markdownguide.org/basic-syntax/) language, so you can
20
+
Percona Distribution for MongoDB documentation is written in [Markdown](https://www.markdownguide.org/basic-syntax/) language, so you can
21
21
[edit it online via GitHub](#edit-documentation-online-vi-github). If you wish to have more control over the doc process, jump to how to [edit documentation locally](#edit-documentation-locally).
22
22
23
23
To contribute to the documentation, you should be familiar with the following technologies:
@@ -28,18 +28,15 @@ To contribute to the documentation, you should be familiar with the following te
28
28
29
29
There are several active versions of the documentation. Each version has a branch in the repository named accordingly:
30
30
31
-
- 3.6 (EOL)
32
-
- 4.0 (EOL)
33
-
- 4.2
34
-
- 4.4
35
-
- 5.0
36
31
- 6.0
32
+
- 7.0
33
+
- 8.0
37
34
38
35
The .md files are in the ``docs`` directory.
39
36
40
37
### Edit documentation online via GitHub
41
38
42
-
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](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) of it for you.
39
+
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](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) of it for you.
43
40
44
41
2. Edit the page. You can check your changes on the **Preview** tab.
45
42
@@ -49,7 +46,7 @@ The .md files are in the ``docs`` directory.
49
46
- Select the **Create a new branch for this commit and start a pull request** option
50
47
- Click **Propose changes**.
51
48
52
-
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.
49
+
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.
53
50
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.
docker run --rm -p 8000:8000 -v $(pwd):/docs perconalab/pmm-doc-md mkdocs serve -a 0.0.0.0:8000
120
117
```
121
118
122
-
5. To create a PDF version of the documentation, run the following command:
119
+
Paste the 0.0.0.0:8000 in your browser and you will see the documentation. The page reloads automatically as you make changes.
123
120
124
-
```sh
125
-
docker run --rm -v $(pwd):/docs perconalab/pmm-doc-md mkdocs build -f mkdocs-pdf.yml
126
-
```
121
+
The doc project also includes a single-page HTML output for a PDF document. It is accessible at the `0.0.0.0:8000/percona-server-for-mongodb/print_page.html`.
127
122
128
-
The PDF document is in the ``site/pdf`` folder.
123
+
Save this page as a 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.
129
124
130
125
#### Install MkDocs and build locally
131
126
@@ -143,34 +138,24 @@ mkdocs build
143
138
mkdocs serve
144
139
```
145
140
146
-
6. To build the PDF documentation, do the following:
6. 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.
153
142
154
-
The PDF document is in the ``site/pdf`` folder.
155
143
156
144
## Repository structure
157
145
158
146
The repository includes the following directories and files:
159
147
160
148
-`mkdocs-base.yml` - the base configuration file. It includes general settings and documentation structure.
161
149
-`mkdocs.yml` - configuration file. Contains the settings for building the docs with Material theme.
162
-
-`mkdocs-pdf.yml` - configuration file. Contains the settings for building the PDF docs.
163
150
-`docs`:
164
151
-`*.md` - Source markdown files.
165
152
-`_images` - Images, logos and favicons
153
+
-`_templates` - The template for the PDF cover page
166
154
-`css` - Styles
167
155
-`js` - Javascript files
168
156
-`_resource`:
169
-
-`templates`:
170
-
-``styles.scss`` - Styling for PDF documents
171
-
-`theme`:
172
-
-`main.html` - The layout template for hosting the documentation on Percona website
173
-
- overrides - The folder with the Material theme template customization for builds
157
+
- overrides - The folder with the Material theme template customization for HTML builds
158
+
-`_resourcepdf` - The folder with customized templates for PDF output
174
159
-`.github`:
175
160
-`workflows`:
176
161
-`main.yml` - The workflow configuration for building documentation with a GitHub action. (The documentation is built with `mike` tool to a dedicated `publish` branch)
This file was automatically generated - do not edit
3
+
-#}
4
+
{% extends "main.html" %}
5
+
{% block content %}
6
+
<h1>404 - Not found</h1>
7
+
<p>
8
+
We can't find the page you are looking for. Try using the Search or <ahref= "{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"> return to homepage </a>. </p>
<ahref="https://learn.percona.com/download-percona-server-mongodb-7-0-manual" onclick="_gaq.push(['b._trackEvent', 'Percona Server for MongoDB 6.0', 'Download', 'Download Manual Server for MongoDB 6.0']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;">
44
+
Download PDF
45
+
</a>
46
+
</label>
47
+
</div>
48
+
</div>
49
+
</div>
50
+
{% endif %}
51
+
{% if "toc.integrate" not in features %}
52
+
{% if page.meta and page.meta.hide %}
53
+
{% set hidden = "hidden" if "toc" in page.meta.hide %}
0 commit comments