代码拉取完成，页面将自动刷新
同步操作将从 openGauss/docs 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
Before you start, NOTICE that master branch is development version. stable branch
provided for customers and users. So all code modifications SHOULD be submitted to
master branch, stable branch won't accept any commits.
This repository is integrated by website which will provide the final outline, so please only maintain docs in this repository. anything others like styles, js are maintained in website as a combined hugo theme.
Contents organized by hugo book which is a framework helping build our own book. please refer to hugo book website for more detailed information.
All files are written with MarkDown syntax, please note: If you want to add internal links, be careful to point to the .html pages corresponding to the .md pages of the folder.
This doc only provides running test on linux, please prepare linux server before running following commands.
hugo can be installed easily after nodejs is ready.
curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_0.56.3_Linux-64bit.tar.gz | tar -xz && \
mv hugo /usr/local/bin/
hugo serve --bind 0.0.0.0 --port 80 --baseUrl /
The website will serving on http://your-server-ip:80
docker build -t docs:v0.0.1 .
note: here docs is the image name, you can change it as you need.
docker run -p 80:80 -d docs:v0.0.1 > docs.pid
The website will serving on http://your-server-ip:80
docker rm -f `cat docs.pid` && rm -f docs.pid
Note: The defalut language(en) will serving on http://your-server-ip/ Other language(zh) will serving on http://your-server-ip/zh
Before openning a PR, running locally and have a check would be good step that will help your commits be merged quickly.
There are two kinds of Markdown file, one is the content files which locates in content/docs folder.
the other one is the menu file which locates in content/menu folder. please remember to update menu if
adding new file.
Note: menu file home file name must be named home.md.
A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report and feature propose, and will thank you for it!
When reporting issues, refer to this format:
See more about ISSUE_TEMPLATE.
If you are a beginner and expect this project as the gate to open source world, this tutorial is one of the best choices for you. Just follow the guidance and you will find the pleasure to becoming a contributor.
Before making modifications of this project, you need to make sure that this project have been forked to your own repository. It means that there will be parallel development between this repo and your own repo, so be careful to avoid the inconsistency between these two repos.
If you want to download the code to the local machine, git is the best way:
git clone https://your_repo_url/projectname.git
To avoid inconsistency between multiple branches, we SUGGEST checking out to a new branch:
git checkout -b new_branch_name origin/master
Then you can change the code arbitrarily.
After updating the code, you should push the update in the formal way:
git add .
git status (Check the update status)
git commit -m "Your commit title"
git commit --amend (Add the concrete description of your commit)
git push origin new_branch_name
In the last step, your need to pull a compare request between your new branch and development branch. After finishing the pull request, the CI will be automatically set up for building test.
When submitting pull requests, refer to this format:
See more about PULL_REQUEST_TEMPLATE.
TO BE DEFINED
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。