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 a5ecf6cdd2 Update pagination_prev and pagination_next for development
related docs
a5ecf6cdd2 is described below
commit a5ecf6cdd2f3f307d1067333ef66f5626d5e72dc
Author: XiaoxiangYu <x...@apache.org>
AuthorDate: Mon Aug 29 16:37:10 2022 +0800
Update pagination_prev and pagination_next for development related docs
---
website/docs/development/how_to_contribute.md | 152 +++++++++++----------
.../docs/development/how_to_debug_kylin_in_ide.md | 9 +-
website/docs/development/how_to_package.md | 5 +-
website/docs/development/how_to_release.md | 16 ++-
website/docs/development/how_to_test.md | 16 ++-
website/docs/development/how_to_write_doc.md | 145 ++++++++------------
.../development/images/how-to-write-doc-03.png | Bin 6085 -> 164475 bytes
.../development/images/how-to-write-doc-04.png | Bin 14610 -> 417345 bytes
website/docs/development/intro.md | 24 +++-
website/docs/development/roadmap.md | 21 ++-
website/docusaurus.config.js | 2 +
website/package.json | 2 +
website/sidebars.js | 9 +-
13 files changed, 220 insertions(+), 181 deletions(-)
diff --git a/website/docs/development/how_to_contribute.md
b/website/docs/development/how_to_contribute.md
index 1b9a6097e8..ede3a86633 100644
--- a/website/docs/development/how_to_contribute.md
+++ b/website/docs/development/how_to_contribute.md
@@ -5,92 +5,94 @@ sidebar_label: How to contribute
pagination_label: How to contribute
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: development/roadmap
+pagination_next: development/how_to_write_doc
keywords:
- contribute
+ - code review
draft: false
last_update:
- date: 08/24/2022
+ date: 08/29/2022
+ author: Tengting Xu, Xiaoxiang Yu
---
Apache Kylin is always looking for contributions of not only code, but also
usage document, performance report, Q&A etc. All kinds of contributions pave
the way towards a Kylin Committer. There is opportunity for everyone,
especially for those come from analysis and solution background, due to the
lacking of content from user and solution perspective.
-
-## Source Branches
+### Source Branches
Both code and document are under Git source control. Note the purpose of
different branches.
* `kylin5`: Development branch for v5.x
* `doc5.0`: Document branch for v5.x
-
-* `main`: Maintenance branch for a certain major release for v4.x
-* `2.[n].x`: Maintenance branch for a certain major release for v2.x
-* `3.[n].x`: Maintenance branch for a certain major release for v3.x
-* `document`: Document branch for V4.x and before
-
-## Pick a task
-There are open tasks waiting to be done, tracked by JIRA.
-
-Do not forget to discuss in [mailing list](#TODO) before working on a big task.
-
-If create a new JIRA for bug or feature, remember to provide enough
information for the community:
-
-* A well summary for the problem or feature
-* A detail description, which may include:
+* `main`: Maintenance branch for v4.x
+* `kylin3`: Maintenance branch for v2.x
+* `document`: Document branch for v4.x and before
+
+-----
+
+## Guide for Contributor
+
+:::info
+Want to know what do different role(like contributor, committer and PMC
member) means in ASF? Check this for [official
explanation](https://www.apache.org/foundation/how-it-works.html#roles) .
+:::
+
+### Overall steps
+1. Fork [Apache Kylin Repo](https://github.com/apache/kylin) to your
repository.
+2. Clone the fork repo to your local. It is recommended to [create a pull
request from a
fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+3. Create a new development branch locally.
+4. [Setup development environment](how_to_debug_kylin_in_ide.md)
+5. [Pick or Create a JIRA](#open_issue), describe the feature/enhancement/bug.
+6. [Discuss with others in mailing list](#mailing_list) or issue comments,
make sure the proposed changes fit in with what others are doing and have
planned for the project.
+7. Make code changes in your development branch
+ - [ ] No strict code style at the moment, but the general rule is keep
consistent with existing files. E.g. use 4-space indent for java files.
+ - [ ] Add test case for your code change as much as possible.
+ - [ ] Make sure [Run tests](how_to_test.md) can get success, this will
ensure your change is in good quality and does not break anything.
+ - [ ] Sufficient unit test and integration test is a mandatory part of code
change.
+8. Read [CODE REVIEW guidelines](#CodeReviewGuideline) and check if your code
does not adhere to the guidelines, you may be asked to redo some work later if
you forgot them.
+9. [Create a pull request](#open_pull_request) for you code change.
+10. If you need to update doc, please check out [How to Write
Document](./how_to_write_doc) for help.
+
+
+#### <span id="open_issue">Step 4: Pick or create a task</span>
+There are open tasks waiting to be done, tracked by [KYLIN
JIRA](http://issues.apache.org/jira/browse/KYLIN).
+If you want to create a new JIRA for bug or feature, remember to provide
enough information for the community:
+
+* A well **summary** for the problem or feature
+* A detail **description**, which may include:
- the environment of this problem occurred
+ - Kylin version
+ - Hadoop/Spark version ...
- the steps to reproduce the problem
- the error trace or log files (as attachment)
- - the metadata of the model or cube
-* Related components: we will arrange reviewer based on this selection.
-* Affected version: which Kylin you're using.
-
-## Making Code Changes
-* [Setup development environment](how_to_debug_kylin_in_ide.md)
-* Raise a JIRA, describe the feature/enhancement/bug
-* Discuss with others in mailing list or issue comments, make sure the
proposed changes fit in with what others are doing and have planned for the
project
-* Make changes in your fork
- * No strict code style at the moment, but the general rule is keep
consistent with existing files. E.g. use 4-space indent for java files.
- * Add test case for your code change as much as possible.
- * Make sure "mvn clean package" and "mvn test" can get success.
- * Sufficient unit test and integration test is a mandatory part of code
change.
-* [Run tests](how_to_test.md) to ensure your change is in good quality and
does not break anything. If your patch was generated incorrectly or your code
does not adhere to the code guidelines, you may be asked to redo some work.
-* Generate a patch and attach it to relative JIRA.
-
-## Create a pull request
-
-It is recommended to [create a pull request from a
fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
-
-* Fork [Apache Kylin Repo](https://github.com/apache/kylin) to your repository.
-
-
+ - the metadata of the model or cube (as attachment)
+* **Affected version**: which Kylin you're using.
-* Clone the fork repo to your local system.
+#### <span id="mailing_list">Step 5: Discuss your proposal in mailing
list</span>
+Do not forget to discuss in [mailing
list](https://www.apache.org/foundation/mailinglists.html) before working on a
big task.
+For how to discuss your idea/proposal in mailing list, please check this
example : [Example for developer's
proposal](https://lists.apache.org/thread/gtcntp4s8k0fz1d4glospq15sycc599x) .
-```shell
-git clone https://github.com/<YourUserName>/kylin.git
-```
+:::caution subscribe a mailing list
+1. Before you sending mail to mailing list, please make sure you have
subscribed a mailing list. Please [check this
guide](https://www.apache.org/foundation/mailinglists.html#subscribing) if you
don't know how to subscribe a mailing list.
+2. If you do not [receive the confirmation
email](https://www.apache.org/foundation/mailinglists.html#request-confirmation)
after sending email to the mail list, the email maybe is shown in your trash
mail.
+:::
-Once the repo is cloned, you need to do two things:
+These are the mailing lists that have been established for kylin project. For
each list, there is a subscribe, unsubscribe, and an archive link.
-* Create a new branch by issuing the command:
+| Mailing List | Subscribe Link | Unsubscribe Link | Archive Link
|
+|:-----------------:|:-----------------:|:-----------------:|:-----------------:|
+| user | [subscribe](mailto:user-subscr...@kylin.apache.org) |
[unsubscribe](mailto:user-unsubscr...@kylin.apache.org) | [mail
archive](https://lists.apache.org/list.html?u...@kylin.apache.org) |
+| dev | [subscribe](mailto:dev-subscr...@kylin.apache.org) |
[unsubscribe](mailto:dev-unsubscr...@kylin.apache.org) | [mail
archive](https://lists.apache.org/list.html?d...@kylin.apache.org) |
+| issue | [subscribe](mailto:issue-subscr...@kylin.apache.org) |
[unsubscribe](mailto:issue-unsubscr...@kylin.apache.org) | [mail
archive](https://lists.apache.org/list.html?is...@kylin.apache.org) |
-```shell
-git checkout -b new_branch
-```
+#### <span id="open_pull_request">Step 9: Create a pull request</span>
-* Create a new remote for the upstream repo with the command:
+* Push your code change to your personal repo
-```shell
-git remote add upstream https://github.com/apache/kylin.git
-```
-> In this case, "upstream repo" refers to the original repo which is [Apache
Kylin Repo](https://github.com/apache/kylin.git).
-
-Now you can make changes to the code. The following code creates a new branch,
makes an arbitrary change, and pushes it to **new_branch**:
+Now you can make changes to the code. Then you need to push it to
**development_branch**:
```shell
# After making changes to the code ...
-git commit -m "Modify some code to new_branch"
-git push origin new_branch
+git commit -m "KYLIN-0000 COMMIT SUMMARY"
+git push origin development_branch
```
* Click the ___Compare & pull request___ button.
@@ -100,17 +102,20 @@ Once you push the changes to your repo, the Compare &
pull request button will a
* Click ___Create pull request___ to open a new pull request.
+
+:::caution Before you create pull request
+1. Please add a detailed description in the `Proposed changes` of a pull
request.
+2. Click the `Types of changes` that you have made.
+3. Check the `Checklist`.
+:::
+
-> Note:
->
-> 1. Please add a detailed description in the `Proposed changes` of a pull
request.
->
-> 2. Click the `Types of changes` that you have made.
->
-> 3. Check the `Checklist`.
-## Code Review
+-----
+
+## Guide for Reviewer
+### <span id="CodeReviewGuideline">Code Review Guideline</span>
The reviewer needs to review the patch from the following perspectives:
* _Functionality_: the patch MUST address the issue and has been verified by
the contributor before submitting for review.
@@ -120,15 +125,14 @@ The reviewer needs to review the patch from the following
perspectives:
* _API compatibility_: the change SHOULD NOT break public API's functionality
and behavior; If an old API need be replaced by the new one, print warning
message there.
* _Documentation_: if the Kylin document need be updated together, create
another JIRA with "Document" as the component to track. In the document JIRA,
attach the doc change patch which is againt the "document" branch.
+:::caution
A patch which doesn't comply with the above rules may not get merged.
+:::
-## Patch +1 Policy
+### Patch +1 Policy
Patches that fit within the scope of a single component require, at least, a
+1 by one of the component’s owners before commit. If owners are absent — busy
or otherwise — two +1s by non-owners but committers will suffice.
Patches that span components need at least two +1s before they can be
committed, preferably +1s by owners of components touched by the x-component
patch.
-Any -1 on a patch by anyone vetoes a patch; it cannot be committed until the
justification for the -1 is addressed.
-
-## Making Document Changes
-Check out [How to Write Document](./how_to_write_doc).
+Any -1 on a patch by anyone vetoes a patch; it cannot be committed until the
justification for the -1 is addressed.
\ No newline at end of file
diff --git a/website/docs/development/how_to_debug_kylin_in_ide.md
b/website/docs/development/how_to_debug_kylin_in_ide.md
index c0c499d615..a032cb8795 100644
--- a/website/docs/development/how_to_debug_kylin_in_ide.md
+++ b/website/docs/development/how_to_debug_kylin_in_ide.md
@@ -1,18 +1,19 @@
---
title: How to debug Kylin in IDEA
language: en
-sidebar_label: How to debug
-pagination_label: How to debug
+sidebar_label: How to debug in IDEA
+pagination_label: How to debug in IDEA
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: development/how_to_write_doc
+pagination_next: development/how_to_test
keywords:
- developer
- debug
draft: false
last_update:
date: 08/24/2022
+ author: Xiaoxiang Yu
---
# How to debug Kylin in IDEA using docker
diff --git a/website/docs/development/how_to_package.md
b/website/docs/development/how_to_package.md
index dd3f86a186..342800f5e4 100644
--- a/website/docs/development/how_to_package.md
+++ b/website/docs/development/how_to_package.md
@@ -5,13 +5,14 @@ sidebar_label: How to package
pagination_label: How to package
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: development/how_to_test
+pagination_next: development/how_to_release
keywords:
- package
draft: false
last_update:
date: 08/22/2022
+ author: Xiaoxiang Yu
---
# How to package
diff --git a/website/docs/development/how_to_release.md
b/website/docs/development/how_to_release.md
index bb285d9b54..dfa8976855 100644
--- a/website/docs/development/how_to_release.md
+++ b/website/docs/development/how_to_release.md
@@ -1,5 +1,19 @@
---
-sidebar_position: 1
+title: How to release
+language: en
+sidebar_label: How to release
+pagination_label: How to release
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: development/how_to_package
+pagination_next: null
+showLastUpdateAuthor: true
+showLastUpdateTime: true
+keywords:
+ - release
+draft: false
+last_update:
+ date: 08/24/2022
---
# How to release
diff --git a/website/docs/development/how_to_test.md
b/website/docs/development/how_to_test.md
index 6f7cdcfa1c..e0cc1e6905 100644
--- a/website/docs/development/how_to_test.md
+++ b/website/docs/development/how_to_test.md
@@ -1,5 +1,19 @@
---
-sidebar_position: 1
+title: How to test
+language: en
+sidebar_label: How to test
+pagination_label: How to test
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: development/how_to_debug_kylin_in_ide
+pagination_next: development/how_to_package
+showLastUpdateAuthor: true
+showLastUpdateTime: true
+keywords:
+ - testing
+draft: false
+last_update:
+ date: 08/24/2022
---
# How to test
diff --git a/website/docs/development/how_to_write_doc.md
b/website/docs/development/how_to_write_doc.md
index 7e4ceaf698..f287873019 100644
--- a/website/docs/development/how_to_write_doc.md
+++ b/website/docs/development/how_to_write_doc.md
@@ -5,66 +5,61 @@ sidebar_label: How to write document
pagination_label: How to write document
toc_min_heading_level: 2
toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
+pagination_prev: development/how_to_contribute
+pagination_next: development/how_to_debug_kylin_in_ide
keywords:
- doc
- document
draft: false
last_update:
date: 08/24/2022
+ 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, so it is not supported right now.
+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.
### Shortcut: Edit a single existent page
-If you found some minor typos or mistakes on a single page, you can quickly
commit the change without clone source code and preview in user's local machine.
+:::caution
+1. If you found some minor typos or mistakes on a **single** page, you can
quickly edit document in browser in quick way.
+2. But if you want to add/edit **several** pages, upload images, or change
global config files, please jump to next paragraph: [Before your
work](#Before_your_work).
+:::
-Just scroll down the page to the bottom and click the `Edit this page`.
+1. Just scroll down the page to the bottom and click the `Edit this page`.
-Edit the page.
+2. Edit this file in browser.
-Raise a pull request.
+3. Raise a pull request for your changes.
-> Note: If you want to add NEW pages/upload images/change frontend style,
please do as following steps.
-
-## Before your work
+### <span id="Before_your_work">Before your work</span>
Before you add new documentation, please deploy the document compilation
environment.
There are two steps:
-- [Deploy a local document compilation environment](#Deploy)
-- [Download repo](#Download)
+- [Install Node.js](#Install)
+- [Clone Github repo](#Download)
-### <span id="Deploy">Deploy a local document compilation environment</span>
+#### <span id="Install">Install Node.js</span>
-Install following tools before you add or edit documentation:
+First, make sure [Node.js](https://nodejs.org/en/download/) version 16.14 or
above (which can be checked by running node -v) is installed on your machine.
You can use [nvm](https://github.com/nvm-sh/nvm) for managing multiple Node
versions on a single machine installed.
-1. First, make sure [Node.js](https://nodejs.org/en/download/) version 16.14
or above (which can be checked by running node -v) on your machine. You can use
[nvm](https://github.com/nvm-sh/nvm) for managing multiple Node versions on a
single machine installed.
+When installing Node.js via **Windows/macOS Installer**, you are recommended
to check all checkboxes related to dependencies.
- - When installing Node.js, you are recommended to check all checkboxes
related to dependencies.
-
- > More about requirement about [Docusaurus](https://docusaurus.io/),
please refer to [Docusaurus
Installation](https://docusaurus.io/docs/installation).
-
+#### <span id="Download">Clone Github repo</span>
-2. And optionally any markdown editor you prefer
-
-### <span id="Download">Download docs repo</span>
-
-1. Download the doc repo to any path you prefer.
+1. Clone the doc repo to any path you prefer.
```shell
cd /path/you/prefer/to
git clone --branch doc5.0 https://github.com/apache/kylin.git # Or git clone
-b doc5.0 https://github.com/apache/kylin.git
```
-2. After pre-step, install dependencies for prerequisite of doc.
+2. Install dependencies for prerequisite of doc. More about requirement about
[Docusaurus](https://docusaurus.io/), please refer to [Docusaurus
Installation](https://docusaurus.io/docs/installation).
```shell
cd website
@@ -77,73 +72,50 @@ To check if that environment works well, run:
npm run start
```
-then, home page doc (`http://localhost:3000`) will automatically open in your
default browser and no errors occurred.
+then, homepage (`http://localhost:3000`) will automatically open in your
default browser and no errors occurred.
-## How to create new document
+### How to create new document
-### Create a new markdown file
+#### Step 1: Create a new markdown file with metadata
-Open doc with any markdown editor, draft content as following:
+Create a new markdown file with editor, copy and paste following **Head
metadata template** to the top your file.
+After that, replace actual literal with variable like `${TITLE OF NEW DOC}`
etc.
```
---
-title: Example doc
+title: ${TITLE OF NEW DOC}
language: en
-sidebar_label: Example doc
-pagination_label: Example doc
+sidebar_label: ${TITLE OF NEW DOC}
+pagination_label: ${TITLE OF NEW DOC}
toc_min_heading_level: 2
toc_max_heading_level: 6
pagination_prev: null
pagination_next: null
keywords:
- - doc
+ - ${KEYWORD OF NEW DOC}
draft: false
last_update:
- date: 08/23/2022
+ date: ${DATE of YOUR COMMIT}
+ author: ${YOUR FULL NAME}
---
-
-## This is example doc
-The quick brown fox jump over the lazy dog.
```
-> ***Note***:
->
-> 1. Please note that every doc need the ___Head metadata___. More details
about `Head metadata` of a doc, please refer to [Head
metadata](https://docusaurus.io/docs/markdown-features/head-metadata).
->
-> 2. Please use the template `Head metadata` in your modified doc.
- ```shell
- ---
- title: Example doc
- language: en
- sidebar_label: Example doc
- pagination_label: Example doc
- toc_min_heading_level: 2
- toc_max_heading_level: 6
- pagination_prev: null
- pagination_next: null
- keywords:
- - doc
- draft: false
- last_update:
- date: 08/23/2022
- ---
- ```
->
-> 3. Please use `second heading level` for the doc header start.
-
-
-### How to add a new page to the sidebar
-
-Add the `{}` doc side block in sideBars.
-
-Example:
-
-Scene: If you want to add the sidebar of `how_to_write_doc.md` to be the
children menu of `development`.
-
-Then, modify the `DevelopmentSideBar` block in sidebars.js and add a new block
in the `items` of `DevelopmentSideBar`.
+:::caution
+Please note that each doc need the ___Head metadata___. More details about
`Head metadata` of a doc, please refer to [Head
metadata](https://docusaurus.io/docs/markdown-features/head-metadata).
+:::
+
+#### Step 2: Add content for your new doc
+
+Add text and pictures as you needs.
+
+#### Step 3: Add new page to the sidebar
+
+For example: if you want to add the sidebar of new doc(`how_to_write_doc.md`)
to be the children menu of `development`.
+
+Then, modify the `DevelopmentSideBar` block in `sidebars.js` and add a new
block to the tail of `items` of `DevelopmentSideBar`.
```shell
DevelopmentSideBar: [
@@ -162,7 +134,7 @@ DevelopmentSideBar: [
```
-### Preview in your local machine
+#### Step 4: Preview in your local machine
You can preview in your browser, to check exactly what it will look like,
please run following commands in the `website` directory of repo folder:
```
@@ -170,17 +142,21 @@ npm run start
```
Then access http://127.0.0.1:3000 in your browser.
+#### Step 5: Create a pull request
If everything is normal, create a pull request to [Apache Kylin
Repo](https://github.com/apache/kylin) and target branch is `doc5.0`.
-## Documentation Specification
-### About [Docusaurus](https://docusaurus.io/)
+----
+
+### Documentation Specification
+
+#### About [Docusaurus](https://docusaurus.io/)
[Docusaurus](https://docusaurus.io/) is a static-site generator. It builds a
single-page application with fast client-side navigation, leveraging the full
power of React to make your site interactive. It provides out-of-the-box
documentation features but can be used to create any kind of site (personal
website, product, blog, marketing landing pages, etc).
Apache Kylin's website and documentation is using
[Docusaurus](https://docusaurus.io/) to manage and generate final content which
avaliable at [http://kylin.apache.org](http://kylin.apache.org).
-### Kylin document structure and navigation menu
+#### Kylin document structure and navigation menu
The Kylin [website as the Docusaurus
source](https://github.com/apache/kylin/tree/document/doc5.0) is maintained
under the `doc5.0` branch.
@@ -191,7 +167,7 @@ The Kylin [website as the Docusaurus
source](https://github.com/apache/kylin/tre
5. __Community__: Apache kylin Community information
6. __Blog__: Technic blogs about Apache Kylin
-### Full doc structure
+#### Full doc structure
The full doc structure about the newest Apache Kylin:
@@ -250,7 +226,7 @@ doc5.0
More details about structure which managed by Docusaurus, please refer to
[Project structure
rundown](https://docusaurus.io/docs/installation#project-structure-rundown).
-### Navigation menu
+#### Navigation menu
The menu is managed by Docusaurus collection:
@@ -259,7 +235,7 @@ The menu is managed by Docusaurus collection:
More details about sidebars in Docusaurus, please refer to
[Sidebar](https://docusaurus.io/docs/sidebar).
-### How to add image
+#### How to add image
All image should be put under _images_ folder, in your document, please using
below sample to include image:
```
@@ -267,12 +243,9 @@ All image should be put under _images_ folder, in your
document, please using be
```
-### How to link to another page
-Using relative path for site links, for example:
+#### How to link to another page
+Using relative path for site links, check this [Markdown
links](https://docusaurus.io/docs/markdown-features/links)
-```
-[How To Write Docs](../development/how_to_write_doc).
-```
-### How to add code highlight
-We are using [Rouge](https://github.com/jneen/rouge) to highlight code syntax,
check this doc for more detail sample.
+#### How to add code highlight
+We are using [Code Blocks
Doc](https://docusaurus.io/docs/markdown-features/code-blocks) to highlight
code syntax, check this doc for more detail sample.
diff --git a/website/docs/development/images/how-to-write-doc-03.png
b/website/docs/development/images/how-to-write-doc-03.png
index 1af7b57800..3c078dc2f9 100644
Binary files a/website/docs/development/images/how-to-write-doc-03.png and
b/website/docs/development/images/how-to-write-doc-03.png differ
diff --git a/website/docs/development/images/how-to-write-doc-04.png
b/website/docs/development/images/how-to-write-doc-04.png
index 9a71dbd25a..0644f11400 100644
Binary files a/website/docs/development/images/how-to-write-doc-04.png and
b/website/docs/development/images/how-to-write-doc-04.png differ
diff --git a/website/docs/development/intro.md
b/website/docs/development/intro.md
index 5795165ed6..6a693ac3c6 100644
--- a/website/docs/development/intro.md
+++ b/website/docs/development/intro.md
@@ -1,16 +1,28 @@
---
-title: Guide of developer
+title: Guide of Developer
language: en
-sidebar_label: Guide of developer
-pagination_label: Guide of developer
+sidebar_label: Guide of Developer
+pagination_label: Guide of Developer
toc_min_heading_level: 2
toc_max_heading_level: 6
pagination_prev: null
-pagination_next: null
+pagination_next: development/roadmap
keywords:
- - guide
- developer
draft: false
last_update:
- date: 08/12/2022
+ date: 08/29/2022
+ author: Xiaoxiang Yu
---
+
+### How to Contribute
+Check out the [How to Contribute](how_to_contribute.md) document.
+
+### Source Repository
+Apache Kylin™ source code is version controlled using Git version control:
+Commits Summary
+Source Repo: https://github.com/apache/kylin
+Mirrored to Gitbox: https://gitbox.apache.org/repos/asf?p=kylin.git
+
+### Issue Tracking
+Track issues on the “Kylin” Project on the [Apache
JIRA](http://issues.apache.org/jira/browse/KYLIN)
\ No newline at end of file
diff --git a/website/docs/development/roadmap.md
b/website/docs/development/roadmap.md
index 0fd4a253e7..76f7791a3a 100644
--- a/website/docs/development/roadmap.md
+++ b/website/docs/development/roadmap.md
@@ -1,8 +1,21 @@
---
-sidebar_position: 1
+title: Roadmap of Apache Kylin
+language: en
+sidebar_label: Roadmap of Apache Kylin
+pagination_label: Roadmap of Apache Kylin
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: development/intro
+pagination_next: development/how_to_contribute
+keywords:
+ - roadmap
+draft: false
+last_update:
+ date: 08/24/2022
+ author: Xiaoxiang Yu
---
-# Roadmap
+# Roadmap of Apache Kylin
### Kylin 5.0.0-alpha & Kylin 5.0.0
@@ -17,11 +30,13 @@ sidebar_position: 1
- Support schema change
- Add Computed Column to support light-weight ETL
- Add Table Index to support raw query(non-aggregation query)
+ - SCD2
- Rewrite whole WEB UI
- Use Vue.js, a brand new front-end framework, to replace AngularJS
- Simplify modeling process into one canvas
- Integrated with native compute engine preliminarily
-- SCD2, async query, cost-based index optimizer etc
+- Async query
+- Cost-based index optimizer
### Kylin 5.1.0
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 6cf5d7a204..47612ab1af 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -114,6 +114,8 @@ const config = {
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/apache/kylin/tree/doc5.0/website/',
+ showLastUpdateAuthor: true,
+ showLastUpdateTime: true,
},
blog: {
showReadingTime: true,
diff --git a/website/package.json b/website/package.json
index b70eccf338..9bb8a00e85 100644
--- a/website/package.json
+++ b/website/package.json
@@ -16,6 +16,8 @@
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^0.11.0",
"@docusaurus/core": "2.0.1",
+ "@docusaurus/plugin-content-docs": "^2.0.1",
+ "@docusaurus/plugin-ideal-image": "^2.0.1",
"@docusaurus/preset-classic": "2.0.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
diff --git a/website/sidebars.js b/website/sidebars.js
index 329c23ddaf..4a341fd9c5 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -862,7 +862,7 @@ const sidebars = {
},
{
type: 'doc',
- id: 'development/how_to_test'
+ id: 'development/how_to_write_doc'
},
{
type: 'doc',
@@ -870,16 +870,17 @@ const sidebars = {
},
{
type: 'doc',
- id: 'development/how_to_package'
+ id: 'development/how_to_test'
},
{
type: 'doc',
- id: 'development/how_to_release'
+ id: 'development/how_to_package'
},
{
type: 'doc',
- id: 'development/how_to_write_doc'
+ id: 'development/how_to_release'
},
+
],
},
],
