You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pegasus.apache.org by wu...@apache.org on 2020/10/27 02:28:45 UTC
[incubator-pegasus-website] branch master updated: update community
page and installation guide
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
The following commit(s) were added to refs/heads/master by this push:
new 96356be update community page and installation guide
96356be is described below
commit 96356be3cc43636e8f1fd675cdad325e6ad3928a
Author: neverchanje <wu...@gmail.com>
AuthorDate: Tue Oct 27 05:38:10 2020 +0800
update community page and installation guide
---
_community/en/community.md | 38 +++++
_community/index.md | 44 -----
_community/mail-subscribe.md | 81 ---------
_community/proposal.md | 304 ----------------------------------
_community/{ => zh}/coding-guides.md | 0
_community/zh/community.md | 38 +++++
_community/{ => zh}/roadmap.md | 0
_config.yml | 2 +-
_data/docs_menu.yml | 10 +-
_data/en/translate.yml | 7 +-
_data/navigation.yml | 12 +-
_data/zh/translate.yml | 5 +-
_docs/zh/build/compile-by-docker.md | 57 +++++++
_docs/zh/build/compile-from-source.md | 103 ++++++++++++
_docs/zh/downloads.md | 18 ++
_docs/zh/installation.md | 150 -----------------
_layouts/community.html | 49 +-----
17 files changed, 285 insertions(+), 633 deletions(-)
diff --git a/_community/en/community.md b/_community/en/community.md
new file mode 100755
index 0000000..f965f3e
--- /dev/null
+++ b/_community/en/community.md
@@ -0,0 +1,38 @@
+---
+title: Pegasus Community
+permalink: /community/index.html
+
+contact_items:
+ - title: Mailing list
+ icon: fas fa-envelope
+ description: >
+ See <a href="https://cwiki.apache.org/confluence/display/PEGASUS/Mailing+list+subscription+guide">Mailing list subscription guide</a> to subscribe to
+
+ our <a href="mailto: dev-subscribe@pegasus.apache.org">mailing list</a> and join our discussion.
+
+ - title: Github Issues
+ icon: fab fa-github
+ description: >
+ Report bugs, potential improvements and
+
+ problems via <a href="https://github.com/apache/incubator-pegasus/issues">Github Issues</a>.
+
+ - title: Slack
+ icon: fab fa-slack
+ description: >
+ Chat with the developers and users in the
+
+ <a href="https://apache-pegasus.slack.com">apache-pegasus #dev channel</a>.
+
+contributor_items:
+ - title: Pull Requests
+ description: >
+ We use <a href="">Github Pull Request</a> for development. Every pull request needs 2 approvals from the Pegasus committers before merged. You can make your review and comments on the PR even if you are not yet a Pegasus committer.
+ Please read the <a href="/community/coding-guides">Coding Guides</a> before submitting a new code.
+
+ - title: Bug Fixes
+ description: >
+ The known bugs were collected here: <a href="https://github.com/apache/incubator-pegasus/labels/type%2Fbug">Issues: type/bug</a>. If you encounter problems that couldn't be found in the list, please report to us via issues.
+ Bug finding is also a meaningful contribution to us. Furthermore, since we deeply value the readability and quality of our document, minor fixes like correcting spelling errors are also welcomed.
+---
+
\ No newline at end of file
diff --git a/_community/index.md b/_community/index.md
deleted file mode 100755
index cf95e43..0000000
--- a/_community/index.md
+++ /dev/null
@@ -1,44 +0,0 @@
----
-title: Pegasus 社区
-subtitle: 我们以纯粹开放的态度，愿与你共同构筑 Pegasus
-layout: community
-header_style: is-black
-
-contact_items:
- - title: 邮件列表
- icon: fas fa-envelope
- description: >
- 参考<a href="/community/mail-subscribe">邮件订阅</a>文档，订阅我们的<a href="mailto: dev-subscribe@pegasus.apache.org">邮件列表</a>
-
- 参与我们的讨论
-
- - title: Github Issues
- icon: fab fa-github
- description: >
- 你可以到<a href="https://github.com/XiaoMi/pegasus/issues">Github Issues</a>向我们报告缺陷，提出改进的建议，以及咨询Pegasus使用中遇到的问题
-
- - title: Pegasus技术专栏
- icon: fab fa-zhihu
- description: >
- 我们会不定期发表技术文章到<a href="https://zhuanlan.zhihu.com/c_1059090995865608192">Pegasus技术专栏</a>，
-
- 欢迎关注以及留言
-
-contributor_items:
- - title: Pull Requests
- description: >
- 我们的开发流程使用<a href="">Github Pull Request</a>机制。你的提交至少需要两个Pegasus Committer的Code Review都通过才可合入主干分支。即使你并不是Pegasus Committer，你也可以对代码提出review，你的建议可能会有助于我们发现问题。你可以参照<a href="/community/coding-guides">Coding Guides</a>的规范来提交代码。
-
- - title: RoadMap
- description: >
- 你可以在<a href="/community/roadmap">这里</a>找到我们近期的产品规划，对那些你最感兴趣的需求，你可以与我们进行合作开发。此外，我们也会在每次<a href="/releases">版本发布</a>时向大家同步Pegasus当前已完成开发的功能以及目标。
-
- - title: Fixes
- description: >
- 我们将当前已知的bug汇总在<a href="https://github.com/XiaoMi/pegasus/labels/type%2Fbug">Issues: type/bug</a>。如果你在使用中发现了任何问题，请通过Issues向我们反馈，你的问题反馈也是对我们相当大的帮助。此外，我们极其重视文档的规范化和易读性，这能够帮助我们更好的接入新用户。如果你在阅读文档时发现了问题，也可以向我们提出改进。
-
----
-
-## 邮件订阅
-
-你可以发送一则空邮件到<de...@pegasus.apache.org>，邮件机器人会回复你一封邮件，请你确认是否订阅。直接回复此邮件，则可完成订阅。
diff --git a/_community/mail-subscribe.md b/_community/mail-subscribe.md
deleted file mode 100644
index 4ec3554..0000000
--- a/_community/mail-subscribe.md
+++ /dev/null
@@ -1,81 +0,0 @@
----
-title: Pegasus邮件列表
-layout: page
----
-
-Pegasus已经建立了Apache邮件列表（<de...@pegasus.apache.org>），其本意是帮助信息的透明化。Apache项目的运作宗旨为“社区大于代码”（"Community Over Code"），一个活跃的社区远要比一份极致的代码更重要。而邮件列表则是实现这一理念的重要组件。
-
-使用你的常用邮箱订阅Pegasus的邮件列表，我们会时常推送Pegasus的开发动态以及新的技术思路与洞见。
-
-## 邮件订阅
-
-要订阅此邮件列表，需要走以下步骤：
-
-1. 发一封邮件到dev-subscribe@pegasus.apache.org，其内容和标题均可为空。随后，您会收到一封邮件，其内容如下：
-
- ```
- from: dev-help@pegasus.apache.org
- reply-to: dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@pegasus.apache.org
- to: hello@example.com
- date: Mon, Aug 24, 2020 at 3:12 PM
- subject: confirm subscribe to dev@pegasus.apache.org
- mailed-by: apache.org
-
- Hi! This is the ezmlm program. I'm managing the
- dev@pegasus.apache.org mailing list.
-
- I'm working for my owner, who can be reached
- at dev-owner@pegasus.apache.org.
-
- To confirm that you would like
-
- hello@example.com
-
- added to the dev mailing list, please send
- a short reply to this address:
-
- dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@pegasus.apache.org
-
- Usually, this happens when you just hit the "reply" button.
- If this does not work, simply copy the address and paste it into
- the "To:" field of a new message.
-
- or click here:
- mailto:dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@pegasus.apache.org
-
- ...
- ```
-
-2. 直接回复邮件，其内容和标题仍然可以为空，随后，您将再次收到一封邮件，其内容如下：
-
- ```
- from: dev-help@pegasus.apache.org
- to: hello@example.com
- date: Mon, Aug 24, 2020 at 3:12 PM
- subject: WELCOME to dev@pegasus.apache.org
- mailed-by: apache.org
-
- Hi! This is the ezmlm program. I'm managing the
- dev@pegasus.apache.org mailing list.
-
- I'm working for my owner, who can be reached
- at dev-owner@pegasus.apache.org.
-
- Acknowledgment: I have added the address
-
- hello@example.com
-
- to the dev mailing list.
-
- Welcome to dev@pegasus.apache.org!
-
- Please save this message so that you know the address you are
- subscribed under, in case you later want to unsubscribe or change your
- subscription address.
-
- ...
- ```
-
-## 历史邮件
-
-你可以在[Mailing list archives](http://mail-archives.apache.org/mod_mbox/pegasus-dev/)获取我们的历史邮件，这能帮助你了解到Pegasus的历史动态还有发展轨迹。
diff --git a/_community/proposal.md b/_community/proposal.md
deleted file mode 100644
index 1b80f22..0000000
--- a/_community/proposal.md
+++ /dev/null
@@ -1,304 +0,0 @@
----
-title: Pegasus Proposal
-layout: page
----
-
-## Abstract
-
-Pegasus is a distributed key-value storage system which is designed to
-be horizontally scalable, strongly consistent and high-performance.
-
-- Pegasus codebase: <https://github.com/XiaoMi/pegasus>
-- Website: <https://pegasus.apache.org>
-
-## Proposal
-
-Pegasus is a key-value database that delivers low-latency data access together
-with horizontal scalability, using hash-based partitioning. Pegasus uses [PacificA](https://www.microsoft.com/en-us/research/wp-content/uploads/2008/02/tr-2008-25.pdf)
-protocol for strong consistency and [RocksDB](https://github.com/facebook/rocksdb) as the underlying storage engine.
-
-We propose to contribute the Pegasus codebase and associated artifacts
-(e.g., documentation, website content, etc.) to the Apache Software Foundation,
-and aim to build an open community around Pegasus's continued development
-in the 'Apache Way'.
-
-## Background
-
-[Apache HBase](https://hbase.apache.org/) was recognized as mostly the only large-scale KV store solution in [XiaoMi Corp](https://www.mi.com/global)
-until Pegasus came out in 2015. The original purpose of Pegasus was to solve the problems
-caused by HBase's two-level architecture and implementation, including high latency
-because of Java GC and RPC overhead of the underlying distributed filesystem, and long
-failover time because of single point of RegionServer and recovery overhead of splitting
-and replaying the HLog files.
-
-Pegasus aims to fill the gap between [Redis](https://redis.io/) and HBase. As the former
-is in-memory, low latency, but does not provide a strong-consistency guarantee.
-And unlike the latter, Pegasus server is entirely written in C++ and its read-write path
-relies merely on the local filesystem.
-
-Apart from performance requirements, we also need a storage system
-to ensure multiple-level data safety and support fast data migration
-among data centers, automatic load balancing, and online partition splitting.
-
-After investigating lots of existing storage systems in the open source world,
-we could hardly find a suitable solution to satisfy all the requirements.
-So the journey of Pegasus begins.
-
-### Rationale
-
-Pegasus is a mature and active project which has been widely adopted in XiaoMi.
-After the initial release of open source project in 2017, we have seen a great amount
-of interest across a diverse set of users and companies.
-
-Our experiences at committers and PMC members on other Apache projects have convinced
-us that having a long-term home at Apache foundation would be a great fit for the project,
-to ensure that processes and procedures are in place to keep project and community 'healthy'
-and free of any commercial, political or legal faults.
-
-### Initial Goal
-
-- Move the existing codebase, website, documentation, and mailing lists to
- Apache-hosted infrastructure.
-- Work with the infrastructure team to implement and approve our code review, build,
- and testing workflows in the context of the ASF.
-- Incremental development and releases among with Apache guidelines.
-
-## Current Status
-
-Pegasus has been an open source project on GitHub <https://github.com/XiaoMi/pegasus>
-since October 2017.
-
-### Meritocracy
-
-The intent of this proposal is to start building a diverse developer and user community
-around Pegasus following the ASF meritocracy model.
-We plan to invite more people as committers if they contribute to this project.
-
-### Releases
-
-Pegasus has undergone multiple public releases, listed here: <https://github.com/XiaoMi/pegasus/releases>.
-
-These old releases were not performed in the typical ASF fashion.
-We will adopt the ASF source release process upon joining the incubator.
-
-### Code Reviews
-
-Pegasus's code reviews are currently public on Github <https://github.com/XiaoMi/pegasus/pulls>.
-
-### Community
-
-Pegasus seeks to develop developer and user communities during incubation.
-
-### Core Developers
-
-Currently most of the core developers of Pegasus are working in
-the KV-Storage Team of Xiaomi. Yingchun Lai is one of the [Apache Kudu](https://github.com/apache/kudu) PMC members.
-Zuoyan Qin is an experienced open source developer who created [sofa-pbrpc](https://github.com/baidu/sofa-pbrpc)
-in his last job in Baidu. Wei Huang is also an active contributor of [Apache Doris (Incubating)](https://github.com/apache/incubator-doris).
-
-- Zuoyan Qin (<https://github.com/qinzuoyan>)
-- Yuchen He (<https://github.com/hycdong>)
-- Tao Wu (<https://github.com/neverchanje>)
-- Yingchun Lai (<https://github.com/acelyc111>)
-- Wei Huang (<https://github.com/vagetablechicken>)
-- Shuo Jia (<https://github.com/Shuo-Jia>)
-- Liwei Zhao (<https://github.com/levy5307>)
-
-### Alignment
-
-Pegasus is aligned with several other ASF projects.
-
-We are working on a new feature to load data from the HDFS filesystem.
-Pegasus can also generate and store checkpoints to HDFS, for both backup and analysis purpose.
-We currently support offline analysis on checkpoints powered by [Apache Spark](https://spark.apache.org/).
-
-## Known Risks
-
-### Orphaned Products
-
-The core developers of XiaoMi's Pegasus team work full time on this project.
-There is very little risk of Pegasus getting orphaned since at least one large company
-(XiaoMi) is extensively using it in production, with currently a scale of
-70+ clusters, 800+ tables, and more than 70TB data.
-Furthermore, since Pegasus was open sourced at the beginning of October 2017,
-it has received more than 1200 stars and been forked more than 200 times, and also
-received some [issues](https://github.com/XiaoMi/pegasus/issues) and pull requests
-from developers and users outside XiaoMi.
-We plan to extend and diversify this community further through Apache.
-
-### Inexperience with Open Source
-
-The core developers are all active users and followers of open source.
-They are already committers and contributors to the Pegasus Github project.
-All have been involved with the source code that has been released under an
-open source license, and several of them also have experience developing
-code in an open source environment.
-
-Several of the developers in XiaoMi's storage team are committers and/or PMC
-members on other ASF projects (Kudu, HBase, Doris, etc.). They will guide others to practice
-the Apache Way together along with other incubator mentors.
-
-### Homogenous Developers
-
-The project has received some contributions from developers outside of XiaoMi,
-and is starting to attract a user community as well. We hope to continue to
-encourage contributions from these developers and community members, and grow
-them into committers as they have time to continue their contributions.
-
-### Reliance on Salaried Developers
-
-XiaoMi invested in Pegasus as a general key-value storage used in company widely.
-The core developers have been dedicated to this project for nearly five years.
-
-Besides, we look forward to attracting more people outside XiaoMi to contribute to this project,
-either payed engineers working on storage area, or individual volunteers, as long as they have
-enthusiasm for the Pegasus project.
-
-### An Excessive Fascination with the Apache Brand
-
-Pegasus is proposing to enter incubation at Apache in order to help efforts
-to diversify the committer-base, not so much to capitalize on the Apache brand.
-The Pegasus project is in production use already inside XiaoMi,
-but is not expected to be a XiaoMi product for external customers.
-As such, the Pegasus project is not seeking to use the Apache brand as
-a marketing tool.
-
-## Documentation
-
-Information about Pegasus can be found at <https://github.com/XiaoMi/pegasus>.
-The following links provide more information about Pegasus in open source:
-
-- Pegasus Website: <https://pegasus.apache.org>
-- Codebase at Github: <https://github.com/XiaoMi/pegasus>
-- Issue Tracking: <https://github.com/XiaoMi/pegasus/issues>
-- Releases: <https://pegasus.apache.org/releases>
-- Community Guide: <https://pegasus.apache.org/community>
-
-## Initial Source
-
-Besides the core codebase, Pegasus also hosts its side projects on Github under XiaoMi Group.
-Specifically, the initial source includes:
-
-Client libraries with different languages:
-
-- Java-Client: <https://github.com/XiaoMi/pegasus-java-client>
-- Scala-Client: <https://github.com/XiaoMi/pegasus-scala-client>
-- NodeJS-Client: <https://github.com/XiaoMi/pegasus-nodejs-client>
-- Go-Client: <https://github.com/XiaoMi/pegasus-go-client>
-- Python-Client: <https://github.com/XiaoMi/pegasus-python-client>
-
-Components of Pegasus:
-
-- rDSN: <https://github.com/XiaoMi/rdsn>
-- RocksDB: <https://github.com/XiaoMi/pegasus-rocksdb>
-
-rDSN was initially a distributed framework developed by Zhenyu Guo from Microsoft,
-and we have heavily refactored and improved it to make it more fit for Pegasus. rDSN is MIT & Apache-2.0 dual-licensed.
-The code licensed Apache-2.0 belongs to XiaoMi and the copyright of MIT-licensed code is assigned to Microsoft.
-It's in our plan to merge Pegasus and rDSN as one project.
-
-RocksDB is a Facebook-developed storage engine. Pegasus added some enhancements and modifications
-that may be incompatible with the original implementation.
-RocksDB is licensed under Apache 2.0 License.
-
-## External Dependencies
-
-Pegasus has the following external dependencies.
-
-- RocksDB (Apache)
-- Apache Thrift (Apache Software License v2.0)
-- Boost (Boost Software License)
-- Apache Zookeeper (Apache)
-- Google s2geometry (BSD)
-- Google gflags (BSD)
-- fmtlib (BSD)
-- POCO (Boost Software License)
-- rapidjson (Tencent)
-- libevent (BSD)
-- Google gperftools (BSD)
-- cameron314/concurrentqueue (BSD)
-- cameron314/readerwriterqueue (BSD)
-- XiaoMi/galaxy-fds-sdk-cpp (No License)
-- jupp0r/prometheus-cpp (MIT)
-- curl ([The curl license](https://curl.haxx.se/docs/copyright.html))
-- nlohmann/json (MIT)
-- abseil-cpp (Apache 2.0)
-- antirez/linenoise (BSD-2)
-- antirez/sds (BSD-2)
-
-Build and test dependencies:
-
-- Apache Maven (Apache Software License v2.0)
-- cmake (BSD)
-- Google gtest (Apache Software License v2.0)
-
-## Required Resources
-
-### Mailing List
-
-There are currently no mailing lists.
-The usual mailing lists are expected to be set up when entering incubation:
-
-- private@pegasus.incubator.apache.org
-- dev@pegasus.incubator.apache.org
-- commits@pegasus.incubator.apache.org
-
-### Git Repositories
-
-Upon entering incubation, we want to move the existing repository from <https://github.com/XiaoMi/pegasus>
-to Apache infrastructure like <https://github.com/apache/incubator-pegasus>.
-
-### Issue Tracking
-
-Pegasus currently uses Github to track issues. Would like to continue to do so while we discuss migration possibilities with the ASF Infra committee.
-
-### Other Resources
-
-The existing code already has unit tests so we will make use of existing Apache continuous testing infrastructure. The resulting load should not be very large.
-
-## Source and Intellectual Property Submission Plan
-
-Most of the current code is Apache 2.0 licensed and the copyright is assigned to XiaoMi.
-If the project enters incubator, XiaoMi will transfer the source code & trademark
-ownership to ASF via a Software Grant Agreement.
-
-But due to historical issues, Pegasus was based on an MIT licensed code that was initially
-written by [microsoft/rDSN](https://github.com/microsoft/rDSN), which has long been actively developed by Pegasus
-because the original project is unmaintained (modified code is licensed under Apache License 2.0).
-We aren't sure if we should request Microsoft for any Contributor License Agreement (CLA) during the IP clearance process.
-
-## Initial Committers
-
-- Zuoyan Qin (<https://github.com/qinzuoyan>, qinzuoyan@xiaomi dot com)
-- Weijie Sun (<https://github.com/shengofsun>, luckyweijie@gmail dot com)
-- Yuchen He (<https://github.com/hycdong>, heyuchen@xiaomi dot com)
-- Tao Wu (<https://github.com/neverchanje>, wutao1@xiaomi dot com)
-- Yingchun Lai (<https://github.com/acelyc111>, laiyingchun@xiaomi dot com)
-- Wei Huang (<https://github.com/vagetablechicken>, huangwei5@xiaomi dot com)
-- Shuo Jia (<https://github.com/Shuo-Jia>, jiashuo1@xiaomi dot com)
-- Liwei Zhao (<https://github.com/levy5307>, zhaoliwei@xiaomi dot com)
-- Liuyang Cai (<https://github.com/LoveHeat>)
-
-## Affiliations
-
-Seven of the initial committers are employees of Xiaomi.
-
-## Sponsors
-
-### Champion
-
-Von Gosling, vongosling@apache.org
-
-### Nominated Mentors
-
-Kevin A. McGrail, kmcgrail@apache.org
-
-Duo Zhang, zhangduo@apache.org
-
-Von Gosling, vongosling@apache.org
-
-Liang Chen, chenliang613@apache.org
-
-### Sponsoring Entity
-
-We are requesting the Incubator to sponsor this project.
diff --git a/_community/coding-guides.md b/_community/zh/coding-guides.md
similarity index 100%
rename from _community/coding-guides.md
rename to _community/zh/coding-guides.md
diff --git a/_community/zh/community.md b/_community/zh/community.md
new file mode 100755
index 0000000..325d8ea
--- /dev/null
+++ b/_community/zh/community.md
@@ -0,0 +1,38 @@
+---
+title: Pegasus 社区
+subtitle: 我们以纯粹开放的态度，愿与你共同构筑 Pegasus
+permalink: /community/index.html
+
+contact_items:
+ - title: 邮件列表
+ icon: fas fa-envelope
+ description: >
+ 参考<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=165222461">邮件订阅</a>文档，订阅我们的<a href="mailto: dev-subscribe@pegasus.apache.org">邮件列表</a>
+
+ 参与我们的讨论
+
+ - title: Github Issues
+ icon: fab fa-github
+ description: >
+ 你可以到<a href="https://github.com/apache/incubator-pegasus/issues">Github Issues</a>向我们报告缺陷，提出改进的建议，以及咨询Pegasus使用中遇到的问题
+
+ - title: Pegasus技术专栏
+ icon: fab fa-zhihu
+ description: >
+ 我们会不定期发表技术文章到<a href="https://zhuanlan.zhihu.com/c_1059090995865608192">Pegasus技术专栏</a>，
+
+ 欢迎关注以及留言
+
+contributor_items:
+ - title: Pull Requests
+ description: >
+ 我们的开发流程使用<a href="https://github.com/apache/incubator-pegasus/pulls">Github Pull Request</a>机制。你的提交至少需要两个Pegasus Committer的Code Review都通过才可合入主干分支。即使你并不是Pegasus Committer，你也可以对代码提出review，你的建议可能会有助于我们发现问题。你可以参照<a href="/community/coding-guides">Coding Guides</a>的规范来提交代码。
+
+ - title: RoadMap
+ description: >
+ 你可以在<a href="/community/roadmap">这里</a>找到我们近期的产品规划，对那些你最感兴趣的需求，你可以与我们进行合作开发。此外，我们也会在每次<a href="/releases">版本发布</a>时向大家同步Pegasus当前已完成开发的功能以及目标。
+
+ - title: Fixes
+ description: >
+ 我们将当前已知的bug汇总在<a href="https://github.com/apache/incubator-pegasus/labels/type%2Fbug">Issues: type/bug</a>。如果你在使用中发现了任何问题，请通过Issues向我们反馈，你的问题反馈也是对我们相当大的帮助。此外，我们极其重视文档的规范化和易读性，这能够帮助我们更好的接入新用户。如果你在阅读文档时发现了问题，也可以向我们提出改进。
+---
diff --git a/_community/roadmap.md b/_community/zh/roadmap.md
similarity index 100%
rename from _community/roadmap.md
rename to _community/zh/roadmap.md
diff --git a/_config.yml b/_config.yml
index 90ae1a8..96b7cd2 100755
--- a/_config.yml
+++ b/_config.yml
@@ -48,7 +48,7 @@ defaults:
show_sidebar: false
toc: true
front: false
- layout: post
+ layout: community
hero_style: is-white is-centered
header_style: is-black
- scope:
diff --git a/_data/docs_menu.yml b/_data/docs_menu.yml
index cb649f0..eecff1c 100644
--- a/_data/docs_menu.yml
+++ b/_data/docs_menu.yml
@@ -1,7 +1,13 @@
- name: title_docs
items:
- - name: title_installation
- link: /docs/installation
+ - name: title_downloads
+ link: /docs/downloads
+- name: title_build_pegasus
+ items:
+ - name: title_compile-by-docker
+ link: /docs/build/compile-by-docker
+ - name: title_compile-from-source
+ link: /docs/build/compile-from-source
- name: title_clients
items:
- name: title_java-client
diff --git a/_data/en/translate.yml b/_data/en/translate.yml
index 6257876..8a29514 100644
--- a/_data/en/translate.yml
+++ b/_data/en/translate.yml
@@ -1,6 +1,9 @@
title_overview: "Overview"
title_background: "Background"
-title_installation: "Installation"
+title_downloads: "Downloads"
+title_build_pegasus: "Building Pegasus"
+title_compile-from-source: "Compile from source"
+title_compile-by-docker: "Compile by docker"
title_architecture: "Architecture"
title_data-model: "Data Model"
title_documentation: "Docs"
@@ -8,7 +11,7 @@ title_api: "API"
title_administration: "Admin"
title_blog: "Blog"
title_community: "Community"
-title_contact: "Contact"
+title_contact: "Contact Us"
title_contribution: "Contribution"
title_coding-guides: "Coding Guides"
title_roadmap: "RoadMap"
diff --git a/_data/navigation.yml b/_data/navigation.yml
index d4da22e..f53696f 100644
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -3,20 +3,18 @@
icon: fas fa-user-plus
items:
- name: title_contact
- link: /community/#联系我们
+ link: /community/#contact-us
- name: title_contribution
- link: /community/#参与贡献
+ link: /community/#contribution
- name: title_coding-guides
link: /community/coding-guides
- - name: title_roadmap
- link: /community/roadmap
- name: title_bug-tracking
- link: https://github.com/XiaoMi/pegasus/labels/type%2Fbug
+ link: "{{ pegasus_github_url }}/labels/type%2Fbug"
- name: title_apache-proposal
- link: /community/proposal
+ link: https://cwiki.apache.org/confluence/display/INCUBATOR/PegasusProposal
- name: title_blog
link: /blogs
icon: fas fa-rss
- name: title_releases
icon: fas fa-fire
- link: /releases
+ link: "{{ pegasus_github_url }}/releases"
diff --git a/_data/zh/translate.yml b/_data/zh/translate.yml
index 67ed68c..3900c4b 100644
--- a/_data/zh/translate.yml
+++ b/_data/zh/translate.yml
@@ -1,6 +1,9 @@
title_overview: "概览"
title_background: "项目背景"
-title_installation: "编译构建"
+title_build_pegasus: "编译构建"
+title_downloads: "下载"
+title_compile-from-source: "从源码编译"
+title_compile-by-docker: "使用Docker完成编译"
title_architecture: "系统架构"
title_data-model: "数据模型"
title_documentation: "文档"
diff --git a/_docs/zh/build/compile-by-docker.md b/_docs/zh/build/compile-by-docker.md
new file mode 100755
index 0000000..0ecd92c
--- /dev/null
+++ b/_docs/zh/build/compile-by-docker.md
@@ -0,0 +1,57 @@
+---
+permalink: docs/build/compile-by-docker/
+---
+
+## 下载Docker镜像
+
+Pegasus将编译环境封装至[Docker镜像](https://hub.docker.com/r/apachepegasus/build-env)中，你可以直接基于此环境编译代码。
+
+```sh
+docker pull apachepegasus/build-env:centos6
+```
+
+如果希望基于正式发布的稳定版本（如 {{ site.latest_pegasus_version }}）进行编译，你可以下载：
+
+```sh
+docker pull apachepegasus/build-env:{{ site.latest_pegasus_version }}-centos6
+```
+
+## 编译
+
+请先参考[下载文档](/docs/downloads)获取源码到某目录（`/your/local/apache-pegasus-source`）下。随后运行以下命令：
+
+```sh
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+ apachepegasus/build-env:centos6 \
+ /bin/bash -c "./run.sh build -c"
+```
+
+编译的结果会被放在项目根目录的`DSN_ROOT/`文件夹下，其中包含bin、include、lib目录。
+
+## 编译打包
+
+打包server端程序包，用于服务部署：
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+ apachepegasus/build-env:centos6 \
+ /bin/bash -c "./run.sh pack_server"
+```
+
+打包client端库，用于C/C++端客户端开发：
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+ apachepegasus/build-env:centos6 \
+ /bin/bash -c "./run.sh pack_client"
+```
+
+打包tools工具集，里面包含了各种工具（shell、bench）：
+
+```bash
+docker run -v /your/local/apache-pegasus-source:/root/pegasus \
+ apachepegasus/build-env:centos6 \
+ /bin/bash -c "./run.sh pack_tools"
+```
+
+编译成功后，推荐先[体验onebox集群](/overview/onebox)。
diff --git a/_docs/zh/build/compile-from-source.md b/_docs/zh/build/compile-from-source.md
new file mode 100755
index 0000000..71be587
--- /dev/null
+++ b/_docs/zh/build/compile-from-source.md
@@ -0,0 +1,103 @@
+---
+permalink: docs/build/compile-from-source/
+redirect_from:
+ - 2.1.0/docs/build/compile-from-source/
+version: 2.1.0
+---
+
+Pegasus目前只支持Linux平台进行源码编译。编译过程中遇到问题，可以通过[Github Issues]({{ site.pegasus_github_url }}/issues)向我们咨询。
+
+## Ubuntu环境配置
+
+你可以参考 [pegasus-build-dev/ubuntu16.04](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/ubuntu16.04/Dockerfile) 的Docker镜像安装全部依赖。
+
+```bash
+apt-get -y install build-essential \
+ python3-pip \
+ libaio-dev \
+ libsnappy-dev \
+ libbz2-dev \
+ libzstd-dev \
+ liblz4-dev \
+ zlib1g \
+ zlib1g.dev \
+ patch \
+ git \
+ curl \
+ zip \
+ automake \
+ libtool \
+ libssl-dev \
+ bison \
+ flex;
+
+pip3 install --no-cache-dir cmake
+```
+
+## CentOS环境配置
+
+你可以参考 [pegasus-build-dev/centos7](https://github.com/pegasus-kv/pegasus-docker/blob/master/pegasus-build-env/centos7/Dockerfile) 的Docker镜像安装全部依赖。
+
+```bash
+yum -y install centos-release-scl \
+ scl-utils \
+ epel-release;
+
+yum -y install devtoolset-7-gcc \
+ devtoolset-7-gcc-c++ \
+ python3 \
+ automake \
+ autoconf \
+ make \
+ libtool \
+ git \
+ file \
+ wget \
+ unzip \
+ which \
+ openssl-devel \
+ libaio-devel \
+ snappy-devel \
+ bzip2-devel \
+ zlib \
+ zlib-devel \
+ libzstd-devel \
+ lz4-devel \
+ bison \
+ flex \
+ patch;
+
+pip3 install --no-cache-dir cmake
+```
+
+## 源码编译
+
+请先参考[下载文档](/docs/downloads)获取源码。
+
+```bash
+./run.sh build -c
+```
+
+编译后输出会放在当前目录的`DSN_ROOT/`文件夹下，里面包含bin、include、lib目录。
+
+## 编译打包
+
+打包server端程序包，用于服务部署：
+
+```bash
+./run.sh pack_server
+```
+
+打包client端库，用于C/C++端客户端开发：
+
+```bash
+./run.sh pack_client
+```
+
+打包tools工具集，里面包含了各种工具（shell、bench）：
+
+```bash
+./run.sh pack_tools
+```
+
+编译成功后，推荐先[体验onebox集群](/overview/onebox)。
diff --git a/_docs/zh/downloads.md b/_docs/zh/downloads.md
new file mode 100644
index 0000000..1a27b0c
--- /dev/null
+++ b/_docs/zh/downloads.md
@@ -0,0 +1,18 @@
+---
+permalink: docs/downloads/
+---
+
+我们推荐下载遵循[ASF Release Policy](http://www.apache.org/legal/release-policy.html)发布的源码包：
+
+Package | Signature | Checksum | Release Notes |
+---|---|---|---|
+[Apache Pegasus 2.1.0](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip) | [asc](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip.asc) | [sha512](https://dist.apache.org/repos/dist/release/incubator/pegasus/2.1.0/apache-pegasus-2.1.0-source-release.zip.sha512) | [Apache Pegasus 2.1.0 Release Notes](https://cwiki.apache.org/confluence/display/PEGASUS/Apache+Pegasus+2.1.0+Rel [...]
+
+你也可以通过git clone的方式获取Pegasus源码：
+
+```bash
+git clone {{ site.pegasus_github_url }}.git --recursive
+cd pegasus
+git checkout -b v2.1.0 v2.1.0
+git submodule update
+```
diff --git a/_docs/zh/installation.md b/_docs/zh/installation.md
deleted file mode 100755
index 85b09fb..0000000
--- a/_docs/zh/installation.md
+++ /dev/null
@@ -1,150 +0,0 @@
----
-permalink: docs/installation/
-redirect_from:
- - overview/installation/
- - 2.1.0/docs/installation/
-version: 2.1.0
----
-
-Pegasus目前只支持Linux平台。目前在CentOS、Ubuntu上都测试运行过。
-
-编译过程中遇到问题，请先参考下面的**常见问题**，如果还不能解决，可以通过[Github Issues]({{ site.pegasus_github_url }}/issues)向我们咨询。
-
-## 安装依赖
-
-Pegasus编译依赖以下软件：
-
-* 编译器：GCC-5以上版本，要求支持C++14
-* CMake：3.5.2及以上版本
-* 其他库：libaio、snappy、zstd、lz4、zlib
-
-如果是Ubuntu，可以使用apt-get安装依赖库：
-
-```bash
-sudo apt-get install build-essential cmake libaio-dev libsnappy-dev libzstd-dev liblz4-dev zlib1g zlib1g.dev patch git curl zip automake libtool libssl-dev bison flex
-```
-
-如果是CentOS，可以使用yum安装依赖库：
-
-```bash
-yum -y groupinstall "Development Tools"
-yum -y install cmake libaio-devel snappy-devel zstd-devel lz4-devel zlib zlib-devel patch openssl-devel bison flex
-```
-
-如果你的系统没有提供zstd的软件源，你可以尝试手动安装，这里提供一个安装脚本：
-
-```bash
-wget https://github.com/facebook/zstd/archive/v1.3.7.zip
-unzip v1.3.7
-cd zstd-1.3.7
-mkdir cmake-build
-cd cmake-build
-cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INSTALL_LIBDIR=lib -DZSTD_BUILD_PROGRAMS=OFF ../build/cmake
-sudo make install -j8
-```
-
-## 源码获取
-
-我们推荐下载遵循[ASF Release Policy](http://www.apache.org/legal/release-policy.html)发布的源码包。
-下载地址：
-
-<https://dist.apache.org/repos/dist/release/incubator/pegasus/{{ page.version }}/apache-pegasus-{{ page.version }}-source-release.zip>
-
-
-你也可以通过git clone的方式获取Pegasus源码：
-
-```bash
-git clone {{ site.pegasus_github_url }}.git --recursive
-cd pegasus
-git checkout -b v{{ page.version }} v{{ page.version }}
-git submodule update
-```
-
-## 源码编译
-
-```bash
-./run.sh build -c
-```
-
-编译后输出会放在当前目录的`DSN_ROOT/`文件夹下，里面包含bin、include、lib目录。
-
-## 编译打包
-
-打包server端程序包，用于服务部署：
-
-```bash
-./run.sh pack_server
-```
-
-打包client端库，用于C/C++端客户端开发：
-
-```bash
-./run.sh pack_client
-```
-
-打包tools工具集，里面包含了各种工具（shell、bench）：
-
-```bash
-./run.sh pack_tools
-```
-
-编译成功后，推荐先[体验onebox集群](/overview/onebox)。
-
-## 常见问题
-
-### 更新代码后重新编译
-
-如果通过```git pull```更新代码后，可能会出现编译失败的情况，这可能是因为：
-
-* 依赖的子模块发生了变化，需要更新子模块到合适的版本（通过```git status```可以看rdsn和rocksdb子模块是否发生变化）；
-* 编译配置发生了变化，CMake文件已过期；
-* thirdparty依赖发生了变化，需要重新下载和编译依赖库；
-
-可以先尝试按照如下步骤是否能解决（解决子模块和编译配置发生变化的问题）：
-
-```bash
-git submodule update
-./run.sh build -c
-```
-
-如果还不能解决，可以进一步尝试（解决thirdparty依赖变化的问题）：
-
-```bash
-./run.sh build -c --clear_thirdparty
-```
-
-如果还不能解决，可以咨询我们。
-
-### 使用toolchain编译
-
-如果系统自带的编译器版本太低且难以升级（不支持C++14），可以自己下载和编译高版本的gcc工具链，然后放到PATH中：
-
-```bash
-export PATH="$TOOLCHAIN_DIR/bin:$PATH"
-./run.sh build
-```
-
-### 运行时出现libstdc++版本不兼容问题
-
-如果用户使用自己的（非系统自带的）gcc或者boost库，在运行时可能出现c++版本不兼容的错误：
-
-```
-./pegasus_server: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.14' not found (required by ./pegasus_server)
-./pegasus_server: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.17' not found (required by ./pegasus_server)
-./pegasus_server: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.19' not found (required by ./pegasus_server)
-./pegasus_server: /usr/lib64/libstdc++.so.6: version `CXXABI_1.3.5' not found (required by ./pegasus_server)
-```
-
-此时最好使用pack工具打包成运行时的执行包：
-
- * pack_server：服务包，用于部署Pegasus集群的服务进程。注意在运行前需要：`export LD_LIBRARY_PATH=$package_dir/DSN_ROOT/lib`。
- * pack_client：C++客户端库，用于业务开发。
- * pack_tools：工具包，run.sh里面大部分命令都能用，包括shell和onebox工具。
-
-以上三个pack工具都支持`-b`和`-g`选项，将用户自己的boost和gcc库放到DSN_ROOT/lib中，避免运行时链接到错误的库。这样，即使跨机器，只要libc兼容，执行包都能正常使用，避免库不兼容的困扰。
-
-如果你用了自己的gcc，就在pack的时候加上`-g`选项，譬如：
-
-```
-./run.sh pack_server -g
-```
diff --git a/_layouts/community.html b/_layouts/community.html
index 615ae4e..99b4419 100644
--- a/_layouts/community.html
+++ b/_layouts/community.html
@@ -15,11 +15,11 @@
</div>
</div>
</section>
- <section class="hero is-medium is-light" id="联系我们">
+ <section class="hero is-medium is-light" id="contact-us">
<div class="hero-body">
<div class="container has-text-centered">
<p class="title is-2 has-text-black">
- 联系我们
+ {{ site.data.translate['title_contact'] }}
</p>
<hr class="has-background-black" style="margin-bottom: 5rem;">
<div class="columns is-multiline is-centered">
@@ -40,17 +40,17 @@
</div>
</div>
</section>
- <section class="hero is-medium" id="参与贡献">
+ <section class="hero is-medium" id="contribution">
<div class="hero-body">
- <div class="container">
- <p class="title is-2 has-text-black has-text-centered">
- 参与贡献
+ <div class="container has-text-centered">
+ <p class="title is-2 has-text-black">
+ {{ site.data.translate['title_contribution'] }}
</p>
<hr class="has-background-black" style="margin-bottom: 5rem;">
- <div class="columns is-variable is-8">
+ <div class="columns is-variable is-8 is-centered">
{% for item in page.contributor_items %}
<div class="column is-4">
- <p class="title is-3 has-text-centered has-text-weight-light">{{ item.title }}</p>
+ <p class="title is-3 has-text-weight-light">{{ item.title }}</p>
<hr>
<div class="content">
<p>{{ item.description | newline_to_br }}</p>
@@ -61,39 +61,6 @@
</div>
</div>
</section>
- <section class="section">
- <div class="container" style="padding-bottom: 3rem;">
- <hr>
- <div class="tabs is-toggle is-fullwidth is-large">
- <ul>
- <li>
- <a href="/community/mail-subscribe">
- <span class="icon"><i class="fas fa-envelope-open" aria-hidden="true"></i></span>
- <span>邮件订阅</span>
- </a>
- </li>
- <li>
- <a href="/community/coding-guides">
- <span class="icon"><i class="fas fa-location-arrow" aria-hidden="true"></i></span>
- <span>Coding Guides</span>
- </a>
- </li>
- <li>
- <a href="/community/roadmap">
- <span class="icon"><i class="fas fa-map-marked-alt" aria-hidden="true"></i></span>
- <span>RoadMap</span>
- </a>
- </li>
- <li>
- <a href="/overview">
- <span class="icon"><i class="far fa-file-alt" aria-hidden="true"></i></span>
- <span>文档</span>
- </a>
- </li>
- </ul>
- </div>
- </div>
- </section>
{% include footer.html %}
<script src="{{ site.baseurl }}/assets/js/app.js" type="text/javascript"></script>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pegasus.apache.org
For additional commands, e-mail: commits-help@pegasus.apache.org