From 08ec193c53f558936b2ec92e969bb55813a251cf Mon Sep 17 00:00:00 2001 From: Loan <60392721+loan75@users.noreply.github.com> Date: Thu, 17 Aug 2023 14:33:37 +0200 Subject: [PATCH 1/2] Create document-convention.en.md --- docs/reference/document-convention.en.md | 278 +++++++++++++++++++++++ 1 file changed, 278 insertions(+) create mode 100644 docs/reference/document-convention.en.md diff --git a/docs/reference/document-convention.en.md b/docs/reference/document-convention.en.md new file mode 100644 index 000000000..2c8e92923 --- /dev/null +++ b/docs/reference/document-convention.en.md @@ -0,0 +1,278 @@ +# document specification + +In order to ensure a consistent document style, please follow the following style guidelines when submitting documents. + +## Punctuation + +All punctuation in the text content in Chinese documents should use Chinese format punctuation, and all text content in English documents should use English punctuation. + + + + + +
BadGood
+ +Here is a one-click installation script that can help you quickly install a highly available, production-ready container network. + + + +Here is a one-click installation script that can help you quickly install a highly available, production-ready container network. + +
+ +English numbers and Chinese characters should be separated by spaces. + + + + + +
BadGood
+ +Kube-OVN provides a one-click installation script to install version 1.10 of Kube-OVN. + + + +Kube-OVN provides a one-click installation script to install version 1.10 of Kube-OVN. + +
+ +Example content should start with `:`, other sentences should end with `. ` End. + + + + + +
BadGood
+ +Please confirm that the environment configuration is correct before installation + +Download the installation script using the command below. + +```bash +wget 127.0.0.1 +``` + + + +Please confirm that the environment configuration is correct before installation. + +Download the installation script using the following command: + +```bash +wget 127.0.0.1 +``` + +
+ +## code block + +yaml code blocks need to be identified as yaml. + + + + + +
BadGood
+ +`````markdown +```` +apiVersion: kubeovn.io/v1 +kind: Subnet +metadata: + name: attach-subnet +```` +````` + + + +`````markdown +````yaml +apiVersion: kubeovn.io/v1 +kind: Subnet +metadata: + name: attach-subnet +```` +````` + +
+ +Command-line manipulation example code blocks need to be identified as bash. + + + + + +
BadGood
+ +`````markdown +```` +wget 127.0.0.1 +```` +````` + + + +`````markdown +````bash +wget 127.0.0.1 +```` +````` + +
+ +If the command line operation example contains output content, the executed command needs to start with `#` to distinguish input from output. + + + + + +
BadGood
+ +```bash +oilbeater@macdeMac-3 ~ ping 114.114.114.114 -c 3 +PING 114.114.114.114 (114.114.114.114): 56 data bytes +64 bytes from 114.114.114.114: icmp_seq=0 ttl=83 time=10.429 ms +64 bytes from 114.114.114.114: icmp_seq=1 ttl=79 time=11.360 ms +64 bytes from 114.114.114.114: icmp_seq=2 ttl=76 time=10.794 ms + +--- 114.114.114.114 ping statistics --- +3 packets transmitted, 3 packets received, 0.0% packet loss +round-trip min/avg/max/stddev = 10.429/10.861/11.360/0.383 ms +``` + + + +```bash +# ping 114.114.114.114 -c 3 +PING 114.114.114.114 (114.114.114.114): 56 data bytes +64 bytes from 114.114.114.114: icmp_seq=0 ttl=83 time=10.429 ms +64 bytes from 114.114.114.114: icmp_seq=1 ttl=79 time=11.360 ms +64 bytes from 114.114.114.114: icmp_seq=2 ttl=76 time=10.794 ms + +--- 114.114.114.114 ping statistics --- +3 packets transmitted, 3 packets received, 0.0% packet loss +round-trip min/avg/max/stddev = 10.429/10.861/11.360/0.383 ms +``` + +
+ +If the command line operation example only contains execution commands and no output results, multiple commands do not need to start with `#`. + + + + + +
BadGood
+ +```bash +# mv /etc/origin/ovn/ovnnb_db.db /tmp +# mv /etc/origin/ovn/ovnsb_db.db /tmp +``` + + + +```bash +mv /etc/origin/ovn/ovnnb_db.db /tmp +mv /etc/origin/ovn/ovnsb_db.db /tmp +``` + +
+ +## Link + +Links in the site use the corresponding `md` file path. + + + + + +
BadGood
+ +```markdown +Please refer to [Preparation](http://kubeovn.github.io/prepare) before installation. +``` + + + +```markdown +Please refer to [Preparation](./prepare.md) before installation. +``` + +
+ + + + + +
BadGood
+ +```markdown +If you have any questions, please refer to [Kubernetes Documentation](http://kubernetes.io). +``` + + + +```markdown +If you have any questions, please refer to [Kubernetes Documentation](http://kubernetes.io){: target="_blank" }. +``` + +
+ +## Empty line + +Different logical blocks, such as title and text, text and code, text and number need to be separated by blank lines. + + + + + +
BadGood
+ +````markdown +Download the script below to install it: +```bash +wget 127.0.0.1 +``` +```` + + + +````markdown +Download the script below to install it: + +```bash +wget 127.0.0.1 +``` +```` + +
+ +Separate logical blocks with only *one* blank line. + + + + + +
BadGood
+ +````markdown +Download the script below to install it: + + + +```bash +wget 127.0.0.1 +``` +```` + + + +````markdown +Download the script below to install it: + +```bash +wget 127.0.0.1 +``` +```` + +
From e1baaf9233cc31aa5dce043012eb0717fedd5f21 Mon Sep 17 00:00:00 2001 From: Loan <60392721+loan75@users.noreply.github.com> Date: Fri, 18 Aug 2023 09:57:40 +0200 Subject: [PATCH 2/2] fix type --- docs/reference/document-convention.en.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/document-convention.en.md b/docs/reference/document-convention.en.md index 2c8e92923..22b9073a4 100644 --- a/docs/reference/document-convention.en.md +++ b/docs/reference/document-convention.en.md @@ -1,4 +1,4 @@ -# document specification +# Document Specification In order to ensure a consistent document style, please follow the following style guidelines when submitting documents. @@ -64,7 +64,7 @@ wget 127.0.0.1 -## code block +## Code Block yaml code blocks need to be identified as yaml. @@ -218,7 +218,7 @@ If you have any questions, please refer to [Kubernetes Documentation](http://kub -## Empty line +## Empty Line Different logical blocks, such as title and text, text and code, text and number need to be separated by blank lines.