docs: update addon and contrubution (#840)

* docs: add architecture instructions

* docs: add podlife

* docs: add datadisk instruction

* docs: update logcollect instruction

* docs: update prometheus instruction

* docs: update logcollect

* docs: update add-on instrustions

* docs: update description

* docs: update audit

* docs: add FAQ The node was low on resource memory

* docs: fix content

* docs: update instructions

* docs: update statement problem

* docs: update contribution

* docs: update prometheus

Author: willemswang

1588923740_58_w2532_h1342-3246433.png

@@ -1,22 +1,24 @@
 # Contributing Guide
 
-Welcome to the TKEStack family. TKEStack is an open, comprehensive, strong open source project. Here, you can use the release of TKEStack to build an efficient and stable container cloud platform,
-Or contribute to the TKEStack project, submit your ideas, questions, and code, share your work with the community, help more people to use TKEStack,
-Use technology to contribute to the world.
+Welcome to the TKEStack family. TKEStack is an open, comprehensive, strong open source project. 
+
+Here, you can use the release of TKEStack to build an efficient and stable container cloud platform, Or contribute to the TKEStack project, submit your ideas, questions, and code, share your work with the community, help more people to use TKEStack. Use technology to contribute to the world.
 
 This article will help you understand how the TKEStack project is organized, guide you through how you can raise issues, write code to fix problems or implement new features, and review and merge your work.
+
 Welcome to read this article and feedback your ideas to us. Looking forward to your first submission.
 
 # How to Create Issue
 
 TKEStack use [Issue](https://github.com/tkestack/tke/issues) report bugs and feature request, discuss and management, detailed issue guidelines please check: [Managing your work with issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues).
+
 TKEStack has prepared the Issue template. Please write Issue in the format of the template. In general, follow the template to clearly describe the following situations:
 
-- What environment/version/situation is the problem?
+- What **environment/version/situation** is the problem?
 
-- How to reproduce the problem.
+- How to **reproduce** the problem.
 
-- What do you expect for?
+- What do you **expect** for?
 
 TKEStack members or administrators will participate in discussions, respond to messages, and arrange developers to follow up the issue.
 
@@ -32,48 +34,45 @@ Depending on the type of PR, you should select the appropriate branch. Refer to
 
   Meanwhile, if other branches have the same problem, confirm with the administrator and cherry-pick to the corresponding branch.
 
-- When creating PR, names are in line with Angular specifications, name contents should be meaningful, and organize commits before submitting the PR.
+- When creating PR, names are in line with Angular specifications, name contents should be meaningful, and organize commits before submitting the PR:
 
    ```<type>(<scope>): <subject>```
 
-  - type is used to indicate the category of submission and can only be identified as:
-  
-    - feat: New feature
-    - fix: Fix a bug
-    - docs: Documents
-    - test: Add tests
-    - style: Format (changes that do not affect code running)
-    - refactor: Refactoring (i.e., code changes that do not add new features or fix bugs)
-    - ci: Automated processes
-    - build: Changes the build process or tooling
-    - perf: Performance optimization related
-    - revert: revert
-  
-  - scope is used to describe the scope of influence of the submission. The recommended value is the module or function name in TKEStack, for example:
-  
-    - installer
-    - platform
-    - cluster
-    - gateway
-    - console
-    - auth
-    - addon
-    - business
-    - registry
-    - monitor
-    - notify
-    - audit
-  
-  - subject is a short description of the purpose of the submission, no more than 50 characters long.
-  
+  - **type**: is used to indicate the category of submission and can only be identified as:
+    - **feat**: New feature
+    - **fix**: Fix a bug
+    - **docs**: Documents
+    - **test**: Add tests
+    - **style**: Format (changes that do not affect code running)
+    - **refactor**: Refactoring (i.e., code changes that do not add new features or fix bugs)
+    - **ci**: Automated processes
+    - **build**: Changes the build process or tooling
+    - **perf**: Performance optimization related
+    - **revert**: revert
+    
+  - **scope**: is used to describe the scope of influence of the submission. The recommended value is the module or function name in TKEStack, for example:
+    - **installer**
+    - **platform**
+    - **cluster**
+    - **gateway**
+    - **console**
+    - **auth**
+    - **addon**
+    - **business**
+    - **registry**
+    - **monitor**
+    - **notify**
+    - **audit**
+    
+  - **subject**: is a short description of the purpose of the submission, no more than 50 characters long.
     - Start with a verb and use the present tense in the first person, such as' change ', not 'changed' or 'changes'
     - Lowercase first letter
     - No period at the end
 
   For more detailed specification, see the link below. Follow the specification, PR with feat and fix type will appear in the Changelog.
 
   - [@commitlint/config-angular](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular)
-
+  
 - After creating PR, Github will automatically start the CI process, verify the PR information and check the compiling and testing, while Github will automatically notify Reviewer of a code review.
 
 - Adjust PR according to reviewer's comments, refer to [Reviewing changes in pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests).
@@ -82,15 +81,15 @@ Depending on the type of PR, you should select the appropriate branch. Refer to
 
   Note: Some abbreviations used by Reviewer
 
-  - PR: Pull Request. 
-  - LGTM: Looks Good To Me.
-  - SGTM: Sounds Good To Me. 
-  - WIP: Work In Progress.
-  - PTAL: Please Take A Look. 
-  - TBR: To Be Reviewed. 
-  - TL;DR: Too Long; Didn't Read. 
-  - TBD: To Be Done(or Defined/Discussed/Decided/Determined). 
-  - DNM: Do not merge.
+  - **PR**: Pull Request. 
+  - **LGTM**: Looks Good To Me.
+  - **SGTM**: Sounds Good To Me. 
+  - **WIP**: Work In Progress.
+  - **PTAL**: Please Take A Look. 
+  - **TBR**: To Be Reviewed. 
+  - **TL;DR**: Too Long; Didn't Read. 
+  - **TBD**: To Be Done(or Defined/Discussed/Decided/Determined). 
+  - **DNM**: Do not merge.
 
 
 # Project Management
@@ -117,12 +116,14 @@ helps users quickly select the appropriate branch and version to start their wor
 
 ## Release notes
 
-TKEStack release versions as planned, for important features, the user can focus on [Roadmap](https://github.com/tkestack/tke/wiki/TKEStack-Roadmap)
-to get TKEStack version scheduling, through [milestones](https://github.com/tkestack/tke/milestones) to view more detailed project development state.
+TKEStack release versions as planned, for important features, the user can focus on [Roadmap](https://github.com/tkestack/tke/wiki/TKEStack-Roadmap).
+
+To get TKEStack version scheduling, through [milestones](https://github.com/tkestack/tke/milestones) to view more detailed project development state.
+
 At the same time, the Release TKEStack contains Release Notes and Changelog, which are synchronized on the [TKEStack documentation site](https://tkestack.github.io/docs/).
 
 ## Proposals
 
 For changes that have a greater scope of impact, such as underlying networks, installation processes, kay data structure changes, etc., design Proposals need to be planned in advance and submitted (or comment under the Issue).
-Proposals submitted documents to the [design-proposals](https://github.com/tkestack/tke/tree/master/docs/design-proposals) to the public, the user feedback through Issue comments,
-The administrator and TOC finally decide the Proposals results.
+
+Proposals submitted documents to the [design-proposals](https://github.com/tkestack/tke/tree/master/docs/design-proposals) to the public, the user feedback through Issue comments, the administrator and TOC finally decide the Proposals results.

CONTRIBUTING.md

@@ -9,10 +9,11 @@
 * Colin Tao <[email protected]> @lin-credible: Console UI of docker registry.
 * Jun Gong <[email protected]> @hex108: Tapp controller addon.
 * Yadong Zhang <[email protected]> @yadzhang: Authentication and authorization.
+* Ao Wang <[email protected]> @wangao1236: Authentication and authorization.
 * Thomas Song <[email protected]> @mYmNeo: GPU manage addon.
 * Erick Wu <[email protected]> @erikwoo: Console UI of monitor and notify management.
 * Kevin Feng <[email protected]> @kevinfeng: Monitor and alert management.
-* Forrest Chen <[email protected]> @ChenLingPeng: Galaxy addon.
+* Forrest Chen <[email protected]> @ChenLingPeng: Galaxy addon and Audit.
 * Louis Gong <[email protected]> @gongguan: Cluster network management.
 * Rami Chen <[email protected]> @chenchun: Galaxy addon.
 * Ian Lang <[email protected]> @langyenan: Loadbalancer controller framework and addon.

MAINTAINERS.md

@@ -1,29 +1,47 @@
-# TKE Components
+# TKEStack Components
 
-`/cmd` directory includes every TKE components and is where all binaries and container images are built. For detail about how to launch the TKE cluster see the guide [here](/docs/devel/running-locally.md).
+[`/cmd`](../../cmd) directory includes every TKEStack components and is where all binaries and container images are built. For detail about how to launch the TKEStack cluster see the guide [here](running-locally.md).
 
 ## Overview
 
-TKE contains 12 core components belonging to 6 services, a dependency list generator and a customized installer.
+TKEStack contains 12 core components belonging to 6 services, a dependency list generator and a customized installer.
 
 ## Core Components
-To bootstrap properly, TKE core components need to be run in the order as shown below.
-
-- [`tke-auth-api`](/cmd/tke-auth-api) integrates [dex](https://github.com/dexidp/dex) to provide an OpenID Connect server, which can provide access to third-party authentication systems, and also provides a default local identify.
-- [`tke-auth-controller`](/cmd/tke-auth-controller) watches the state of the auth api objects through the `tke-auth-api` and configures TKE auth resources.
-- [`tke-platform-api`](/cmd/platform-api) is the most important service of TKE . It listens to and validates requests to TKE platform api then configures its api objects.
-- [`tke-platform-controller`](/cmd/tke-platform-controller) watches the state of the platform api objects through the `tke-platform-api` and configures TKE platform.
-- [`tke-registry-api`](/cmd/tke-registry-api) enables a build-in registry and chart repository of helm inside TKE.
-- [`tke-business-api`](/cmd/tke-business-api) enables TKE project management by business labels.
-- [`tke-business-controller`](/cmd/tke-business-controller) watches the state of the business api objects through the `tke-business-api` and configures TKE business resources.
-- [`tke-monitor-api`](/cmd/tke-monitor-api) enables TKE monitoring and provides a web UI to configure and view monitoring data.
-- [`tke-monitor-controller`](/cmd/tke-monitor-contoller) watches the state of the monitor api objects through the `tke-monitor-api` and configures TKE monitoring.
-- [`tke-notify-api`](/cmd/tke-notify-api) enables TKE alert notification and provides a web UI for you to configure alerts and view their status.
-- [`tke-notify-controller`](cmd/tke-notify-contoller) watches the state of the notify api objects through the `tke-notify-api` and configures TKE notification.
-- [`tke-gateway`](/cmd/tke-gateway) provides a web UI to interact with TKE .
+To bootstrap properly, TKEStack core components need to be run in the order as shown below.
+
+- [`tke-auth-api`](../../cmd/tke-auth-api) integrates [dex](https://github.com/dexidp/dex) to provide an OpenID Connect server, which can provide access to third-party authentication systems, and also provides a default local identify.
+
+- [`tke-auth-controller`](../../cmd/tke-auth-controller) watches the state of the auth API objects through the `tke-auth-api` and configures TKEStack auth resources.
+
+- [`tke-platform-api`](../../cmd/tke-platform-api) is the most important service of TKEStack . It listens to and validates requests to TKEStack platform API then configures its API objects.
+
+- [`tke-platform-controller`](../../cmd/tke-platform-controller) watches the state of the platform API objects through the `tke-platform-api` and configures TKEStack platform.
+
+- [`tke-registry-api`](../../cmd/tke-registry-api) enables a build-in registry and chart repository of helm inside TKEStack.
+
+- [`tke-business-api`](../../cmd/tke-business-api) enables TKEStack project management by business labels.
+
+- [`tke-business-controller`](../../cmd/tke-business-controller) watches the state of the business API objects through the `tke-business-api` and configures TKEStack business resources.
+
+- [`tke-monitor-api`](../../cmd/tke-monitor-api) enables TKEStack monitoring and provides a web UI to configure and view monitoring data.
+
+- [`tke-monitor-controller`](../../cmd/tke-monitor-contoller) watches the state of the monitor API objects through the `tke-monitor-api` and configures TKEStack monitoring.
+
+- [`tke-notify-api`](../../cmd/tke-notify-api) enables TKEStack alert notification and provides a web UI for you to configure alerts and view their status.
+
+- [`tke-notify-controller`](cmd/tke-notify-contoller) watches the state of the notify API objects through the `tke-notify-api` and configures TKEStack notification.
+
+-  provides a web UI to interact with TKEStack.
+
+  > You can refer to [TKEStack architecture](../guide/zh-CN/installation/installation-architecture.md) to know more information.
 
 ## Dependency List Generator
-- [`generate-images`](/cmd/generate-images) reads from all the dependencies and generates a list of image dependencies.
+- [`generate-images`](../../cmd/generate-images) reads from all the dependencies and generates a list of image dependencies.
 
 ## Installer
-- [`tke-installer`](/cmd/tke-installer) provides an easy way to install and launch your own TKE.
+- [`tke-installer`](../../cmd/tke-installer) provides an easy way to install and launch your own TKEStack. 
+- You can refer to [here](../user/tke-installer/introduction.md) for more information about tke-installer。
+
+## Help
+
+If you have any questions, please submit your [issue](https://github.com/tkestack/tke/issues/new/choose) or [PR](https://github.com/tkestack/tke/pulls), or you can directly contact the [components maintainers](../../MAINTAINERS.md).