From a856b9ae0bb2a4cda7a1bc4010b712bbd26eacd0 Mon Sep 17 00:00:00 2001 From: lshelen23 Date: Fri, 29 Oct 2021 07:09:24 +0000 Subject: [PATCH 1/2] Optimized README-en.md --- README-en.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README-en.md b/README-en.md index bda49b404..eaa8fcc68 100644 --- a/README-en.md +++ b/README-en.md @@ -4,12 +4,12 @@ English | [简体中文](./README.md) ### Introduction -DOCS contains all documents of the openEuler community, including the release notes, OS installation guide, administrator guide, virtualization, container, A-Tune user guides and application development guide. +DOCS contains all documents of the openEuler community, including the release notes, OS installation guide, administrator uide, virtualization, container, and A-Tune user guides, and application development guide. ### Searching for a Document in DOCS -Open the **docs** folder. The folder contains documents in Chinese (**zh** folder) and English (**en** folder). The English document is used as an example. In the **en** folder, the **docs** folder contains the content of a specific document, and the **menu** folder contains the overview of the document. -Open the **docs** folder. The relationship between guides and folders is as follows: +Open the **docs** folder. The folder contains documents in Chinese (**zh** folder) and English (**en** folder). For example, in the **en** folder, the **docs** folder contains different documents, and the **menu** folder displays the list of documents. +Open the **docs** folder. You can see sub-folders, each with relevant documents inside. The following table shows an example of what the sub-folders may contain: | folder | Content | |-----|-----| @@ -18,8 +18,8 @@ Open the **docs** folder. The relationship between guides and folders is as foll | **ApplicationDev** | *Application Development Guide* | | **Container** | *Container User Guide* | | **Installation** | *Installation Guide* | -| **Quickstart** | *Quick Start* -| **Releasenotes** | *Release Notes* +| **Quickstart** | *Quick Start* | +| **Releasenotes** | *Release Notes* | | **SecHarden** | *Security Hardening Guide* | | **Virtualization** | *Virtualization Application Guide* | | **userGuide** | *openEuler Toolset User Guide* | @@ -28,10 +28,10 @@ Open the **docs** folder. The relationship between guides and folders is as foll ### Modifying a Document -When the openEuler version information is updated, the documents herein also need to be updated. Thank you for providing updates. +When the openEuler version information is updated, the documents here also need to be updated. Thank you for providing updates. ### Checking the Relationship Between Versions and Branches -The DOCS contains the following four branches: +Before performing updates, you need to first make sure the branch you choose is in consistant with the updated version. The DOCS contains the following four branches: | Branch | Description | Documentation | |--------|-------------|---------------| @@ -40,19 +40,19 @@ The DOCS contains the following four branches: | **stable2-20.03\_LTS** | 20.03 LTS version branch | **DOCS** > **20.03 LTS** on the [openEuler community website](https://openeuler.org/) | | **stable2-20.09** | 20.09 version branch | **DOCS** > **20.09** on the [openEuler community website](https://openeuler.org/) | -### Participating in SIG -Create or reply to an issue: You can discuss an issue by creating or replying to an issue. +### Participation +Create or reply to an issue: You can discuss with us by creating or replying to an issue. Submit a Pull Request (PR): You can participate in SIG by submitting a PR. -Submit comments: You can submit comments on issues or PRs. You can also comment on the document through **Feedback** on the website document page. -We are always pleased to receive PRs from you. +Make a comment: You can submit comments on issues or PRs. You can also comment on the document through **Feedback** on the [website document page](https://docs.openeuler.org/en/). +Welcome to submit PRs. ### Member -#### Maintainer List +#### Maintainers - Rudy_Tan[@rudy_tan](https://gitee.com/rudy_tan) - amyMaYun[@amy_mayun](https://gitee.com/amy_mayun) - qiaominna[@qiaominna](https://gitee.com/qiaominna) ### Contacting Us -E-mails: doc@openeuler.org +E-mail: doc@openeuler.org IRC: #openeuler-doc \ No newline at end of file -- Gitee From 7135b951b8a432d4a9a2e7728f2ac3c511e3b2ff Mon Sep 17 00:00:00 2001 From: lshelen23 Date: Fri, 29 Oct 2021 07:10:49 +0000 Subject: [PATCH 2/2] Optimized --- README-en.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README-en.md b/README-en.md index eaa8fcc68..be81167d7 100644 --- a/README-en.md +++ b/README-en.md @@ -8,10 +8,10 @@ DOCS contains all documents of the openEuler community, including the release no ### Searching for a Document in DOCS -Open the **docs** folder. The folder contains documents in Chinese (**zh** folder) and English (**en** folder). For example, in the **en** folder, the **docs** folder contains different documents, and the **menu** folder displays the list of documents. -Open the **docs** folder. You can see sub-folders, each with relevant documents inside. The following table shows an example of what the sub-folders may contain: +1. Open the **docs** folder. The folder contains documents in Chinese (**zh** folder) and English (**en** folder). For example, in the **en** folder, the **docs** folder contains different documents, and the **menu** folder displays the list of documents. +2. Open the **docs** folder. You can see sub-folders, each with relevant documents inside. The following table shows an example of what the sub-folders may contain: -| folder | Content | +| Folder | Content | |-----|-----| | **A-Tune** | *A-Tune User Guide* | | **Administrator** | *Administrator Guide* | -- Gitee