Skip to content

Commit

Permalink
Delete docs directory (#1181)
Browse files Browse the repository at this point in the history
Signed-off-by: tison <[email protected]>
  • Loading branch information
tisonkun authored Dec 16, 2022
1 parent 1de4e93 commit d1eadda
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 35 deletions.
53 changes: 18 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>

[![kvrocks ci actions](https://github.com/apache/incubator-kvrocks/actions/workflows/kvrocks.yaml/badge.svg)](https://github.com/apache/incubator-kvrocks/actions/workflows/kvrocks.yaml)
[![GitHub license](https://img.shields.io/github/license/apache/incubator-kvrocks)](https://github.com/apache/incubator-kvrocks/blob/unstable/LICENSE)
Expand All @@ -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

Expand Down Expand Up @@ -105,21 +89,21 @@ 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
# or get the nightly image:
$ docker run -it -p 6666:6666 apache/kvrocks:nightly
```

### Connect kvrocks service
### Connect Kvrocks service

```
$ redis-cli -p 6666
Expand All @@ -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..
Expand Down Expand Up @@ -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

Expand All @@ -205,28 +188,28 @@ Documents are hosted at the [official website](https://kvrocks.apache.org/docs/s
latency: 99.9% < 10ms

![image](docs/images/chart-commands.png)
![image](assets/chart-commands.png)

### 2. QPS on different payloads

> kvrocks: workers = 16, benchmark: 8 threads/ 512 conns
latency: 99.9% < 10ms

![image](docs/images/chart-values.png)
![image](assets/chart-values.png)

#### 3. QPS on different workers

> kvrocks: workers = 16, benchmark: 8 threads/ 512 conns / 128 payload
latency: 99.9% < 10ms

![image](docs/images/chart-threads.png)
![image](assets/chart-threads.png)

## License

Kvrocks is under the Apache License Version 2.0. See the [LICENSE](LICENSE) file for details.

## WeChat Official Account (微信公众号)

![WeChat official account](docs/images/wechat_account.jpg)
![WeChat official account](assets/wechat_account.jpg)
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed docs/images/U-NEXT_logo.png
Binary file not shown.
Binary file removed docs/images/baidu_logo.png
Binary file not shown.
Binary file removed docs/images/circl-lu.png
Binary file not shown.
Binary file removed docs/images/jiatou_logo.png
Binary file not shown.
Binary file removed docs/images/kvrocks_logo.png
Binary file not shown.
Binary file removed docs/images/rgyun_logo.png
Binary file not shown.
Binary file removed docs/images/xueqiu_logo.png
Binary file not shown.

0 comments on commit d1eadda

Please sign in to comment.