Skip to content

Commit 1a7dd4e

Browse files
PS-9776 [DOCS] Update the Contributing Guide with new instructions (#501)
modified: contributing.md
1 parent 162d7ff commit 1a7dd4e

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

contributing.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -150,4 +150,33 @@ The output is the following:
150150

151151
![Running MkDocs](docs/_static/mkdocs.png "Running MkDocs")
152152

153-
Open a browser and navigate to `http://127.0.0.1:8000/percona-server/8.0/` or `http://127.0.0.1:8000/percona-server/5.7/` to see the HTML files. You may need to navigate to the document that you have changed.
153+
Open a browser and navigate to `http://127.0.0.1:8000/percona-server/8.4/`, `http://127.0.0.1:8000/percona-server/8.0/` or `http://127.0.0.1:8000/percona-server/5.7/` to see the HTML files. You may need to navigate to the document that you have changed.
154+
155+
### Building the PDF documentation
156+
157+
To build the PDF documentation, open the `site/print_page.html` in your browser, for example, https://docs.percona.com/percona-server/8.4/print_page.html. 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.
158+
159+
## Repository structure
160+
161+
The repository includes the following directories and files:
162+
163+
- `mkdocs-base.yml` - the base configuration file. It includes general settings and documentation structure.
164+
- `mkdocs.yml` - configuration file. Contains the settings for building the docs with Material theme.
165+
- `mkdocs-pdf.yml` - configuration file. Contains the settings for building the PDF docs.
166+
- `docs`:
167+
- `*.md` - source markdown files.
168+
- `_static` - images, logos and favicons
169+
- `_templates` - the template for the PDF cover page
170+
- `css` - styles
171+
- `js` - Javascript files
172+
- `_resource`:
173+
- `templates`:
174+
- ``styles.scss`` - styling for PDF documents
175+
- `theme`:
176+
- `main.html` - the layout template for hosting the documentation on Percona website
177+
- `overrides` - the folder with the customized templates
178+
- `_resourcepdf` - the folder with customized templates for PDF output
179+
- `.github`:
180+
- `workflows`:
181+
- `main.yml` - the workflow configuration for building documentation with a GitHub action. (The documentation is built with `mike` tool to a dedicated `publish` branch)
182+
- `site` - this is where the output HTML files are put after the build

0 commit comments

Comments
 (0)