Update Contributing Document - 18 #908
Open
+56
−87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR updates the contributing guide.
Andriciuc
changed the title
nastena1606
reviewed
Jan 14, 2026
|
|
||
| 2. **[Contribute to documentation yourself](#contribute-to-documentation-yourself)**. Click the <img src="_resource/.icons/edit_page.png" style="width: 1em; height: 1em;"> **Edit this page** icon that leads you to the source file of the page on GitHub. There you make changes, create a pull request that we review and add to the doc project. For details how to do it, read on. | ||
| - Open the [Jira issue tracker](https://jira.percona.com/projects/PG/issues) for the project. | ||
| - (Optional but recommended) Search if the issue you want to report is already reported. |
Contributor
There was a problem hiding this comment.
You cannot search issues without logging in. Steps 2 and 3 should be replaced with one another
Contributor
There was a problem hiding this comment.
And I would split login and create actions into separate steps, TBH
nastena1606
reviewed
Jan 14, 2026
| To start contributing: | ||
|
|
||
| ### Edit documentation online via GitHub | ||
| 1. Click the **Edit this file** icon. |
nastena1606
reviewed
Jan 14, 2026
| cd postgresql-docs | ||
| ``` | ||
|
|
||
| 3. Change the directory to ``postgresql-docs`` and add your local repository: |
Contributor
There was a problem hiding this comment.
The intro message says add local repo while the command shows adding upstream repo. Please align the command with the step explanation
nastena1606
reviewed
Jan 14, 2026
| ```sh | ||
| docker run --rm -v $(pwd):/docs perconalab/pmm-doc-md mkdocs build | ||
| git add . | ||
| git commit -m "<my_fixes>" |
Contributor
There was a problem hiding this comment.
Suggested change
| git commit -m "<my_fixes>" | |
| git commit -m "PG-123-<my_fixes>" |
nastena1606
reviewed
Jan 14, 2026
| docker run --rm -v $(pwd):/docs perconalab/pmm-doc-md mkdocs build | ||
| git add . | ||
| git commit -m "<my_fixes>" | ||
| git push -u origin <my_branch_name> |
Contributor
There was a problem hiding this comment.
git push -u origin <my_branch_name>. Otherwise upstream repo is unaware of this change
nastena1606
reviewed
Jan 14, 2026
| This creates a single HTML page for the whole doc project. You can find the page at `site/print_page.html`. | ||
|
|
||
| 7. Open the `site/print_page.html` in your browser and save 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. | ||
| You can also view the site at <http://127.0.0.1:8000>. |
Contributor
There was a problem hiding this comment.
We have PDFs for PG docs. It makes sense to show how to create a PDF
nastena1606
reviewed
Jan 14, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the contributing guide.