diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index b15ae208a088..f11a74a398cc 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -120,5 +120,6 @@ * Update postcss version to 8.4.33. * Fix kafka topic name in exporter doc. * Fix query-protocol.md, make it consistent with the GraphQL query protocol. +* Add `SWIP-5 Support ClickHouse Monitoring`. All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/202?closed=1) diff --git a/docs/en/swip/readme.md b/docs/en/swip/readme.md index 346b65cb6a39..709749a83ae0 100644 --- a/docs/en/swip/readme.md +++ b/docs/en/swip/readme.md @@ -22,7 +22,7 @@ The catalogs of a major change are listed as follows **Q: Is Agent side feature or change considered a SWIP?** -A: Right now, SWIP targets on OAP and UI side changes. All agent side changes are pending on the reviews from the +A: Right now, SWIP targets OAP and UI side changes. All agent side changes are pending on the reviews from the committers of those agents. ## SWIP Template @@ -45,10 +45,10 @@ State your proposal in detail. ## Imported Dependencies libs and their licenses. ## Compatibility -Whether breaking configuration, storage structure, protocols. +Whether breaking configuration, storage structure, or protocols. ## General usage docs -This doesn't have to be final version, but help the reviews to understand how to use this new feature. +This doesn't have to be a final version, but helps the reviewers to understand how to use this new feature. ``` ## SWIP Process @@ -58,17 +58,17 @@ Here is the process for starting a SWIP. 1. Start a SWIP discussion at [GitHub Discussion Page](https://github.com/apache/skywalking/discussions/categories/swip) with title `[DISCUSS] xxxx`. 2. Fill in the sections as described above in `SWIP Template`. -3. At least one SkyWalking committer commented on the discussion to show interests to adopt it. +3. At least one SkyWalking committer commented on the discussion to show interest in adopting it. 4. This committer could update this page to grant a **SWIP ID**, and update the title to `[SWIP-ID NO.] [DISCUSS] xxxx`. 5. All further discussion could happen on the discussion page. 6. Once the consensus is made by enough committer supporters, and/or through a mail list vote, this SWIP should be added [here](./) as `SWIP-ID NO.md` and listed in the below as `Known SWIPs`. -All accepted and proposed SWIPs could be found in [here](https://github.com/apache/skywalking/discussions/categories/swip). +All accepted and proposed SWIPs can be found in [here](https://github.com/apache/skywalking/discussions/categories/swip). ## Known SWIPs -Next SWIP Number: 5 +Next SWIP Number: 6 ### Accepted SWIPs