How to contribute

Welcome to contribute to OpenCloudOS!

Contribute to OpenCloudOS

Contribute to the documentation

1. Fork the documentation repository

2. Clone the forked documentation repository to your local machine

   git clone git@gitee.com:yourname/OpenCloudOS/Document.git # (1)
   

   1. (You need to replace yourname with your own GitHub username)

3. Configure the environment

   • Install Python 3.x
   • Install mkdocs-material and multi langual plugin

   pip install mkdocs-material mkdocs-static-i18n
   

   • Run the preview server locally

   mkdocs serve
   

4. Start contributing!

   • Refer to mkdocs-material's documentation for more details about markdown and the features supported by this documentation site.
   • Please follow the format guide of this documentation site.

5. Verify if the content and format are correct through the preview server, and then commit your changes.

6. Submit a Pull Request to the documentation repository, and it will be merged after being reviewed.