中文版 | English
DCE 5.0 docsite is created with MkDocs. All pages are written in markdown. We use GitOps to control workflow and versions.
This docsite uses Pull Request (PR) to modify, translate, and manage all pages.
- Click
Fork
to create a fork - Run
git clone
to clone this fork to your computer - Edit one or more pages locally and preview it
- Run git commands, such as
git add
,git commit
, andgit push
, to submit your changes - Open a PR in this repo
- Successfully merge after reviewing, thanks.
Please read through writing style before any change.
- Install and run Docker
- Run
make serve
and preview your changes
See MkDocs documents to install。
- Install Poetry and Python 3.9+
- Configure Poetry:
poetry config virtualenvs.in-project true
- Enable venv:
poetry env use 3.9
- Configure Poetry:
- Install dependencies:
poetry install
- Run
poetry run mkdocs serve -f mkdocs.yml
in the repo folder locally - Preview with http://127.0.0.1:8000/
- Indent 4 spaces for bullets
- Provide a space between zh and en chars
- Provide a blank line before and after a para, an image, a heading, or a list
- Do not add any punctuation by the end of a heading
- Care about links to avoid any null or dead link
- Give a consistent experience to explore all pages herein
We sincerely thank all the contributors who contribute to DaoCloud docsite. Once a PR you opened have been successfully merged, your ID will appear at the bottom of the page as an author.
If any problem, feel free to reach out to us: [email protected]