You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kvrocks.apache.org by ti...@apache.org on 2022/12/16 13:58:44 UTC
[incubator-kvrocks] branch unstable updated: Delete docs directory (#1181)
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch unstable
in repository https://gitbox.apache.org/repos/asf/incubator-kvrocks.git
The following commit(s) were added to refs/heads/unstable by this push:
new d1eadda9 Delete docs directory (#1181)
d1eadda9 is described below
commit d1eadda9a3d58f00722d2aadaf34930e5ee90c87
Author: tison <wa...@gmail.com>
AuthorDate: Fri Dec 16 21:58:38 2022 +0800
Delete docs directory (#1181)
Signed-off-by: tison <wa...@gmail.com>
---
README.md | 53 ++++++++++-------------------
{docs/images => assets}/chart-commands.png | Bin
{docs/images => assets}/chart-threads.png | Bin
{docs/images => assets}/chart-values.png | Bin
{docs/images => assets}/wechat_account.jpg | Bin
docs/images/U-NEXT_logo.png | Bin 5692 -> 0 bytes
docs/images/baidu_logo.png | Bin 15444 -> 0 bytes
docs/images/circl-lu.png | Bin 23155 -> 0 bytes
docs/images/jiatou_logo.png | Bin 5081 -> 0 bytes
docs/images/kvrocks_logo.png | Bin 37567 -> 0 bytes
docs/images/rgyun_logo.png | Bin 23955 -> 0 bytes
docs/images/xueqiu_logo.png | Bin 6764 -> 0 bytes
12 files changed, 18 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md
index 438b7afc..5ee0bc7d 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
under the License.
-->
-<img src="docs/images/kvrocks_logo.png" alt="kvrocks_logo" width="350"/>
+<img src="https://kvrocks.apache.org/img/kvrocks-featured.png" alt="kvrocks_logo" width="350"/>
[](https://github.com/apache/incubator-kvrocks/actions/workflows/kvrocks.yaml)
[](https://github.com/apache/incubator-kvrocks/blob/unstable/LICENSE)
@@ -38,31 +38,15 @@ Kvrocks has the following key features:
* High Available, supports redis sentinel to failover when master or slave was failed
* Cluster mode, centralized management but compatible with Redis cluster client access
-> Thanks for designers @[田凌宇](https://github.com/tianlingyu1997) and @范世丽 contribute the kvrocks logo for us.
+Thanks for designers @[田凌宇](https://github.com/tianlingyu1997) and @范世丽 contribute the kvrocks logo for us.
-## Who uses kvrocks
+## Who uses Kvrocks
-<table>
-<tr>
-<td height = "128" width = "164"><img src="https://imgur.com/9X1kc2j.png" alt="Meitu"></td>
-<td height = "128" width = "164"><img src="https://imgur.com/vqgSmMz.jpeg" alt="Ctrip"></td>
-<td height = "128" width = "164"><img src="docs/images/jiatou_logo.png" alt="JiaTou"></td>
-</tr>
-<tr>
-<td height = "128" width = "164"><img src="docs/images/baidu_logo.png" alt="Baidu"></td>
-<td height = "128" width = "164"><img src="https://imgur.com/MJsoEN7.png" alt="BaishanCloud"></td>
-<td height = "128" width = "164"><img src="docs/images/rgyun_logo.png" alt="Rgyun"></td>
-</tr>
-<tr>
-<td height = "128" width = "164"><img src="docs/images/xueqiu_logo.png" alt="Xueqiu"></td>
-<td height = "128" width = "164"><img src="docs/images/U-NEXT_logo.png" alt="U-NEXT"></td>
-<td height = "128" width = "164"><img src="docs/images/circl-lu.png" alt="circl.lu"></td>
-</tr>
-</table>
+Find Kvrocks users at [the Users page](https://kvrocks.apache.org/users/).
-***Tickets a pull request to let us known that you're using kvrocks and add your logo to README***
+Users are encouraged to add themselves to the Users page. Send a pull request to add company or organization [information](https://github.com/apache/incubator-kvrocks-website/blob/main/src/components/UserLogos/index.tsx) and [logo](https://github.com/apache/incubator-kvrocks-website/tree/main/static/media/users).
-## Build and Run kvrocks
+## Build and run Kvrocks
### Prerequisite
@@ -105,13 +89,13 @@ To build with luaJIT instead of lua for better performance, run:
$ ./x.py build -DUSE_LUAJIT=ON
```
-### Running kvrocks
+### Running Kvrocks
```shell
$ ./build/kvrocks -c kvrocks.conf
```
-### Running kvrocks using Docker
+### Running Kvrocks using Docker
```shell
$ docker run -it -p 6666:6666 apache/kvrocks
@@ -119,7 +103,7 @@ $ docker run -it -p 6666:6666 apache/kvrocks
$ docker run -it -p 6666:6666 apache/kvrocks:nightly
```
-### Connect kvrocks service
+### Connect Kvrocks service
```
$ redis-cli -p 6666
@@ -144,7 +128,6 @@ $ ./x.py test go # run Golang (unit and integration) test cases
* and most other distros
* macOS
-
## Namespace
Namespace is used to isolate data between users. Unlike all the Redis databases can be visited by `requirepass`, we use one token per namespace. `requirepass` is regraded as admin token, and only admin token allows to access the namespace command, as well as some commands like `config`, `slaveof`, `bgsave`, etc..
@@ -172,15 +155,15 @@ OK
## Cluster
-Kvrocks implements a proxyless centralized cluster solution but its accessing method is completely compatible with the Redis cluster client. You can use Redis cluster SDKs to access the kvrocks cluster. More details, please see: [Kvrocks Cluster Introduction](https://kvrocks.apache.org/docs/Cluster/kvrocks-cluster-introduction)
+Kvrocks implements a proxyless centralized cluster solution but its accessing method is completely compatible with the Redis cluster client. You can use Redis cluster SDKs to access the kvrocks cluster. More details, please see: [Kvrocks Cluster Introduction](https://kvrocks.apache.org/docs/cluster/)
## Documents
-Documents are hosted at the [official website](https://kvrocks.apache.org/docs/supported-commands).
+Documents are hosted at the [official website](https://kvrocks.apache.org/docs/gettings-started/).
-* [Supported Commands](https://kvrocks.apache.org/docs/supported-commands)
-* [Design Complex Structure on RocksDB](https://kvrocks.apache.org/docs/Design/design-structure-on-rocksdb)
-* [Replication Design](https://kvrocks.apache.org/docs/Design/replication)
+* [Supported Commands](https://kvrocks.apache.org/docs/supported-commands/)
+* [Design Complex Structure on RocksDB](https://kvrocks.apache.org/community/data-structure-on-rocksdb/)
+* [Replication Design](https://kvrocks.apache.org/docs/replication)
## Tools
@@ -205,7 +188,7 @@ Documents are hosted at the [official website](https://kvrocks.apache.org/docs/s
latency: 99.9% < 10ms
-
+
### 2. QPS on different payloads
@@ -213,7 +196,7 @@ latency: 99.9% < 10ms
latency: 99.9% < 10ms
-
+
#### 3. QPS on different workers
@@ -221,7 +204,7 @@ latency: 99.9% < 10ms
latency: 99.9% < 10ms
-
+
## License
@@ -229,4 +212,4 @@ Kvrocks is under the Apache License Version 2.0. See the [LICENSE](LICENSE) file
## WeChat Official Account (微信公众号)
-
+
diff --git a/docs/images/chart-commands.png b/assets/chart-commands.png
similarity index 100%
rename from docs/images/chart-commands.png
rename to assets/chart-commands.png
diff --git a/docs/images/chart-threads.png b/assets/chart-threads.png
similarity index 100%
rename from docs/images/chart-threads.png
rename to assets/chart-threads.png
diff --git a/docs/images/chart-values.png b/assets/chart-values.png
similarity index 100%
rename from docs/images/chart-values.png
rename to assets/chart-values.png
diff --git a/docs/images/wechat_account.jpg b/assets/wechat_account.jpg
similarity index 100%
rename from docs/images/wechat_account.jpg
rename to assets/wechat_account.jpg
diff --git a/docs/images/U-NEXT_logo.png b/docs/images/U-NEXT_logo.png
deleted file mode 100644
index 39dffaa0..00000000
Binary files a/docs/images/U-NEXT_logo.png and /dev/null differ
diff --git a/docs/images/baidu_logo.png b/docs/images/baidu_logo.png
deleted file mode 100644
index 510f1119..00000000
Binary files a/docs/images/baidu_logo.png and /dev/null differ
diff --git a/docs/images/circl-lu.png b/docs/images/circl-lu.png
deleted file mode 100644
index 71e2ffa5..00000000
Binary files a/docs/images/circl-lu.png and /dev/null differ
diff --git a/docs/images/jiatou_logo.png b/docs/images/jiatou_logo.png
deleted file mode 100644
index 666467f1..00000000
Binary files a/docs/images/jiatou_logo.png and /dev/null differ
diff --git a/docs/images/kvrocks_logo.png b/docs/images/kvrocks_logo.png
deleted file mode 100644
index 4a8acb93..00000000
Binary files a/docs/images/kvrocks_logo.png and /dev/null differ
diff --git a/docs/images/rgyun_logo.png b/docs/images/rgyun_logo.png
deleted file mode 100644
index 4f17f171..00000000
Binary files a/docs/images/rgyun_logo.png and /dev/null differ
diff --git a/docs/images/xueqiu_logo.png b/docs/images/xueqiu_logo.png
deleted file mode 100644
index b6318067..00000000
Binary files a/docs/images/xueqiu_logo.png and /dev/null differ