This is an automated email from the ASF dual-hosted git repository. wutao pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-pegasus-website.git
commit 57c9d2edcd9197b2a2e76d1804f1b5103ac4840d Author: neverchanje <[email protected]> AuthorDate: Sat Oct 3 18:15:18 2020 +0800 support docs i18n --- _api/index.md | 30 ------------- _clients/go-client.md | 51 ---------------------- _clients/index.md | 15 ------- _data/docs_menu.yml | 22 +++++----- _data/en/translate.yml | 41 ++++++++++++++++- _data/zh/translate.yml | 23 +++++----- _docs/en/administration/backup-request.md | 5 +++ _docs/en/administration/bad-disk.md | 5 +++ _docs/en/administration/cold-backup.md | 5 +++ _docs/en/administration/compression.md | 5 +++ _docs/en/administration/config.md | 5 +++ _docs/en/administration/deployment.md | 5 +++ _docs/en/administration/duplication.md | 5 +++ _docs/en/administration/experiences.md | 5 +++ _docs/en/administration/index.md | 5 +++ _docs/en/administration/manual-compact.md | 5 +++ _docs/en/administration/meta-recovery.md | 5 +++ _docs/en/administration/monitoring.md | 5 +++ _docs/en/administration/partition-split.md | 5 +++ _docs/en/administration/rebalance.md | 5 +++ _docs/en/administration/remote-commands.md | 5 +++ _docs/en/administration/replica-recovery.md | 5 +++ _docs/en/administration/resource-management.md | 5 +++ _docs/en/administration/rolling-update.md | 5 +++ _docs/en/administration/scale-in-out.md | 5 +++ _docs/en/administration/table-env.md | 5 +++ _docs/en/administration/table-migration.md | 5 +++ _docs/en/administration/table-soft-delete.md | 5 +++ _docs/en/administration/throttling.md | 5 +++ _docs/en/administration/usage-scenario.md | 5 +++ _docs/en/administration/whitelist.md | 5 +++ _docs/en/administration/zk-migration.md | 5 +++ _docs/en/api/geo.md | 5 +++ _docs/en/api/http.md | 5 +++ _docs/en/api/redis.md | 5 +++ _docs/en/api/single-atomic.md | 5 +++ _docs/en/api/ttl.md | 5 +++ _docs/en/clients/cpp-client.md | 5 +++ _docs/en/clients/go-client.md | 5 +++ _docs/en/clients/java-client.md | 5 +++ _docs/en/clients/node-client.md | 5 +++ _docs/en/clients/python-client.md | 5 +++ _docs/en/clients/scala-client.md | 5 +++ _docs/en/docs.md | 4 ++ .../zh/administration}/backup-request.md | 4 +- .../zh/administration}/bad-disk.md | 4 +- .../zh/administration}/cold-backup.md | 4 +- .../zh/administration}/compression.md | 4 +- .../zh/administration}/config.md | 4 +- .../zh/administration}/deployment.md | 6 +-- .../zh/administration}/duplication.md | 4 +- .../zh/administration}/experiences.md | 4 +- .../zh/administration}/index.md | 2 - .../zh/administration}/manual-compact.md | 4 +- .../zh/administration}/meta-recovery.md | 5 +-- .../zh/administration}/monitoring.md | 4 +- .../zh/administration}/partition-split.md | 4 +- .../zh/administration}/rebalance.md | 4 +- .../zh/administration}/remote-commands.md | 5 +-- .../zh/administration}/replica-recovery.md | 4 +- .../zh/administration}/resource-management.md | 4 +- .../zh/administration}/rolling-update.md | 5 +-- .../zh/administration/scale-in-out.md | 5 +-- .../zh/administration}/table-env.md | 5 +-- .../zh/administration}/table-migration.md | 5 +-- .../zh/administration}/table-soft-delete.md | 5 +-- .../zh/administration}/throttling.md | 5 +-- .../zh/administration}/usage-scenario.md | 4 +- .../zh/administration}/whitelist.md | 4 +- .../zh/administration}/zk-migration.md | 4 +- {_api => _docs/zh/api}/geo.md | 4 +- {_api => _docs/zh/api}/http.md | 5 +-- {_api => _docs/zh/api}/redis.md | 4 +- {_api => _docs/zh/api}/single-atomic.md | 5 +-- {_api => _docs/zh/api}/ttl.md | 4 +- {_clients => _docs/zh/clients}/cpp-client.md | 5 +-- _docs/zh/clients/go-client.md | 40 +++++++++++++++++ {_clients => _docs/zh/clients}/java-client.md | 5 +-- {_clients => _docs/zh/clients}/node-client.md | 5 +-- {_clients => _docs/zh/clients}/python-client.md | 5 +-- {_clients => _docs/zh/clients}/scala-client.md | 5 +-- _docs/zh/docs.md | 4 ++ _includes/searchbox.html | 11 +++++ _includes/toc.html | 6 +++ _layouts/docs.html | 50 +++++++++++++++++++++ 85 files changed, 398 insertions(+), 243 deletions(-) diff --git a/_api/index.md b/_api/index.md deleted file mode 100644 index 7aecccd..0000000 --- a/_api/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: 用户接口 -layout: page -menubar: api_menu ---- - -这里介绍Pegasus服务所提供的用户接口。客户端可以在我们的服务接口上做二次封装。 -通常你只需要通过 [客户端文档](/clients) 学习如何与Pegasus交互。 - -当前Pegasus支持几种接口协议： - -## Pegasus 协议 - -这也是我们的客户端与Pegasus服务端交互所使用的协议。我们通过该协议暴露了 - -- 单行非幂等原子操作，如 set/get/del/ttl... - -- 单行幂等原子操作，如 check_and_mutate/incr... - -- 多行幂等原子操作，如 multiset/multiget/multidel... - -- 支持过滤的扫描操作，如 hash_scan/unordered_scan... - -## Redis 协议 - -我们通过Pegasus Redis Proxy这一组件在Pegasus协议之上支持了Redis协议。 -你可以阅读 [Redis适配](/redis) 了解更多。 - -因为Redis接口提供了GEO支持，我们也借此支持了地理信息查询的功能。 -你可以阅读 [GEO支持](/geo) 了解更多。 diff --git a/_clients/go-client.md b/_clients/go-client.md deleted file mode 100755 index 37f7b02..0000000 --- a/_clients/go-client.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Go客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu ---- - -## 项目地址 - -<https://github.com/XiaoMi/pegasus-go-client> - -## 版本要求 - -``` ->= go 1.8 -``` - -## 安装 - -``` -go get github.com/XiaoMi/pegasus-go-client -``` - -## 使用 - -### 示例 - -完整的示例请参考[example](https://github.com/XiaoMi/pegasus-go-client/tree/master/example)。 - -### log配置文件 - -go-client 提供了简单的日志接口 pegalog，用户可以使用现有的日志库来实现该接口，go-client 会经由该接口来打印内部日志。 - -```go -type Logger interface { - Fatal(args ...interface{}) - Fatalf(format string, args ...interface{}) - Fatalln(args ...interface{}) - Print(args ...interface{}) - Printf(format string, args ...interface{}) - Println(args ...interface{}) -} -``` - -### 注意事项 - -go-client 提供了两种客户端实现以应付不同的使用场景，它们使用相同的接口，但实现分别放在不同的两个包下： - -- **pegasus**: RPC 采用 pipeline 实现，即不等待服务端（单指某一 server，server 之间的 RPC 互不影响）发回消息响应就发送下一条消息。这种实现的好处在于吞吐大，延时小，缺点在于实现较为复杂。在我们的性能测试（使用[pingcap/go-ycsb](https://github.com/pingcap/go-ycsb)）中，使用该实现的 go-client 仅用一个实例即可把拥有5个 replica-server 的服务打满（[issue-4](https://github.com/XiaoMi/pegasus-go-client/issues/4)）。我们**推荐使用这一实现**。 - -- **pegasus2**: RPC 采用非 pipeline 实现，即 RPC 依次进行，只有等待上一条消息成功收到服务端的响应，才可发下一条消息。这种做法的性能较差，但有些业务青睐于它的实现简单。使用 pegasus2 的用户通常需要为一张表维护多个 `TableConnector` 才能够满足性能要求，其中每个 `TableConnector` 对每个 replica server 会维护一个 tcp 连接。我们推荐使用连接池的方式，根据请求数动态调节池中 `TableConnector` 的数量。 diff --git a/_clients/index.md b/_clients/index.md deleted file mode 100644 index 8268d67..0000000 --- a/_clients/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 客户端库 -layout: page -show_sidebar: false -menubar: clients_menu ---- - -Pegasus目前提供以下多种客户端支持： - -| 编程语言 | 项目链接 | -| Java | <https://github.com/XiaoMi/pegasus-java-client> | -| Scala | <https://github.com/XiaoMi/pegasus-scala-client> | -| Go | <https://github.com/XiaoMi/pegasus-go-client> | -| Python | <https://github.com/XiaoMi/pegasus-python-client> | -| NodeJs | <https://github.com/XiaoMi/pegasus-nodejs-client.git> | diff --git a/_data/docs_menu.yml b/_data/docs_menu.yml index 811260f..928fc75 100644 --- a/_data/docs_menu.yml +++ b/_data/docs_menu.yml @@ -1,28 +1,28 @@ - name: title_clients items: - - name: title_java_client + - name: title_java-client link: /docs/clients/java-client - - name: title_cpp_client + - name: title_cpp-client link: /docs/clients/cpp-client - - name: title_go_client + - name: title_go-client link: /docs/clients/go-client - - name: title_python_client + - name: title_python-client link: /docs/clients/python-client - - name: title_nodejs_client + - name: title_node-client link: /docs/clients/node-client - - name: title_scala_client + - name: title_scala-client link: /docs/clients/scala-client - name: title_api items: - name: title_ttl link: /docs/api/ttl - - name: title_single_atomic + - name: title_single-atomic link: /docs/api/single-atomic - - name: title_redis_api + - name: title_redis link: /docs/api/redis - - name: title_geo_support + - name: title_geo link: /docs/api/geo - - name: title_http_api + - name: title_http link: /docs/api/http - name: title_administration items: @@ -37,7 +37,7 @@ - name: title_rolling-update link: /docs/administration/rolling-update - name: title_scale-in-out - link: /docs/administration/membership-change + link: /docs/administration/scale-in-out - name: title_resource-management link: /docs/administration/resource-management - name: title_cold-backup diff --git a/_data/en/translate.yml b/_data/en/translate.yml index 96fb65d..6257876 100644 --- a/_data/en/translate.yml +++ b/_data/en/translate.yml @@ -4,7 +4,6 @@ title_installation: "Installation" title_architecture: "Architecture" title_data-model: "Data Model" title_documentation: "Docs" -title_clientlibs: "ClientLibs" title_api: "API" title_administration: "Admin" title_blog: "Blog" @@ -20,3 +19,43 @@ title_releases: "Releases" title_benchmark: "Benchmark" title_onebox: "Onebox" title_shell: "Pegasus Shell" +title_java-client: "Java Client" +title_cpp-client: "C++ Client" +title_go-client: "Golang Client" +title_python-client: "Python Client" +title_node-client: "NodeJS Client" +title_scala-client: "Scala Client" +title_clients: "Client Libs" +title_api: "API" +title_ttl: "TTL(Time To Live)" +title_single-atomic: "Single-Atomic Operations" +title_redis: "Redis Adaption" +title_geo: "GEO Support" +title_http: "HTTP API" +title_deployment: "Deployment" +title_config: "Configurations" +title_rebalance: "Rebalance" +title_monitoring: "Monitoring" +title_rolling-update: "Rolling-Update" +title_scale-in-out: "Scale-in and Scale-out" +title_resource-management: "Resource Management" +title_cold-backup: "Cold Backup" +title_meta-recovery: "Metadata Recovery" +title_replica-recovery: "Replica Data Recovery" +title_zk-migration: "Zookeeper Migration" +title_table-migration: "Table Migration" +title_table-soft-delete: "Table Soft-Delete" +title_table-env: "Table Environment Variables" +title_remote-commands: "Remote Command" +title_partition-split: "Partition-Split" +title_duplication: "Duplication" +title_compression: "Data Compression" +title_throttling: "Throttling" +title_experiences: "Experiences" +title_manual-compact: "Manual Compact" +title_usage-scenario: "Usage Scenario" +title_bad-disk: "Bad Disk Repair" +title_whitelist: "Whitelist" +title_backup-request: "Backup Request" +title_docs: "The Pegasus documentation" +global_toc: "Table of contents" diff --git a/_data/zh/translate.yml b/_data/zh/translate.yml index 65cdc25..67ed68c 100644 --- a/_data/zh/translate.yml +++ b/_data/zh/translate.yml @@ -4,7 +4,6 @@ title_installation: "编译构建" title_architecture: "系统架构" title_data-model: "数据模型" title_documentation: "文档" -title_clientlibs: "客户端库" title_api: "用户接口" title_administration: "高效运维" title_blog: "Blog" @@ -20,19 +19,19 @@ title_releases: "版本发布" title_benchmark: "性能测试" title_onebox: "体验Onebox集群" title_shell: "Pegasus Shell 工具" -title_java_client: "Java客户端" -title_cpp_client: "C++客户端" -title_go_client: "Golang客户端" -title_python_client: "Python客户端" -title_nodejs_client: "NodeJS客户端" -title_scala_client: "Scala客户端" +title_java-client: "Java客户端" +title_cpp-client: "C++客户端" +title_go-client: "Golang客户端" +title_python-client: "Python客户端" +title_node-client: "NodeJS客户端" +title_scala-client: "Scala客户端" title_clients: "客户端库" title_api: "用户接口" title_ttl: "TTL" -title_single_atomic: "单行原子操作" -title_redis_api: "Redis适配" -title_geo_support: "GEO支持" -title_http_api: "HTTP接口" +title_single-atomic: "单行原子操作" +title_redis: "Redis适配" +title_geo: "GEO支持" +title_http: "HTTP接口" title_deployment: "集群部署" title_config: "配置说明" title_rebalance: "负载均衡" @@ -58,3 +57,5 @@ title_usage-scenario: "Usage Scenario功能" title_bad-disk: "坏盘检修" title_whitelist: "白名单" title_backup-request: "Backup Request" +title_docs: "Pegasus产品文档" +global_toc: "本页导航" diff --git a/_docs/en/administration/backup-request.md b/_docs/en/administration/backup-request.md new file mode 100644 index 0000000..d85ca17 --- /dev/null +++ b/_docs/en/administration/backup-request.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/backup-request +--- + +TRANSLATING \ No newline at end of file diff --git a/_docs/en/administration/bad-disk.md b/_docs/en/administration/bad-disk.md new file mode 100644 index 0000000..4088397 --- /dev/null +++ b/_docs/en/administration/bad-disk.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/bad-disk +--- + +TRANSLATING \ No newline at end of file diff --git a/_docs/en/administration/cold-backup.md b/_docs/en/administration/cold-backup.md new file mode 100755 index 0000000..b789bb9 --- /dev/null +++ b/_docs/en/administration/cold-backup.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/cold-backup +--- + +TRANSLATING diff --git a/_docs/en/administration/compression.md b/_docs/en/administration/compression.md new file mode 100755 index 0000000..3e98707 --- /dev/null +++ b/_docs/en/administration/compression.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/compression +--- + +TRANSLATING diff --git a/_docs/en/administration/config.md b/_docs/en/administration/config.md new file mode 100644 index 0000000..dc9bd59 --- /dev/null +++ b/_docs/en/administration/config.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/config +--- + +TRANSLATING diff --git a/_docs/en/administration/deployment.md b/_docs/en/administration/deployment.md new file mode 100755 index 0000000..3e105de --- /dev/null +++ b/_docs/en/administration/deployment.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/deployment +--- + +TRANSLATING diff --git a/_docs/en/administration/duplication.md b/_docs/en/administration/duplication.md new file mode 100644 index 0000000..5e6e318 --- /dev/null +++ b/_docs/en/administration/duplication.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/duplication +--- + +TRANSLATING diff --git a/_docs/en/administration/experiences.md b/_docs/en/administration/experiences.md new file mode 100644 index 0000000..03f4ccc --- /dev/null +++ b/_docs/en/administration/experiences.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/experiences +--- + +TRANSLATING diff --git a/_docs/en/administration/index.md b/_docs/en/administration/index.md new file mode 100644 index 0000000..d30b1c1 --- /dev/null +++ b/_docs/en/administration/index.md @@ -0,0 +1,5 @@ +--- +menubar: administration_menu +--- + +TRANSLATING diff --git a/_docs/en/administration/manual-compact.md b/_docs/en/administration/manual-compact.md new file mode 100644 index 0000000..f5c13c2 --- /dev/null +++ b/_docs/en/administration/manual-compact.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/manual-compact +--- + +TRANSLATING diff --git a/_docs/en/administration/meta-recovery.md b/_docs/en/administration/meta-recovery.md new file mode 100644 index 0000000..78fa197 --- /dev/null +++ b/_docs/en/administration/meta-recovery.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/meta-recovery +--- + +TRANSLATING diff --git a/_docs/en/administration/monitoring.md b/_docs/en/administration/monitoring.md new file mode 100644 index 0000000..1065388 --- /dev/null +++ b/_docs/en/administration/monitoring.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/monitoring +--- + +TRANSLATING diff --git a/_docs/en/administration/partition-split.md b/_docs/en/administration/partition-split.md new file mode 100644 index 0000000..d014a9c --- /dev/null +++ b/_docs/en/administration/partition-split.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/partition-split +--- + +TRANSLATING diff --git a/_docs/en/administration/rebalance.md b/_docs/en/administration/rebalance.md new file mode 100644 index 0000000..96f2675 --- /dev/null +++ b/_docs/en/administration/rebalance.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/rebalance +--- + +TRANSLATING diff --git a/_docs/en/administration/remote-commands.md b/_docs/en/administration/remote-commands.md new file mode 100644 index 0000000..737219e --- /dev/null +++ b/_docs/en/administration/remote-commands.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/remote-commands +--- + +TRANSLATING diff --git a/_docs/en/administration/replica-recovery.md b/_docs/en/administration/replica-recovery.md new file mode 100644 index 0000000..5e00d01 --- /dev/null +++ b/_docs/en/administration/replica-recovery.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/replica-recovery +--- + +TRANSLATING diff --git a/_docs/en/administration/resource-management.md b/_docs/en/administration/resource-management.md new file mode 100644 index 0000000..57acc8f --- /dev/null +++ b/_docs/en/administration/resource-management.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/resource-management +--- + +TRANSLATING diff --git a/_docs/en/administration/rolling-update.md b/_docs/en/administration/rolling-update.md new file mode 100644 index 0000000..7ea89b2 --- /dev/null +++ b/_docs/en/administration/rolling-update.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/rolling-update +--- + +TRANSLATING diff --git a/_docs/en/administration/scale-in-out.md b/_docs/en/administration/scale-in-out.md new file mode 100644 index 0000000..47f4657 --- /dev/null +++ b/_docs/en/administration/scale-in-out.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/scale-in-out +--- + +TRANSLATING diff --git a/_docs/en/administration/table-env.md b/_docs/en/administration/table-env.md new file mode 100644 index 0000000..149fafa --- /dev/null +++ b/_docs/en/administration/table-env.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/table-env +--- + +TRANSLATING diff --git a/_docs/en/administration/table-migration.md b/_docs/en/administration/table-migration.md new file mode 100644 index 0000000..749168e --- /dev/null +++ b/_docs/en/administration/table-migration.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/table-migration +--- + +TRANSLATING diff --git a/_docs/en/administration/table-soft-delete.md b/_docs/en/administration/table-soft-delete.md new file mode 100644 index 0000000..3061c8d --- /dev/null +++ b/_docs/en/administration/table-soft-delete.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/table-soft-delete +--- + +TRANSLATING diff --git a/_docs/en/administration/throttling.md b/_docs/en/administration/throttling.md new file mode 100755 index 0000000..cb63028 --- /dev/null +++ b/_docs/en/administration/throttling.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/throttling +--- + +TRANSLATING diff --git a/_docs/en/administration/usage-scenario.md b/_docs/en/administration/usage-scenario.md new file mode 100644 index 0000000..8d672a5 --- /dev/null +++ b/_docs/en/administration/usage-scenario.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/usage-scenario +--- + +TRANSLATING diff --git a/_docs/en/administration/whitelist.md b/_docs/en/administration/whitelist.md new file mode 100644 index 0000000..56ad2ca --- /dev/null +++ b/_docs/en/administration/whitelist.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/whitelist +--- + +TRANSLATING diff --git a/_docs/en/administration/zk-migration.md b/_docs/en/administration/zk-migration.md new file mode 100644 index 0000000..c23af4a --- /dev/null +++ b/_docs/en/administration/zk-migration.md @@ -0,0 +1,5 @@ +--- +permalink: docs/administration/zk-migration +--- + +TRANSLATING diff --git a/_docs/en/api/geo.md b/_docs/en/api/geo.md new file mode 100755 index 0000000..971e690 --- /dev/null +++ b/_docs/en/api/geo.md @@ -0,0 +1,5 @@ +--- +permalink: docs/api/geo +--- + +TRANSLATING diff --git a/_docs/en/api/http.md b/_docs/en/api/http.md new file mode 100644 index 0000000..59be25e --- /dev/null +++ b/_docs/en/api/http.md @@ -0,0 +1,5 @@ +--- +permalink: docs/api/http +--- + +TRANSLATING diff --git a/_docs/en/api/redis.md b/_docs/en/api/redis.md new file mode 100644 index 0000000..10cee8c --- /dev/null +++ b/_docs/en/api/redis.md @@ -0,0 +1,5 @@ +--- +permalink: docs/api/redis +--- + +TRANSLATING diff --git a/_docs/en/api/single-atomic.md b/_docs/en/api/single-atomic.md new file mode 100755 index 0000000..f983c34 --- /dev/null +++ b/_docs/en/api/single-atomic.md @@ -0,0 +1,5 @@ +--- +permalink: docs/api/single-atomic +--- + +TRANSLATING diff --git a/_docs/en/api/ttl.md b/_docs/en/api/ttl.md new file mode 100755 index 0000000..bd8f19b --- /dev/null +++ b/_docs/en/api/ttl.md @@ -0,0 +1,5 @@ +--- +permalink: docs/api/ttl +--- + +TRANSLATING diff --git a/_docs/en/clients/cpp-client.md b/_docs/en/clients/cpp-client.md new file mode 100755 index 0000000..f16552d --- /dev/null +++ b/_docs/en/clients/cpp-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/cpp-client +--- + +TRANSLATING diff --git a/_docs/en/clients/go-client.md b/_docs/en/clients/go-client.md new file mode 100755 index 0000000..26e1291 --- /dev/null +++ b/_docs/en/clients/go-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/go-client +--- + +TRANSLATING diff --git a/_docs/en/clients/java-client.md b/_docs/en/clients/java-client.md new file mode 100755 index 0000000..f2b208b --- /dev/null +++ b/_docs/en/clients/java-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/java-client +--- + +TRANSLATING diff --git a/_docs/en/clients/node-client.md b/_docs/en/clients/node-client.md new file mode 100755 index 0000000..661cad4 --- /dev/null +++ b/_docs/en/clients/node-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/node-client +--- + +TRANSLATING diff --git a/_docs/en/clients/python-client.md b/_docs/en/clients/python-client.md new file mode 100755 index 0000000..cd6f13c --- /dev/null +++ b/_docs/en/clients/python-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/python-client +--- + +TRANSLATING diff --git a/_docs/en/clients/scala-client.md b/_docs/en/clients/scala-client.md new file mode 100755 index 0000000..c23d8b8 --- /dev/null +++ b/_docs/en/clients/scala-client.md @@ -0,0 +1,5 @@ +--- +permalink: docs/clients/scala-client +--- + +TRANSLATING diff --git a/_docs/en/docs.md b/_docs/en/docs.md new file mode 100644 index 0000000..a11eb32 --- /dev/null +++ b/_docs/en/docs.md @@ -0,0 +1,4 @@ +--- +permalink: /docs/index.html +--- + diff --git a/_administration/backup-request.md b/_docs/zh/administration/backup-request.md similarity index 97% rename from _administration/backup-request.md rename to _docs/zh/administration/backup-request.md index 3eb0e1b..ead784c 100644 --- a/_administration/backup-request.md +++ b/_docs/zh/administration/backup-request.md @@ -1,7 +1,5 @@ --- -title: Backup Request -layout: page -menubar: administration_menu +permalink: docs/administration/backup-request --- # 背景 diff --git a/_administration/bad-disk.md b/_docs/zh/administration/bad-disk.md similarity index 97% rename from _administration/bad-disk.md rename to _docs/zh/administration/bad-disk.md index 0d91a87..305c02e 100644 --- a/_administration/bad-disk.md +++ b/_docs/zh/administration/bad-disk.md @@ -1,7 +1,5 @@ --- -title: 坏盘检修 -layout: page -menubar: administration_menu +permalink: docs/administration/bad-disk --- 磁盘故障时有发生，通常有下列检查方式： diff --git a/_administration/cold-backup.md b/_docs/zh/administration/cold-backup.md similarity index 99% rename from _administration/cold-backup.md rename to _docs/zh/administration/cold-backup.md index 902a743..093de88 100755 --- a/_administration/cold-backup.md +++ b/_docs/zh/administration/cold-backup.md @@ -1,7 +1,5 @@ --- -title: 冷备份 -layout: page -menubar: administration_menu +permalink: docs/administration/cold-backup --- ## 介绍 diff --git a/_administration/compression.md b/_docs/zh/administration/compression.md similarity index 97% rename from _administration/compression.md rename to _docs/zh/administration/compression.md index 512a973..bf65691 100755 --- a/_administration/compression.md +++ b/_docs/zh/administration/compression.md @@ -1,7 +1,5 @@ --- -title: 数据压缩 -layout: page -menubar: administration_menu +permalink: docs/administration/compression --- # 客户端压缩 diff --git a/_administration/config.md b/_docs/zh/administration/config.md similarity index 99% rename from _administration/config.md rename to _docs/zh/administration/config.md index 372c105..827d13b 100644 --- a/_administration/config.md +++ b/_docs/zh/administration/config.md @@ -1,7 +1,5 @@ --- -title: 配置说明 -layout: page -menubar: administration_menu +permalink: docs/administration/config --- ## 配置组成部分 diff --git a/_administration/deployment.md b/_docs/zh/administration/deployment.md similarity index 98% rename from _administration/deployment.md rename to _docs/zh/administration/deployment.md index 73343d2..cba53c0 100755 --- a/_administration/deployment.md +++ b/_docs/zh/administration/deployment.md @@ -1,11 +1,7 @@ --- -title: 集群部署 -layout: page -menubar: administration_menu +permalink: docs/administration/deployment --- -# 集群部署 - ## 准备机器 Pegasus分布式集群至少需要准备这些机器： * MetaServer：2~3台机器，无需SSD盘。 diff --git a/_administration/duplication.md b/_docs/zh/administration/duplication.md similarity index 99% rename from _administration/duplication.md rename to _docs/zh/administration/duplication.md index c337bc0..6a3b2c7 100644 --- a/_administration/duplication.md +++ b/_docs/zh/administration/duplication.md @@ -1,7 +1,5 @@ --- -title: 跨机房同步 -layout: page -menubar: administration_menu +permalink: docs/administration/duplication --- 在 pegasus 中，跨机房同步又被称为 **_热备份_**，或 **_duplication_**，简称 **_dup_**。这一功能的主要目的是保证 **数据中心级别的可用性**。当业务需要保证服务与数据能够容忍机房故障时，可以考虑使用此功能。 diff --git a/_administration/experiences.md b/_docs/zh/administration/experiences.md similarity index 98% rename from _administration/experiences.md rename to _docs/zh/administration/experiences.md index 5b351ee..dc911d6 100644 --- a/_administration/experiences.md +++ b/_docs/zh/administration/experiences.md @@ -1,7 +1,5 @@ --- -title: 运维经验 -layout: page -menubar: administration_menu +permalink: docs/administration/experiences --- 任何一个分布式系统的运维工作都少不了周期巡检，问题排查，故障报警，人工审核。它们是保证服务稳定运行的关键。 diff --git a/_administration/index.md b/_docs/zh/administration/index.md similarity index 98% rename from _administration/index.md rename to _docs/zh/administration/index.md index e76d369..ff40fc9 100644 --- a/_administration/index.md +++ b/_docs/zh/administration/index.md @@ -1,6 +1,4 @@ --- -title: 高效运维 -layout: page menubar: administration_menu --- diff --git a/_administration/manual-compact.md b/_docs/zh/administration/manual-compact.md similarity index 99% rename from _administration/manual-compact.md rename to _docs/zh/administration/manual-compact.md index 9a95d1f..feb9e60 100644 --- a/_administration/manual-compact.md +++ b/_docs/zh/administration/manual-compact.md @@ -1,7 +1,5 @@ --- -title: Manual Compact功能 -layout: page -menubar: administration_menu +permalink: docs/administration/manual-compact --- 注：manual compact功能从[v1.8.1版本](https://github.com/XiaoMi/pegasus/releases/tag/v1.8.1)开始支持。 diff --git a/_administration/meta-recovery.md b/_docs/zh/administration/meta-recovery.md similarity index 99% rename from _administration/meta-recovery.md rename to _docs/zh/administration/meta-recovery.md index b15e48d..d9cc911 100644 --- a/_administration/meta-recovery.md +++ b/_docs/zh/administration/meta-recovery.md @@ -1,8 +1,5 @@ --- -title: 元数据恢复 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/meta-recovery --- # 功能目标 diff --git a/_administration/monitoring.md b/_docs/zh/administration/monitoring.md similarity index 96% rename from _administration/monitoring.md rename to _docs/zh/administration/monitoring.md index 2e6c5d1..820a325 100644 --- a/_administration/monitoring.md +++ b/_docs/zh/administration/monitoring.md @@ -1,7 +1,5 @@ --- -title: 可视化监控 -layout: page -menubar: administration_menu +permalink: docs/administration/monitoring --- ## 组件 diff --git a/_administration/partition-split.md b/_docs/zh/administration/partition-split.md similarity index 99% rename from _administration/partition-split.md rename to _docs/zh/administration/partition-split.md index b733e4b..fb229fd 100644 --- a/_administration/partition-split.md +++ b/_docs/zh/administration/partition-split.md @@ -1,7 +1,5 @@ --- -title: Partition Split -layout: page -menubar: administration_menu +permalink: docs/administration/partition-split --- # 功能简介 diff --git a/_administration/rebalance.md b/_docs/zh/administration/rebalance.md similarity index 99% rename from _administration/rebalance.md rename to _docs/zh/administration/rebalance.md index 2576e3b..c0054a4 100644 --- a/_administration/rebalance.md +++ b/_docs/zh/administration/rebalance.md @@ -1,7 +1,5 @@ --- -title: 负载均衡 -layout: page -menubar: administration_menu +permalink: docs/administration/rebalance --- 本文档主要介绍Pegasus负载均衡的概念、使用和设计。 diff --git a/_administration/remote-commands.md b/_docs/zh/administration/remote-commands.md similarity index 98% rename from _administration/remote-commands.md rename to _docs/zh/administration/remote-commands.md index 7406e51..e7368cd 100644 --- a/_administration/remote-commands.md +++ b/_docs/zh/administration/remote-commands.md @@ -1,8 +1,5 @@ --- -title: 远程命令 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/remote-commands --- # 功能目标 diff --git a/_administration/replica-recovery.md b/_docs/zh/administration/replica-recovery.md similarity index 98% rename from _administration/replica-recovery.md rename to _docs/zh/administration/replica-recovery.md index b3e2ac2..088eb4b 100644 --- a/_administration/replica-recovery.md +++ b/_docs/zh/administration/replica-recovery.md @@ -1,7 +1,5 @@ --- -title: Replica数据恢复 -layout: page -menubar: administration_menu +permalink: docs/administration/replica-recovery --- # 原理 diff --git a/_administration/resource-management.md b/_docs/zh/administration/resource-management.md similarity index 99% rename from _administration/resource-management.md rename to _docs/zh/administration/resource-management.md index 0675260..f821754 100644 --- a/_administration/resource-management.md +++ b/_docs/zh/administration/resource-management.md @@ -1,7 +1,5 @@ --- -title: 资源管理 -layout: page -menubar: administration_menu +permalink: docs/administration/resource-management --- # 背景介绍 diff --git a/_administration/rolling-update.md b/_docs/zh/administration/rolling-update.md similarity index 99% rename from _administration/rolling-update.md rename to _docs/zh/administration/rolling-update.md index e5e2078..951b531 100644 --- a/_administration/rolling-update.md +++ b/_docs/zh/administration/rolling-update.md @@ -1,8 +1,5 @@ --- -title: 集群升级 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/rolling-update --- # 功能目标 diff --git a/_administration/membership-change.md b/_docs/zh/administration/scale-in-out.md similarity index 98% rename from _administration/membership-change.md rename to _docs/zh/administration/scale-in-out.md index 1dd0c6e..1c8bc6a 100644 --- a/_administration/membership-change.md +++ b/_docs/zh/administration/scale-in-out.md @@ -1,8 +1,5 @@ --- -title: 集群扩容缩容 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/scale-in-out --- # 功能目标 diff --git a/_administration/table-env.md b/_docs/zh/administration/table-env.md similarity index 98% rename from _administration/table-env.md rename to _docs/zh/administration/table-env.md index 636c0e5..d6ba7d7 100644 --- a/_administration/table-env.md +++ b/_docs/zh/administration/table-env.md @@ -1,8 +1,5 @@ --- -title: Table环境变量 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/table-env --- # 功能目标 diff --git a/_administration/table-migration.md b/_docs/zh/administration/table-migration.md similarity index 96% rename from _administration/table-migration.md rename to _docs/zh/administration/table-migration.md index f31290e..4634796 100644 --- a/_administration/table-migration.md +++ b/_docs/zh/administration/table-migration.md @@ -1,8 +1,5 @@ --- -title: Table迁移 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/table-migration --- 这里说的Table迁移是指将某个Pegasus集群的一个表的数据迁移到另一个Pegasus集群中。 diff --git a/_administration/table-soft-delete.md b/_docs/zh/administration/table-soft-delete.md similarity index 98% rename from _administration/table-soft-delete.md rename to _docs/zh/administration/table-soft-delete.md index 32eb4ea..b32cbf7 100644 --- a/_administration/table-soft-delete.md +++ b/_docs/zh/administration/table-soft-delete.md @@ -1,8 +1,5 @@ --- -title: Table软删除 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/table-soft-delete --- # 功能目标 diff --git a/_administration/throttling.md b/_docs/zh/administration/throttling.md similarity index 98% rename from _administration/throttling.md rename to _docs/zh/administration/throttling.md index a98bbdb..2bd5772 100755 --- a/_administration/throttling.md +++ b/_docs/zh/administration/throttling.md @@ -1,8 +1,5 @@ --- -title: 流量控制 -layout: page -show_sidebar: false -menubar: administration_menu +permalink: docs/administration/throttling --- # 关于流控 diff --git a/_administration/usage-scenario.md b/_docs/zh/administration/usage-scenario.md similarity index 99% rename from _administration/usage-scenario.md rename to _docs/zh/administration/usage-scenario.md index e880c7e..acd34c0 100644 --- a/_administration/usage-scenario.md +++ b/_docs/zh/administration/usage-scenario.md @@ -1,7 +1,5 @@ --- -title: Usage Scenario功能 -layout: page -menubar: administration_menu +permalink: docs/administration/usage-scenario --- 注：Usage Scenario功能从[v1.8.1版本](https://github.com/XiaoMi/pegasus/releases/tag/v1.8.1)开始支持。 diff --git a/_administration/whitelist.md b/_docs/zh/administration/whitelist.md similarity index 95% rename from _administration/whitelist.md rename to _docs/zh/administration/whitelist.md index c23a93d..1df99e3 100644 --- a/_administration/whitelist.md +++ b/_docs/zh/administration/whitelist.md @@ -1,7 +1,5 @@ --- -title: 白名单 -layout: page -menubar: administration_menu +permalink: docs/administration/whitelist --- ## 介绍 diff --git a/_administration/zk-migration.md b/_docs/zh/administration/zk-migration.md similarity index 98% rename from _administration/zk-migration.md rename to _docs/zh/administration/zk-migration.md index 47b2b02..8abe68e 100644 --- a/_administration/zk-migration.md +++ b/_docs/zh/administration/zk-migration.md @@ -1,7 +1,5 @@ --- -title: Zookeeper迁移 -layout: page -menubar: administration_menu +permalink: docs/administration/zk-migration --- 由于Pegasus的meta server依赖Zookeeper存储元数据和抢主，所以Zookeeper服务的不稳定会造成Pegasus服务不稳定，有时就需要迁移到其他更稳定或者空闲的Zookeeper上。 diff --git a/_api/geo.md b/_docs/zh/api/geo.md similarity index 99% rename from _api/geo.md rename to _docs/zh/api/geo.md index f8ec490..ae750ad 100755 --- a/_api/geo.md +++ b/_docs/zh/api/geo.md @@ -1,7 +1,5 @@ --- -title: GEO支持 -layout: page -menubar: api_menu +permalink: docs/api/geo --- # Pegasus GEO支持 diff --git a/_api/http.md b/_docs/zh/api/http.md similarity index 99% rename from _api/http.md rename to _docs/zh/api/http.md index f92d119..0ad811a 100644 --- a/_api/http.md +++ b/_docs/zh/api/http.md @@ -1,8 +1,5 @@ --- -title: HTTP接口 -layout: page -show_sidebar: false -menubar: api_menu +permalink: docs/api/http --- ## 功能介绍 diff --git a/_api/redis.md b/_docs/zh/api/redis.md similarity index 99% rename from _api/redis.md rename to _docs/zh/api/redis.md index 40de7fe..44701f2 100644 --- a/_api/redis.md +++ b/_docs/zh/api/redis.md @@ -1,7 +1,5 @@ --- -title: Redis适配 -layout: page -menubar: api_menu +permalink: docs/api/redis --- # Redis适配 diff --git a/_api/single-atomic.md b/_docs/zh/api/single-atomic.md similarity index 98% rename from _api/single-atomic.md rename to _docs/zh/api/single-atomic.md index 87c407d..957b65d 100755 --- a/_api/single-atomic.md +++ b/_docs/zh/api/single-atomic.md @@ -1,8 +1,5 @@ --- -title: 单行原子操作 -layout: page -show_sidebar: false -menubar: api_menu +permalink: docs/api/single-atomic --- 从[v1.10.0版本](https://github.com/XiaoMi/pegasus/releases/tag/v1.10.0)开始，Pegasus支持单行原子操作。这里的**单行**是指同一HashKey下的所有数据。 diff --git a/_api/ttl.md b/_docs/zh/api/ttl.md similarity index 99% rename from _api/ttl.md rename to _docs/zh/api/ttl.md index f8b766a..53d9449 100755 --- a/_api/ttl.md +++ b/_docs/zh/api/ttl.md @@ -1,7 +1,5 @@ --- -title: TTL -layout: page -menubar: api_menu +permalink: docs/api/ttl --- # 原理 diff --git a/_clients/cpp-client.md b/_docs/zh/clients/cpp-client.md similarity index 99% rename from _clients/cpp-client.md rename to _docs/zh/clients/cpp-client.md index 3d6e90d..d46424a 100755 --- a/_clients/cpp-client.md +++ b/_docs/zh/clients/cpp-client.md @@ -1,8 +1,5 @@ --- -title: C++客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu +permalink: docs/clients/cpp-client --- # 获取Cpp客户端 diff --git a/_docs/zh/clients/go-client.md b/_docs/zh/clients/go-client.md new file mode 100755 index 0000000..f65b966 --- /dev/null +++ b/_docs/zh/clients/go-client.md @@ -0,0 +1,40 @@ +--- +permalink: docs/clients/go-client +--- + +## 项目地址 + +<https://github.com/XiaoMi/pegasus-go-client> + +## 版本要求 + +``` +>= go 1.8 +``` + +## 安装 + +``` +go get github.com/XiaoMi/pegasus-go-client +``` + +## 使用 + +### 示例 + +完整的示例请参考[example](https://github.com/XiaoMi/pegasus-go-client/tree/master/example)。 + +### log配置文件 + +go-client 提供了简单的日志接口 pegalog，用户可以使用现有的日志库来实现该接口，go-client 会经由该接口来打印内部日志。 + +```go +type Logger interface { + Fatal(args ...interface{}) + Fatalf(format string, args ...interface{}) + Fatalln(args ...interface{}) + Print(args ...interface{}) + Printf(format string, args ...interface{}) + Println(args ...interface{}) +} +``` diff --git a/_clients/java-client.md b/_docs/zh/clients/java-client.md similarity index 99% rename from _clients/java-client.md rename to _docs/zh/clients/java-client.md index 8d79c9b..4eb5ffc 100755 --- a/_clients/java-client.md +++ b/_docs/zh/clients/java-client.md @@ -1,8 +1,5 @@ --- -title: Java客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu +permalink: docs/clients/java-client --- # 获取Java客户端 diff --git a/_clients/node-client.md b/_docs/zh/clients/node-client.md similarity index 99% rename from _clients/node-client.md rename to _docs/zh/clients/node-client.md index 02f45a9..a4fde26 100755 --- a/_clients/node-client.md +++ b/_docs/zh/clients/node-client.md @@ -1,8 +1,5 @@ --- -title: NodeJs客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu +permalink: docs/clients/node-client --- # 安装NodeJs客户端 diff --git a/_clients/python-client.md b/_docs/zh/clients/python-client.md similarity index 99% rename from _clients/python-client.md rename to _docs/zh/clients/python-client.md index 76a7651..ae1a01a 100755 --- a/_clients/python-client.md +++ b/_docs/zh/clients/python-client.md @@ -1,8 +1,5 @@ --- -title: Python客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu +permalink: docs/clients/python-client --- # pegasus python client diff --git a/_clients/scala-client.md b/_docs/zh/clients/scala-client.md similarity index 99% rename from _clients/scala-client.md rename to _docs/zh/clients/scala-client.md index 6656aba..5947928 100755 --- a/_clients/scala-client.md +++ b/_docs/zh/clients/scala-client.md @@ -1,8 +1,5 @@ --- -title: Scala客户端文档 -layout: page -show_sidebar: false -menubar: clients_menu +permalink: docs/clients/scala-client --- diff --git a/_docs/zh/docs.md b/_docs/zh/docs.md new file mode 100644 index 0000000..a11eb32 --- /dev/null +++ b/_docs/zh/docs.md @@ -0,0 +1,4 @@ +--- +permalink: /docs/index.html +--- + diff --git a/_includes/searchbox.html b/_includes/searchbox.html new file mode 100644 index 0000000..97f16d6 --- /dev/null +++ b/_includes/searchbox.html @@ -0,0 +1,11 @@ +<div class="navbar-searchbox w-full bg-gray-200"> + <div class="field"> + <div class="control has-icons-right"> + <input class="input searchbox-input focus:placeholder-transparent" + type="text" placeholder="Search the docs"> + <span class="icon is-right"> + <i class="fas fa-search searchbox-icon"></i> + </span> + </div> + </div> +</div> \ No newline at end of file diff --git a/_includes/toc.html b/_includes/toc.html index 8734fbe..20ac9d5 100644 --- a/_includes/toc.html +++ b/_includes/toc.html @@ -1,3 +1,9 @@ +<p class="menu-label"> + <span class="icon"> + <i class="fa fa-bars" aria-hidden="true"></i> + </span> + {{ site.data.translate[global_toc] }} +</p> {% capture tocWorkspace %} {% comment %} Version 1.0.7 diff --git a/_layouts/docs.html b/_layouts/docs.html new file mode 100644 index 0000000..1f15426 --- /dev/null +++ b/_layouts/docs.html @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html> +{% include head.html %} + +<body> + <div class="dashboard is-full-height"> + <!-- left panel --> + <div class="dashboard-panel is-medium is-hidden-mobile"> + <div class="dashboard-panel-header has-text-left"> + <a href="{{ site.baseurl }}/"> + <img src="{{ site.baseurl }}/assets/images/pegasus-logo-inv.png" style="width: 80%;"> + </a> + <a class="dropdown"> + </a> + </div> + <div class="dashboard-panel-main is-scrollable"> + {% include menubar.html %} + </div> + </div> + + <!-- main section --> + <div class="dashboard-main is-scrollable"> + {% include docs_header.html %} + + <section class="hero is-info"> + <div class="hero-body"> + {% assign page_title = page.slug | prepend: 'title_' %} + <p class="title is-size-2 is-centered">{{ site.data.translate[page_title] }}</p> + </div> + </section> + <section class="section"> + <div class="content"> + {{ content }} + </div> + </section> + {% include footer.html %} + </div> + + <!-- right panel --> + <div class="dashboard-panel is-small is-scrollable is-hidden-mobile"> + {% include toc.html html=content class="menu-list" sanitize=true %} + </div> + </div> + + <script src="{{ site.baseurl }}/assets/js/app.js" type="text/javascript"></script> +</body> + +{% include algolia.html %} + +</html> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
