This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch doc5.0
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/doc5.0 by this push:
new 59af019b43 Improve the 'edit a single page' section.
59af019b43 is described below
commit 59af019b438398ce6a1f1d95a6f57574c3e36ff9
Author: liyang-kylin <44219339+liyang-ky...@users.noreply.github.com>
AuthorDate: Wed Sep 7 11:48:39 2022 +0800
Improve the 'edit a single page' section.
Improve the 'edit a single page' section.
Co-authored-by: XiaoxiangYu <x...@apache.org>
---
website/docs/development/how_to_write_doc.md | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/website/docs/development/how_to_write_doc.md
b/website/docs/development/how_to_write_doc.md
index d2fe0e8840..7fc328ced7 100644
--- a/website/docs/development/how_to_write_doc.md
+++ b/website/docs/development/how_to_write_doc.md
@@ -16,25 +16,26 @@ last_update:
author: Tengting Xu, Xiaoxiang Yu
---
-From Kylin 5.0, Kylin community proposed to write documents using
[Docusaurus](https://docusaurus.io/). Please note multi-version and
i18n(multi-language) is in our plan, but it is not supported right now.
+From Kylin 5.0, Kylin documents are written using
[Docusaurus](https://docusaurus.io/). Please note multi-version and i18n
(multi-language) is not supported right now, but is in the plan. Contributions
are very much appreciated.
-### Shortcut: Edit a single existent page
+### Shortcut: Edit a single existing page
-:::info Shortcut for non-programme
-1. This shortcut/way is extreme useful for **non-programmer**. If you found
some minor typos or mistakes on a **single** page, you can edit document in
browser in this way in 3-10 minutes.
-2. But if you want to more complex works, like add/edit **several** pages,
upload images, or change global config files, please jump to next paragraph:
[**Before your work**](#Before_your_work).
+:::info Shortcut editing a single page
+1. This shortcut is extreme useful if you found some minor typos or mistakes
on a single page, you can edit the document in browser right away in a few
minutes without preparation.
+2. But if the change is more complex, like add/edit several pages, upload
images, or change global config files, please jump to next paragraph: [**Before
your work**](#Before_your_work).
:::
1. Just scroll down the page to the bottom and click the `Edit this page`.
-
2. Edit this file in browser.
-3. Raise a pull request for your changes.
+3. Propose your changes by raising a pull request.
+4. And you are done! The changes proposed will get reviewed by a reviewer, and
if OK, will be merged and be seen by the community.
+
### <span id="Before_your_work">Before your work</span>
Before you add new documentation, please deploy the document compilation
environment.
