forked from tikv/tikv
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
*: update and fix docs links and format (tikv#8836)
* *: update and fix docs links and format Signed-off-by: lilin90 <[email protected]> * Remove the deprecated link of TiKV forum Signed-off-by: lilin90 <[email protected]> * Update version of docs link Signed-off-by: lilin90 <[email protected]>
- Loading branch information
Showing
3 changed files
with
22 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,7 +36,7 @@ TiKV has the following key features: | |
|
||
- **Coprocessor support** | ||
|
||
Similar to Hbase, TiKV implements a coprocessor framework to support distributed computing. | ||
Similar to HBase, TiKV implements a coprocessor framework to support distributed computing. | ||
|
||
- **Cooperates with [TiDB](https://github.com/pingcap/tidb)** | ||
|
||
|
@@ -54,11 +54,11 @@ For instructions on deployment, configuration, and maintenance of TiKV,see TiKV | |
> | ||
> We have migrated our documentation from the [TiKV's wiki page](https://github.com/tikv/tikv/wiki/) to the [official website](https://tikv.org/docs). The original Wiki page is discontinued. If you have any suggestions or issues regarding documentation, offer your feedback [here](https://github.com/tikv/website). | ||
## TiKV Adopters | ||
## TiKV adopters | ||
|
||
You can view the list of [TiKV Adopters](https://tikv.org/adopters/). | ||
|
||
## TiKV Roadmap | ||
## TiKV roadmap | ||
|
||
You can see the [TiKV Roadmap](docs/ROADMAP.md). | ||
|
||
|
@@ -83,7 +83,7 @@ We provide multiple deployment methods, but it is recommended to use our Ansible | |
|
||
- [Try TiKV and TiDB](https://tikv.org/docs/4.0/tasks/try/introduction/) | ||
|
||
You can use [`tidb-docker-compose`](https://github.com/pingcap/tidb-docker-compose/) to quickly test TiKV and TiDB on a single machine. This is the easiest way. For other ways, see [TiDB documentation](https://pingcap.com/docs/). | ||
You can use [`tidb-docker-compose`](https://github.com/pingcap/tidb-docker-compose/) to quickly test TiKV and TiDB on a single machine. This is the easiest way. For other ways, see [TiDB documentation](https://docs.pingcap.com/). | ||
|
||
- Try TiKV separately | ||
- [Deploy TiKV Using Docker Stack](https://tikv.org/docs/4.0/tasks/try/docker-stack/): To quickly test TiKV separately without TiDB on a single machine | ||
|
@@ -92,9 +92,9 @@ We provide multiple deployment methods, but it is recommended to use our Ansible | |
|
||
### Production deployment | ||
|
||
For the production environment, use [Ansible](https://github.com/pingcap/tidb-ansible) to deploy the cluster. | ||
For the production environment, use [TiDB Ansible](https://github.com/pingcap/tidb-ansible) to deploy the cluster. | ||
|
||
- [Deploy TiDB Using Ansible](https://github.com/pingcap/docs/blob/master/how-to/deploy/orchestrated/ansible.md) | ||
- [Deploy TiDB Using Ansible](https://docs.pingcap.com/tidb/stable/online-deployment-using-ansible) | ||
- [Deploy TiKV separately Using Ansible](https://tikv.org/docs/4.0/tasks/deploy/ansible/) | ||
|
||
## Client drivers | ||
|
@@ -110,27 +110,27 @@ These are the clients for TiKV: | |
|
||
If you want to try the Go client, see [Go Client](https://tikv.org/docs/4.0/reference/clients/go/). | ||
|
||
## Community Meeting | ||
## Community meeting | ||
|
||
The TiKV team meets on the 4th Wednesday of every month (unless otherwise specified) at 07.00 p.m. PST ([Time zone converter](https://www.google.com/search?sxsrf=ALeKk01UVqm3BLWjN2AJxMSG73KiUqUdDw%3A1589771998935&ei=3v7BXuDQOJSl-QaKq62ICQ&q=7pm+PST&oq=7pm+PST&gs_lcp=CgZwc3ktYWIQAzIECAAQQzIECAAQQzIECAAQQzIECAAQQzIECAAQQzIECAAQQzICCAAyAggAMgYIABAHEB4yAggAOgQIABBHOggIABAHEAoQHlDQWFicXGC-ZWgAcAF4AIABmwGIAa4CkgEDMC4ymAEAoAEBqgEHZ3dzLXdpeg&sclient=psy-ab&ved=0ahUKEwjgt5SaurzpAhWUUt4KHYpVC5EQ4dUDCAw&uact=5)). | ||
|
||
Quick links: | ||
|
||
* [Meeting notes](https://docs.google.com/document/d/1CWUAkBrcm9KPclAu8fWHZzByZ0yhsQdRggnEdqtRMQ8/edit) | ||
* [Zoom meeting link](https://zoom.us/my/cncftikvproject) | ||
* [Recorded videos](https://www.youtube.com/playlist?list=PLR6NVnaTxyL2B2ZyKw5XDzkGN72YF7vuN) | ||
* [Meeting notes](https://docs.google.com/document/d/1CWUAkBrcm9KPclAu8fWHZzByZ0yhsQdRggnEdqtRMQ8/edit) | ||
* [Zoom meeting link](https://zoom.us/my/cncftikvproject) | ||
* [Recorded videos](https://www.youtube.com/playlist?list=PLR6NVnaTxyL2B2ZyKw5XDzkGN72YF7vuN) | ||
|
||
## Security | ||
|
||
### Security Audit | ||
### Security audit | ||
|
||
A third-party security auditing was performed by Cure53. See the full report [here](./docs/Security-Audit.pdf). | ||
|
||
### Reporting Security Vulnerabilities | ||
|
||
To report a security vulnerability, please send an email to [TiKV-security]([email protected]) group. | ||
To report a security vulnerability, please send an email to [TiKV-security](mailto:[email protected]) group. | ||
|
||
See [Security](./SECURITY.md) for the process and policy followed by the TiKV project. | ||
See [Security](./SECURITY.md) for the process and policy followed by the TiKV project. | ||
|
||
## Communication | ||
|
||
|