Skip to content

Commit 2c91785

Browse files
author
Alina Derkach
committed
PS 8417 Update Contributing.md and copy it to psmysql-docs
modified: README.md new file: contributing.md new file: docs/_static/new-topic.png
1 parent f331fd3 commit 2c91785

File tree

6 files changed

+155
-2
lines changed

6 files changed

+155
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can install Percona Server for MySQL using the following methods:
1212
- from the Percona repository
1313
- Build from the [source code](https://github.com/percona/percona-server)
1414

15-
The installation instructions in the official documentation are [here](https://www.percona.com/doc/percona-server/8.0/installation.html).
15+
The installation instructions in the official documentation are [here](https://docs.percona.com/percona-server/8.0/installation.html).
1616

1717
## Submit a bug report or a feature request
1818

@@ -31,7 +31,7 @@ Percona is dedicated to **keeping open source open**. Whenever possible, we stri
3131

3232
## How to get involved
3333

34-
We encourage contributions and are always looking for new members that are as dedicated to serving the community as we are. The [Contributing Guide](https://github.com/percona/percona-server/blob/8.0/doc/source/contributing.md) contains how you can contribute.
34+
We encourage contributions and are always looking for new members that are as dedicated to serving the community as we are. The [Contributing Guide](https://github.com/percona/psmysql-docs/blob/8.0/contributing.md) contains how you can contribute.
3535

3636
## Contact
3737

contributing.md

+153
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Documentation Contributing Guide
2+
3+
We welcome contributions from all users and the community. By contributing, you agree to the [Percona Community code of conduct](https://percona.community/contribute/coc/). Thank you for deciding to contribute and help us improve the [Percona Server documentation](https://docs.percona.com/percona-server/).
4+
5+
You can contribute to the documentation in either of the following ways:
6+
7+
- [Documentation Contributing Guide](#documentation-contributing-guide)
8+
- [Add a forum topic](#add-a-forum-topic)
9+
- [Request a change with a Jira issue](#request-a-change-with-a-jira-issue)
10+
- [Contribute to documentation yourself](#contribute-to-documentation-yourself)
11+
- [What you should know](#what-you-should-know)
12+
- [What happens after you create the pull request](#what-happens-after-you-create-the-pull-request)
13+
- [Edit documentation online with GitHub](#edit-documentation-online-with-github)
14+
- [Edit documentation locally](#edit-documentation-locally)
15+
- [Building the documentation](#building-the-documentation)
16+
17+
## Add a topic
18+
19+
In the [Percona Product Documentation category](https://forums.percona.com/c/percona-product-documentation/71) in the Percona Community Forum, select **New Topic**. Complete the form and select **Create Topic** to add the topic to the forum.
20+
21+
![Create a topic](docs/_static/new-topic.png "Create a topic")
22+
23+
## Request a change with a Jira issue
24+
25+
If you would rather not [contribute to the documentation yourself](#contribute-to-documentation-yourself), let us know about the issue by adding a Jira ticket. Use the following procedure to create a Jira ticket:
26+
27+
In the Contact Us section, select the link in "open a JIRA ticket"
28+
29+
![JIRA ticket](docs/_static/jira-ticket.png "JIRA ticket")
30+
31+
- In the `Contact Us` section, located at the bottom of the page, select the **open a JIRA ticket** link. This action opens the [Jira issue tracker](https://jira.percona.com/projects/PS/issues) for the doc project.
32+
33+
- Log in (create a Jira account if you don't have one) and select **Create** to open the Jira form.
34+
35+
![Complete the Jira form](docs/_static/create-issue.png "Complete the Jira form")
36+
37+
- In the following fields, describe the issue:
38+
- In the Summary, provide a brief description of the issue.
39+
- In the Description, provide more information about the issue. If needed, add a Steps To Reproduce section and information about your environment (version number, your operating system, etc.). Be detailed.
40+
- Select **CREATE** to create the ticket.
41+
42+
## Contribute to documentation yourself
43+
44+
Use either the [Edit documentation online with GitHub](#edit-documentation-online-with-github) method or the [Edit documentation locally](#edit-documentation-locally) method to make changes to the documentation and create a pull request.
45+
46+
### What you should know
47+
48+
Most of the document is in plain text, but you may use [Markdown](https://www.markdownguide.org/) to add syntax elements (notes, tables, and so on) to the documentation.
49+
50+
### What happens after you create the pull request
51+
52+
A core developer reviews your request and either comments or approves the request. A core developer merges the approved request to the **main** branch usually when a newer version of the product is released.
53+
54+
!!! note
55+
56+
We appreciate your work but the pull request may be redone to meet internal requirements.
57+
58+
### Edit documentation online with GitHub
59+
60+
Next to the page title, select the pencil icon to open the source file in the GitHub editor. In this editor, you can make the changes, view the changes in the Preview tab, and create a pull request. The source `.md` file of the page opens in a 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).
61+
62+
Edit the page using the [Markdown](https://www.markdownguide.org/) syntax.
63+
64+
You should review your changes on the **Preview** tab.
65+
66+
Commit your changes to a pull request.
67+
68+
In the **Commit changes** section, add a summary (72 characters or less) of what was changed.
69+
70+
Then select the **Create a new branch for this commit and start a pull request** option. Accept the name for the branch and then Select **Commit changes**.
71+
72+
GitHub creates a branch and a commit for your changes. The operation loads a page that shows the following:
73+
74+
- a base branch where you offer your changes
75+
76+
- your commit message
77+
78+
- a visual representation of your changes against the original page
79+
80+
Review the information and click **Create pull request**.
81+
82+
For more information, see [Editing files in GitHub](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files)
83+
84+
### Edit documentation locally
85+
86+
This option is for users who are comfortable with [git](https://git-scm.com/) commands.
87+
88+
The steps are the following:
89+
90+
1. Fork this repository.
91+
92+
2. Clone the forked repository to your machine:
93+
94+
```shell
95+
git clone [email protected]:<your_github_name>/proxysql-admin-tool-doc.git
96+
cd <directory name>/proxysql-admin-tool-doc
97+
```
98+
99+
3. Add the remote origin repository:
100+
101+
```shell
102+
git remote add origin https://github.com/percona/proxysql-admin-tool-doc.git
103+
```
104+
105+
4. Checkout the appropriate branch and pull the latest changes from origin:
106+
107+
```shell
108+
git checkout main && git pull origin main
109+
```
110+
111+
5. Create a separate branch for your changes:
112+
113+
```shell
114+
git checkout -b <my_changes>
115+
```
116+
117+
6. Work in the `/docs` directory. Add code examples, if necessary. We recommend that you check your changes using either a Preview built into your editor (if you have one) or [build HTML on your machine](#building-the-documentation).
118+
119+
7. Add the changed file:
120+
121+
```shell
122+
git add <changed file>
123+
```
124+
125+
8. Commit your changes:
126+
127+
```shell
128+
git commit -m 'Fixed typing error in <document name>'
129+
```
130+
131+
9. Open a pull request to Percona:
132+
133+
```shell
134+
git push <my repo> <my_changes>
135+
```
136+
137+
### Building the documentation
138+
139+
To verify your changes, you can use a MkDocs command to build HTML.
140+
141+
Follow the [MkDocs Installation](https://www.mkdocs.org/user-guide/installation/) instructions.
142+
143+
After the installation, in the root directory, run the following command to build the documentation:
144+
145+
```shell
146+
mkdocs serve
147+
```
148+
149+
The output is the following:
150+
151+
![Running MkDocs](docs/_static/mkdocs.png "Running MkDocs")
152+
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.

docs/_static/create-issue.png

160 KB
Loading

docs/_static/jira-ticket.png

78.5 KB
Loading

docs/_static/mkdocs.png

247 KB
Loading

docs/_static/new-topic.png

58.7 KB
Loading

0 commit comments

Comments
 (0)