This is an automated email from the ASF dual-hosted git repository.
jiafengzheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new ce5bd8be15c update README.md to introduce blog and versions
new 9f8e0935803 Merge pull request #10 from wangyf0555/wyf
ce5bd8be15c is described below
commit ce5bd8be15c94721155073c28a932c7a5a292af1
Author: wangyf0555 <[email protected]>
AuthorDate: Thu Jun 9 10:02:20 2022 +0800
update README.md to introduce blog and versions
---
README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 50 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index a2a8b0709dc..6f59267744e 100644
--- a/README.md
+++ b/README.md
@@ -65,18 +65,35 @@ To write a blog file, you must first include following
information in the header
| date | - | Blog date |
| author | - | Blog author |
| metaTitle | - | The title displayed by the browser when browsing the article
|
-| language | en/zn-CN | language |
-| layout | Article | Layout of the components |
-| sidebar | false | Hide the sidebar |
-| isArticle | true | Whether it is an article, do not modify by default |
+| language | en/zh-CN | language |
+| categories | DorisInternals/DorisWeekly/PracticalCases/ReleaseNote | Just
required in en language |
+| zhCategories | DorisInternals/DorisWeekly/PracticalCases/ReleaseNote | Just
required in zh-CN language |
>**Attention**
>
>The title, description, date, author, and metaTitle field values are filled
>in by the blog writer, and the other fields are fixed values.
>
>language: en, zh-CN
+>
+>There are four categories of blogs:
DorisInternals,DorisWeekly,PracticalCases,ReleaseNote.
-File header example：
+Blog file header example of en language：
+
+```json
+---
+{
+ "title": "This is title",
+ "description": "This is description",
+ "date": "2021-11-03",
+ "author": "Alex",
+ "metaTitle": "article",
+ "language": "en",
+ "categories": "DorisInternals"
+}
+---
+```
+
+Blog file header example of zh-CN language：
```json
---
@@ -87,9 +104,7 @@ File header example：
"author": "Alex",
"metaTitle": "article",
"language": "zh-CN",
- "layout": "Article",
- "sidebar": false
- "isArticle":true
+ "zhCategories": "DorisInternals"
}
---
```
@@ -123,6 +138,33 @@ After the blog file is written, put it in the
corresponding directory. The Chine
All images in the blog should be placed in certain directory. For example,
your blog file named: `doris-article1.md`, and you need to create a directory
`blogs/images/blogs/datax-article1/`, and put all images in this directory.
+## How to create a version of the document
+The document consists of two parts: markdown file and sidebar js file. The
following uses version 1.0 as an example:
+
+First of all, create a directory named 1.0, and then create an en/ directory
and a zh-CN/ directory in 1.0 directory. Finally，put the English and Chinese
Markdown files into the en/ and zh-CN/ directory.
+```
+| |—— 1.0
+| |—— en
+| | |—— admin-manual
+│ │ |—— advanced
+ ...
+| |—— zh-CN
+| | |—— admin-manual
+│ │ |—— advanced
+ ...
+```
+
+Put the 1.0 version sidebar js files into the sidebar/en/ and sidebar/zh-CN/.
+```
+| |—— sidebar
+| |—— en
+| | |—— 1.0.js
+ ...
+| |—— zh-CN
+| | |—— 1.0.js
+ ...
+```
+
## About Doris
For more details about Doris, refer to
[incubator-doris](https://github.com/apache/incubator-doris/blob/master/docs/README.md).
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
