We welcome your participation to help make the documentation better!
When you offer feedback, questions, edits, or new content, you help us, the projects you work on, and the EMQ X open source community.
To ensure consistency throughout all EMQ documentation, we ask that all contributors reference our Documentation Writing Guide. This guideline provides detailed instructions on document directory configuration and Markdown writing specifications.
EMQ X's documentation will be published at https://docs.emqx.io/. You can contribute documentation via the followings methods.
Note: The following methods require a GitHub account to operate. If you do not have a GitHub account, please click on the GitHub registration page to create one.
Clicking on Edit this page or Request docs changes on the top right corner of each page on the documentation site https://docs.emqx.io/ will take you directly to the Edit or Issue pages on the GitHub site, which means you don't need to know much about Git or even Markdown.
You can also directly access this page https://github.com/emqx/emqx-docs/issues of the documentation repository to submit an Issue for feedback questions of documentation.
This is similar to clicking Request doc changes on a published docs page, but if you manually file an issue you need to fill in links to the related pages.
As you can see above, when you click on Edit this page in the top right corner of the documentation site, you will be taken to the following page on GitHub, follow the instructions, and click Fork this repository.
Click Fork this repository to jump to the document editing page and then you can start editing your document. After completing editing, you need to enter the title and description of this submission at the bottom of the page to complete your submission.
You need to ensure that the title and description clearly describe what you are modifying.
Click on Propose changes above and you will be redirected to the following page, click on Create pull request to submit.
After you have jumped to the following page, confirm the pull request information and click Create pull request again to complete this submission.
Local editing requires contributors to have a good foundation in Git. We recommend that first-time contributors directly use the Online editing method above to contribute documents.
-
Open the document repository https://github.com/emqx/emqx-docs for Fork.
-
Clone the forked repository into local and then go to the local directory and add the upstream repository.
git remote add upstream https://github.com/emqx/emqx-docs.git -
Determine the branch of the contributed document and corresponding rules: latest correspond to develop branch, v4.1 correspond to release-4.1, v4.0 correspond to release-4.0, and so on.
-
Switch to the corresponding branch to edit, and commit to the Fork repository when you are done.
-
Create a Pull request from Fork's repository to the upstream repository.
Document projects will be automatically checked according to the rules in the Documentation Writing Guide, and only the PR that passes the check will be merged. If you encounter a markdownlint check failure when submitting PR, the error message will indicate which line in which file is the problem, so please follow the instructions to modify and update the PR.
If you encounter any problems when contributing to the documentation, you can contact us for getting help in the following methods.
-
Submit the GitHub Issue directly: https://github.com/emqx/emqx-docs/issues/new.