This is an automated email from the ASF dual-hosted git repository.
hulk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/kvrocks-website.git
The following commit(s) were added to refs/heads/main by this push:
new 9a83547 chore: use full form name when necessary (#193)
9a83547 is described below
commit 9a83547f40455ccfcddc6f23fca501d9e4305b0c
Author: tison <[email protected]>
AuthorDate: Wed Jan 17 12:37:43 2024 +0800
chore: use full form name when necessary (#193)
Signed-off-by: tison <[email protected]>
---
community/contributing.md | 4 ++--
community/create-a-release.md | 4 ++--
community/data-structure-on-rocksdb.md | 4 ++--
community/index.md | 2 +-
community/vote-a-core-developer.md | 2 +-
docs/backup.md | 2 ++
docs/cluster.md | 2 +-
docs/faq.md | 6 +++++-
docs/getting-started.md | 2 ++
docs/info-sections.md | 2 +-
docs/kvrocks-exporter.md | 6 +++++-
docs/kvrocks2redis.md | 2 +-
docs/namespace.md | 2 +-
docusaurus.config.js | 2 +-
download/index.mdx | 6 +++---
download/third-party-packages.md | 2 +-
16 files changed, 31 insertions(+), 19 deletions(-)
diff --git a/community/contributing.md b/community/contributing.md
index 4204d10..ee0084a 100644
--- a/community/contributing.md
+++ b/community/contributing.md
@@ -3,14 +3,14 @@ id: contributing
title: How to Contribute
---
-In order to build an active community to improve Kvrocks, we welcome and are
eager to your contributions of all kinds, including but not limited to:
+In order to build an active community to improve Apache Kvrocks™, we welcome
and are eager to your contributions of all kinds, including but not limited to:
- suggesting new ideas or feature requests (please refer to the
[Community](index.md) page);
- reporting bugs and defects you find (please refer to the
[Community](index.md) page);
- contributing code changes (whether they are minor typo fixes, improvements,
or major feature contributions);
- fixing or improving the documentation or the project website.
-## Submit patches to Kvrocks
+## Submit patches
### Prerequisite
diff --git a/community/create-a-release.md b/community/create-a-release.md
index 7083e80..5e586de 100644
--- a/community/create-a-release.md
+++ b/community/create-a-release.md
@@ -1,6 +1,6 @@
---
id: create-a-release
-title: Create a Kvrocks release
+title: Create a release
---
This document mainly introduces how the Release Manager releases a new version
in accordance with the Apache requirements.
@@ -8,7 +8,7 @@ This document mainly introduces how the Release Manager
releases a new version i
## Introduction
* Source Release is the key point which Apache values, also, is necessary for
a release;
-* Binary Release is optional. Kvrocks can choose whether to release the binary
package to the Apache repository or not.
+* Binary Release is optional. Apache Kvrocks™ can choose whether to release
the binary package to the Apache repository or not.
Note that for binary distribution packages, it is necessary to check that the
new version does not contain third-party dependencies.
diff --git a/community/data-structure-on-rocksdb.md
b/community/data-structure-on-rocksdb.md
index 7a4e12a..ab047d9 100644
--- a/community/data-structure-on-rocksdb.md
+++ b/community/data-structure-on-rocksdb.md
@@ -1,6 +1,6 @@
-# Kvrocks data structures design
+# Data structures design
-Kvrocks uses the RocksDB as storage, it's developed by Facebook which is built
on LevelDB with many extra features, like column family, transaction and
backup, see the RocksDB wiki: [Features Not In
LevelDB](https://github.com/facebook/RocksDB/wiki/Features-Not-in-LevelDB). The
basic operations in RocksDB are `Put(key, value)`, `Get(key)`, `Delete(key)`,
other complex structures aren't supported.
+Apache Kvrocks™ uses the RocksDB as storage, it's developed by Facebook which
is built on LevelDB with many extra features, like column family, transaction
and backup, see the RocksDB wiki: [Features Not In
LevelDB](https://github.com/facebook/RocksDB/wiki/Features-Not-in-LevelDB). The
basic operations in RocksDB are `Put(key, value)`, `Get(key)`, `Delete(key)`,
other complex structures aren't supported.
The main goal of this doc is to explain how we build the Redis
hash/list/set/zset/bitmap/stream on RocksDB. Most of the design were derived
from [Qihoo360/Blackwidow](https://github.com/Qihoo360/blackwidow), but with
little modification, like the bitmap design, it's a fascinating part.
diff --git a/community/index.md b/community/index.md
index bb61563..3d429b8 100644
--- a/community/index.md
+++ b/community/index.md
@@ -42,7 +42,7 @@ If you email us with a code snippet, make sure that:
## Slack
-You can join the [Apache Kvrocks community on
Slack](https://join.slack.com/t/kvrockscommunity/shared_invite/zt-p5928e3r-OUAK8SUgC8GOceGM6dAz6w).
+You can join the [Apache Kvrocks™ community on
Slack](https://join.slack.com/t/kvrockscommunity/shared_invite/zt-p5928e3r-OUAK8SUgC8GOceGM6dAz6w).
There are a couple of community rules:
diff --git a/community/vote-a-core-developer.md
b/community/vote-a-core-developer.md
index 3f3912a..b75fbe5 100644
--- a/community/vote-a-core-developer.md
+++ b/community/vote-a-core-developer.md
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
````
-Kvrocks PMC member should be responsible for assessing the contributions of
candidates.
+Apache Kvrocks™ PMC member should be responsible for assessing the
contributions of candidates.
Like many Apache projects, Kvrocks welcome all contributions, including code
contributions, documentation improvement, blog entries, guides for new users,
public speeches, and enhancement of the project in various ways.
diff --git a/docs/backup.md b/docs/backup.md
index d9c0811..af2a1ca 100644
--- a/docs/backup.md
+++ b/docs/backup.md
@@ -1,5 +1,7 @@
# Backup
+Apache Kvrocks™ supports full backup and incremental backup.
+
## Full backup
You can use `bgsave` command to trigger Kvrocks to generate a backup, and use
`rsync` tool to copy all files of backup to remote server.
diff --git a/docs/cluster.md b/docs/cluster.md
index 3205c93..d81dde4 100644
--- a/docs/cluster.md
+++ b/docs/cluster.md
@@ -1,6 +1,6 @@
# Cluster
-Before releasing the cluster mode of Kvrocks, we usually used the pre-sharding
way to scale out the capacity like sharding with Twemproxy, and used Redis
Sentinel to guarantee the availability. Although it works well in most scenes
since the capacity of Kvrocks is far larger than Redis, it’s still hard to
scale-out in-flight, so we decided to implement the cluster mode to make it
easier.
+Before releasing the cluster mode of Apache Kvrocks™, we usually used the
pre-sharding way to scale out the capacity like sharding with Twemproxy, and
used Redis Sentinel to guarantee the availability. Although it works well in
most scenes since the capacity of Kvrocks is far larger than Redis, it’s still
hard to scale-out in-flight, so we decided to implement the cluster mode to
make it easier.
There are two main types of Redis cluster solutions in the industry:
diff --git a/docs/faq.md b/docs/faq.md
index fb35268..f16b2de 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,4 +1,8 @@
-# FAQs
+---
+sidebar_label: FAQs
+---
+
+# Apache Kvrocks™ FAQs
**Question: How do I get keys num in Kvrocks?**
diff --git a/docs/getting-started.md b/docs/getting-started.md
index bbe34a3..bdfbfed 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -5,6 +5,8 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
````
+You can either get started with Apache Kvrocks™ with Docker or compile a
binary from source.
+
## Run Kvrocks with Docker
1. Follow Docker's [installation
instructions](https://docs.docker.com/engine/installation/) to install Docker.
diff --git a/docs/info-sections.md b/docs/info-sections.md
index cc90288..5971148 100644
--- a/docs/info-sections.md
+++ b/docs/info-sections.md
@@ -1,6 +1,6 @@
# INFO sections
-The INFO command returns information and statistics about the server in a
format that is simple to parse by computers and easy to read by humans.
+The INFO command returns information and statistics about the Apache Kvrocks™
server in a format that is simple to parse by computers and easy to read by
humans.
The optional section parameter can be used to select a specific section of
information in form `INFO section section ...`:
diff --git a/docs/kvrocks-exporter.md b/docs/kvrocks-exporter.md
index 5dcabca..112b0f0 100644
--- a/docs/kvrocks-exporter.md
+++ b/docs/kvrocks-exporter.md
@@ -1,4 +1,8 @@
-# Kvrocks Exporter
+---
+sidebar_label: Metrics Exporter
+---
+
+# Exporter for Apache Kvrocks™
Like the Redis metrics monitor, Kvrocks also exports the internal metrics to
INFO commands.
diff --git a/docs/kvrocks2redis.md b/docs/kvrocks2redis.md
index acaefbd..16fee46 100644
--- a/docs/kvrocks2redis.md
+++ b/docs/kvrocks2redis.md
@@ -1,6 +1,6 @@
## kvrocks2redis
-kvrocks2redis is used to migrate the data from Kvrocks to Redis(as well as
Kvrocks itself). It will read and parse data from the local dir first and then
use the psync command to read the remain change streams from the target host.
+kvrocks2redis is used to migrate the data from Apache Kvrocks™ to Redis (as
well as Kvrocks itself). It will read and parse data from the local dir first
and then use the psync command to read the remain change streams from the
target host.
## How to build
diff --git a/docs/namespace.md b/docs/namespace.md
index 4a001de..a62a3aa 100644
--- a/docs/namespace.md
+++ b/docs/namespace.md
@@ -1,6 +1,6 @@
# Namespace
-Like the Redis database, Kvrocks uses the namespace to isolate the data
between users. But unlike Redis, each namespace has its own password. The data
would be stored in the default namespace when using `requirepass`. The
namespace would have no effect when the cluster mode was enabled like the Redis
DB.
+Like the Redis database, Apache Kvrocks™ uses the namespace to isolate the
data between users. But unlike Redis, each namespace has its own password. The
data would be stored in the default namespace when using `requirepass`. The
namespace would have no effect when the cluster mode was enabled like the Redis
DB.
## Manage Namespace
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 14b6b97..3c51eef 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -6,7 +6,7 @@ const darkCodeTheme =
require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
- title: 'Apache Kvrocks',
+ title: 'Apache Kvrocks™',
tagline: 'A distributed key value NoSQL database that uses RocksDB as
storage engine and is compatible with Redis protocol.',
url: 'https://kvrocks.apache.org',
baseUrl: '/',
diff --git a/download/index.mdx b/download/index.mdx
index ea7da32..cd100af 100644
--- a/download/index.mdx
+++ b/download/index.mdx
@@ -2,9 +2,9 @@
title: Official Download
---
-## Apache Kvrocks Downloads
+## Apache Kvrocks™ Downloads
-Apache Kvrocks is released as a source artifact. We are pleased to announce
our release as below.
+Apache Kvrocks™ is released as a source artifact. We are pleased to announce
our release as below.
### Source Releases
@@ -21,7 +21,7 @@ For fast downloads, current source distributions are hosted
on mirror servers; o
### Docker Images
-Every released version of Apache Kvrocks has a corresponding [official Docker
image on Docker Hub](https://hub.docker.com/r/apache/kvrocks), which includes
prebuilt binaries for both amd64 and arm64 architecture. You can obtain it via:
+Every released version of Apache Kvrocks™ has a corresponding [official Docker
image on Docker Hub](https://hub.docker.com/r/apache/kvrocks), which includes
prebuilt binaries for both amd64 and arm64 architecture. You can obtain it via:
```shell
docker pull apache/kvrocks:$VERSION_NUMBER
diff --git a/download/third-party-packages.md b/download/third-party-packages.md
index 8579bf6..12b188a 100644
--- a/download/third-party-packages.md
+++ b/download/third-party-packages.md
@@ -1,7 +1,7 @@
# Third-party Packages
In addition to [official releases](https://kvrocks.apache.org/download/),
-there are some convenient packages for different Linux distros maintained
outside the Kvrocks PMC.
+there are some convenient packages for different Linux distros maintained
outside the Apache Kvrocks™ PMC.
That said, these packages are **NOT** created or sponsored by the ASF.
