Skip to content

jzhupup/DaoCloud-docs

This branch is 2246 commits behind DaoCloud/DaoCloud-docs:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

966f446 · Apr 8, 2024
Jan 30, 2024
Apr 8, 2024
Oct 30, 2023
Sep 15, 2022
Dec 23, 2022
Mar 7, 2024
Jan 4, 2024
Sep 17, 2022
Jan 17, 2024
Nov 16, 2022
Nov 10, 2022
Aug 31, 2022
Mar 1, 2024
Dec 15, 2023
Oct 11, 2023
Apr 14, 2023
Nov 16, 2023
Nov 16, 2023
Mar 31, 2023
Nov 30, 2023
Nov 29, 2023

Repository files navigation

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 maintained by K8s community:

1.25 1.26 1.27 1.28

Legacy versions that are no longer maintained by the K8s community but will continue to be maintained by DaoCloud's KLTS:

1.7 1.9 1.13 1.15 1.18 1.20 1.23 1.24

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://0.0.0.0:8000/

Naming conventions

This section lists some conventions about a file or folder name for your reference:

  • Only contain English lower cases and hyphens (-)
  • Do not contain any of these characters like:
    • Chinese chars
    • spaces
    • special chars like *, ?, \, /, :, #, %, ~, {, }
  • Connect words with a hyphen (-)
  • Keep short:up to 5 English words, avoid repetition, use abbreviations
  • Be descriptive: easy to understand and reflect the doc's subject
No Yes Why
ConfigName config-name Use small letters and hyphens
create secret create-secret No spaces in name
quick-start-install-online-install online-install Keep short
c-ws create-workspace Be descriptive
update_image update-image Connect words with hyphens

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.

References

Thanks to all contributors ❤

Proudly using Netlify

Netlify

Site Status
daocloud-docs Netlify Status

About

DaoCloud Enterprise Open Documents

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 87.4%
  • Shell 10.1%
  • Makefile 2.5%