/daodocs

DaoCloud Docs for your reference

Primary LanguagePythonApache License 2.0Apache-2.0

DaoCloud Enterprise 5.0 Documentation

Contributors Build

中文版 | English

DaoCloud is a Certified Kubernetes Service Provider (KCSP). DCE has been certified with the following releases:

Current releases:

1.23 1.24 1.25

Legacy releases:

1.7 1.9 1.13 1.15 1.18 1.20

DCE 5.0 website is created with MkDocs. All pages are written in markdown. We use GitOps to control workflow and versions.

Open a PR

This website uses Pull Request (PR) to modify, translate, and manage all pages.

  1. Click Fork to create a fork
  2. Run git clone to clone this fork to your computer
  3. Edit one or more pages locally and preview it
  4. Run git commands, such as git add, git commit, and git push, to submit your changes
  5. Open a PR in this repo
  6. Successfully merge after reviewing, thanks.

Preview locally

This section describes how you can preview your changes before commit.

With Docker

  1. Install and run Docker.
  2. Run make serve and preview your changes.

With Git repo

See MkDocs documents to install

  1. Install Poetry and Python 3.9+
    1. Configure Poetry: poetry config virtualenvs.in-project true
    2. Enable venv: poetry env use 3.9
  2. Install dependencies: poetry install
  3. Run poetry run mkdocs serve -f mkdocs.yml in the repo folder locally
  4. Preview with http://127.0.0.1:8000/

Tips about writing

  • 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

For more details refer to DaoCloud Style Guide of Writing.

Acknowledgements

We sincerely thank all the contributors who contribute to DaoCloud website. 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: support@daocloud.io or scan the QR code to chat with developers:

References

Release notes of this website

Release v1.0