Documentation contribution guide

    To contribute to MOSN’s documentation, you need to:

    This documentation is published in compliance with license.

    You can contribute to MOSN’s documentation in the following three ways:

    • To edit an existing topic, open the page with your browser, click Edit This Page on the upper-right side, edit the GitHub page that appears, and submit the modifications.
    • To make general edits, follow the procedure in .
    • To review an existing pull request (PR), follow the procedure in the Review PRs.

    To add content, you need to create a repository branch and submit a PR to the mater repository from the branch. Perform the following steps:

    1. Access the MOSN repository at GitHub https://github.com/mosn/mosn.io.
    2. Clone your fork to your computer and make modifications as required.
    3. Upload the modifications to your fork repository when you are ready to submit them to us.
    4. Go to the index page of your fork repository and click New pull request to submit a PR.

    You can directly comment on a PR. To add detailed comments, perform the following steps:

    1. Add detailed comments to the PR. If possible, directly add comments to the corresponding files and file lines.
    2. Provide suggestions to the PR authors and contributors in the comments as appropriate.
    3. Merge the PR after publishing the comments and reaching an agreement with the contributors.

    You can preview your PR online or run Hugo on your computer to access the MOSN website for real-time preview.

    This temporary website ensures normal page display after the PR is merged.

    Local preview

    In addition to online preview, you can also preview your PR with (the v0.55.5 extended version is recommended). You can run at the root directory of your code repository and then access with your browser.