From 765f284dcd84b615d9189ffed183ba75ffcbd804 Mon Sep 17 00:00:00 2001 From: Mingyu Chen Date: Mon, 9 Mar 2020 09:42:46 +0800 Subject: [PATCH] [Doc] Add Downloads page to Doris website (#3039) --- .../cn/community/verify-apache-release.md | 88 ++++++------------- docs/documentation/cn/downloads/downloads.md | 13 +++ docs/documentation/cn/downloads/index.rst | 10 +++ docs/documentation/cn/index.rst | 2 +- .../alter-table-bitmap-index_EN.md | 18 ++-- .../en/community/verify-apache-release_EN.md | 46 +--------- .../en/downloads/downloads_EN.md | 13 +++ docs/documentation/en/downloads/index.rst | 10 +++ .../en/getting-started/index.rst | 2 +- docs/documentation/en/index.rst | 1 + docs/documentation/en/installing/index.rst | 2 +- 11 files changed, 85 insertions(+), 120 deletions(-) create mode 100644 docs/documentation/cn/downloads/downloads.md create mode 100644 docs/documentation/cn/downloads/index.rst create mode 100644 docs/documentation/en/downloads/downloads_EN.md create mode 100644 docs/documentation/en/downloads/index.rst diff --git a/docs/documentation/cn/community/verify-apache-release.md b/docs/documentation/cn/community/verify-apache-release.md index a92fd8d1e2..9f37454137 100644 --- a/docs/documentation/cn/community/verify-apache-release.md +++ b/docs/documentation/cn/community/verify-apache-release.md @@ -17,22 +17,22 @@ specific language governing permissions and limitations under the License. --> -# Verify Apache Release +# 验证 Apache 发布版本 -To verify the release, following checklist can used to reference: +可以按照以下步骤对发布版本进行验证： -1. [ ] Download links are valid. -2. [ ] Checksums and PGP signatures are valid. -3. [ ] DISCLAIMER-WIP is included. -4. [ ] Source code artifacts have correct names matching the current release. -5. [ ] LICENSE and NOTICE files are correct for the repository. -6. [ ] All files have license headers if necessary. -7. [ ] No compiled archives bundled in source archive. -8. [ ] Building is OK. +1. [ ] 下载链接是否合法。 +2. [ ] 校验值和 PGP 签名是否合法。 +3. [ ] 是否包含 DISCLAIMER-WIP。 +4. [ ] 代码是否和当前发布版本相匹配。 +5. [ ] LICENSE 和 NOTICE 文件是否正确。 +6. [ ] 所有文件都携带必要的协议说明。 +7. [ ] 在源码包中不包含已经编译好的内容。 +8. [ ] 编译是否能够顺利执行。 -## 1. Download source package, signature file, hash file and KEYS +## 1. 下载源码包、签名文件、校验值文件和 KEYS -Download all artifacts, take a.b.c-incubating as an example: +下载所有相关文件, 以 a.b.c-incubating 为示例: ``` wget https://dist.apache.org/repos/dist/dev/incubator/doris/a.b.c-incubating/apache-doris-a.b.c-incubating-src.tar.gz @@ -44,9 +44,14 @@ wget https://dist.apache.org/repos/dist/dev/incubator/doris/a.b.c-incubating/apa wget https://dist.apache.org/repos/dist/dev/incubator/doris/KEYS ``` -## 2. Verify signature and hash +## 2. 检查签名和校验值 -GnuPG is recommended, which can install by yum install gnupg or apt-get install gnupg. +推荐使用 GunPG，可以通过以下命令安装： + +``` +CentOS: yum install gnupg +Ubuntu: apt-get install gnupg +``` ``` gpg --import KEYS @@ -54,66 +59,23 @@ gpg --verify apache-doris-a.b.c-incubating-src.tar.gz.asc apache-doris-a.b.c-inc sha512sum --check apache-doris-a.b.c-incubating-src.tar.gz.sha512 ``` -## 3. Verify license header +## 3. 验证源码协议头 -Apache RAT is recommended to verify license headder, which can dowload as following command. +推荐使用 Apache RAT 验证源码协议，可以从一下连接下载： ``` wget http://mirrors.tuna.tsinghua.edu.cn/apache//creadur/apache-rat-0.12/apache-rat-0.12-bin.tar.gz tar zxvf apache-rat-0.12-bin.tar.gz ``` -Given your source dir is apache-doris-a.b.c-incubating-src, you can check with following command. -It will output a file list which don't include ASF license header, and these files used other licenses. +假设源码目录名称为 apache-doris-a.b.c-incubating-src，可以使用以下命令进行验证。 +这个命令会产生一个文件，其中列举了所有非 ASF 协议的文件。 ``` /usr/java/jdk/bin/java -jar apache-rat-0.12/apache-rat-0.12.jar -a -d apache-doris-a.b.c-incubating-src -E apache-doris-a.b.c-incubating-src/.rat-excudes ``` -## 4. Verify building +## 4. 验证编译 -Firstly, you must be install and start docker service. +详细的编译步骤，请参阅 [编译文档](../installing/compilation.html) -And then you could build Doris as following steps: - -#### Step1: Pull the docker image with Doris building environment - -``` -$ docker pull apachedoris/doris-dev:build-env -``` - -You can check it by listing images, for example: - -``` -$ docker images -REPOSITORY TAG IMAGE ID CREATED SIZE -apachedoris/doris-dev build-env f8bc5d4024e0 21 hours ago 3.28GB -``` - -#### Step2: Run the Docker image - -You can run image directyly: - -``` -$ docker run -it apachedoris/doris-dev:build-env -``` - -#### Step3: Download Doris source -Now you should in docker environment, and you can download Doris source by release package or by git clone in image. -(If you have downloaded source and it is not in image, you can map its path to image in Step2.) - -``` -$ wget https://dist.apache.org/repos/dist/dev/incubator/doris/xxx.tar.gz -``` - -#### Step4: Build Doris -Now you can enter Doris source path and build Doris. - -``` -$ cd incubator-doris -$ sh build.sh -``` - -After successfully building, it will install binary files in the directory output/. - -For more detail, you can refer to README.md in source package. diff --git a/docs/documentation/cn/downloads/downloads.md b/docs/documentation/cn/downloads/downloads.md new file mode 100644 index 0000000000..febf9e952f --- /dev/null +++ b/docs/documentation/cn/downloads/downloads.md @@ -0,0 +1,13 @@ +# 下载 + +您可以通过以下连接下载对应版本的 Doris 源码进行编译和部署。 + +| 版本 | 发布日期 | 从镜像网站下载 | +|---|---|---| +| 0.11.0 | 2019-11-29 | [Source](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz.sha512)) | +| 0.10.0 | 2019-07-02 | [Source](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz.sha512)) | +| 0.9.0 | 2019-02-18 | [Source](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz.sha512)) | + +关于如何校验下载文件，请参阅 [校验下载文件](../community/verify-apache-release.html)。 + +校验完成后，可以参阅 [编译文档](../installing/compilation.html) 以及 [安装与部署文档](../installing/install-deploy.html) 进行 Doris 的编译、安装与部署。 diff --git a/docs/documentation/cn/downloads/index.rst b/docs/documentation/cn/downloads/index.rst new file mode 100644 index 0000000000..0a7331c37c --- /dev/null +++ b/docs/documentation/cn/downloads/index.rst @@ -0,0 +1,10 @@ +============= +下载 +============= + +.. toctree:: + :maxdepth: 1 + :glob: + + * + diff --git a/docs/documentation/cn/index.rst b/docs/documentation/cn/index.rst index 4c9ed98d3c..d94ac3d1a5 100644 --- a/docs/documentation/cn/index.rst +++ b/docs/documentation/cn/index.rst @@ -7,6 +7,7 @@ .. toctree:: + downloads/index installing/index getting-started/index administrator-guide/index @@ -15,4 +16,3 @@ sql-reference/index developer-guide/index community/index - diff --git a/docs/documentation/en/administrator-guide/alter-table/alter-table-bitmap-index_EN.md b/docs/documentation/en/administrator-guide/alter-table/alter-table-bitmap-index_EN.md index 2143b02ecd..386da49bf7 100644 --- a/docs/documentation/en/administrator-guide/alter-table/alter-table-bitmap-index_EN.md +++ b/docs/documentation/en/administrator-guide/alter-table/alter-table-bitmap-index_EN.md @@ -26,32 +26,32 @@ This document focuses on how to create an index job, as well as some considerati ## Basic Principles Creating and droping index is essentially a schema change job. For details, please refer to -[Schema Change](alter-table-schema-change_EN.md#Basic Principles)。 +[Schema Change](alter-table-schema-change_EN.html)。 ## Syntax There are two forms of index creation and modification related syntax, one is integrated with alter table statement, and the other is using separate create/drop index syntax 1. Create Index - Please refer to [CREATE INDEX](../../sql-reference/sql-statements/Data%20Definition/CREATE%20INDEX_EN.md) - or [ALTER TABLE](../../sql-reference/sql-statements/Data%20Definition/ALTER%20TABLE_EN.md#description), - You can also specify a bitmap index when creating a table，Please refer to [CREATE TABLE](../../sql-reference/sql-statements/Data%20Definition/CREATE%20TABLE_EN.md) + Please refer to [CREATE INDEX](../../sql-reference/sql-statements/Data%20Definition/CREATE%20INDEX_EN.html) + or [ALTER TABLE](../../sql-reference/sql-statements/Data%20Definition/ALTER%20TABLE_EN.html), + You can also specify a bitmap index when creating a table，Please refer to [CREATE TABLE](../../sql-reference/sql-statements/Data%20Definition/CREATE%20TABLE_EN.html) 2. Show Index - Please refer to [SHOW INDEX](../../sql-reference/sql-statements/Administration/SHOW%20INDEX_EN.md) + Please refer to [SHOW INDEX](../../sql-reference/sql-statements/Administration/SHOW%20INDEX_EN.html) 3. Drop Index - Please refer to [DROP INDEX](../../sql-reference/sql-statements/Data%20Definition/DROP%20INDEX_EN.md) or [ALTER TABLE](../../sql-reference/sql-statements/Data%20Definition/ALTER%20TABLE_EN.md#description) + Please refer to [DROP INDEX](../../sql-reference/sql-statements/Data%20Definition/DROP%20INDEX_EN.html) or [ALTER TABLE](../../sql-reference/sql-statements/Data%20Definition/ALTER%20TABLE_EN.html) ## Create Job -Please refer to [Scheam Change](alter-table-schema-change_EN.md#Create Job) +Please refer to [Scheam Change](alter-table-schema-change_EN.html) ## View Job -Please refer to [Scheam Change](alter-table-schema-change_EN.md#View Job) +Please refer to [Scheam Change](alter-table-schema-change_EN.html) ## Cancel Job -Please refer to [Scheam Change](alter-table-schema-change_EN.md#Cancel Job) +Please refer to [Scheam Change](alter-table-schema-change_EN.html) ## Notice * Currently only index of bitmap type is supported. diff --git a/docs/documentation/en/community/verify-apache-release_EN.md b/docs/documentation/en/community/verify-apache-release_EN.md index 0da359b964..805009f52f 100644 --- a/docs/documentation/en/community/verify-apache-release_EN.md +++ b/docs/documentation/en/community/verify-apache-release_EN.md @@ -72,48 +72,4 @@ It will output a file list which don't include ASF license header, and these fil ## 4. Verify building -Firstly, you must be install and start docker service. - -And then you could build Doris as following steps: - -#### Step1: Pull the docker image with Doris building environment - -``` -$ docker pull apachedoris/doris-dev:build-env -``` - -You can check it by listing images, for example: - -``` -$ docker images -REPOSITORY TAG IMAGE ID CREATED SIZE -apachedoris/doris-dev build-env f8bc5d4024e0 21 hours ago 3.28GB -``` - -#### Step2: Run the Docker image - -You can run image directyly: - -``` -$ docker run -it apachedoris/doris-dev:build-env -``` - -#### Step3: Download Doris source -Now you should in docker environment, and you can download Doris source by release package or by git clone in image. -(If you have downloaded source and it is not in image, you can map its path to image in Step2.) - -``` -$ wget https://dist.apache.org/repos/dist/dev/incubator/doris/xxx.tar.gz -``` - -#### Step4: Build Doris -Now you can enter Doris source path and build Doris. - -``` -$ cd incubator-doris -$ sh build.sh -``` - -After successfully building, it will install binary files in the directory output/. - -For more detail, you can refer to README.md in source package. +To compile the Doris, please read [Compilation](../installing/compilation_EN.html) diff --git a/docs/documentation/en/downloads/downloads_EN.md b/docs/documentation/en/downloads/downloads_EN.md new file mode 100644 index 0000000000..c17c98e682 --- /dev/null +++ b/docs/documentation/en/downloads/downloads_EN.md @@ -0,0 +1,13 @@ +# Downloads + +You can download source code from following links, then compile and install Doirs. + +| Version | Release Date | Download Source from Mirror | +|---|---|---| +| 0.11.0 | 2019-11-29 | [Source](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.11.0-incubating/apache-doris-0.11.0-incubating-src.tar.gz.sha512)) | +| 0.10.0 | 2019-07-02 | [Source](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.10.0-incubating/apache-doris-0.10.0-incubating-src.tar.gz.sha512)) | +| 0.9.0 | 2019-02-18 | [Source](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz) ([Signature](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz.asc) [SHA512](https://downloads.apache.org/incubator/doris/0.9.0-incubating/apache-doris-0.9.0-incubating-src.tar.gz.sha512)) | + +To verify the downloaded files, please read [Verify Apache Release](../community/verify-apache-release_EN.html). + +After verification, please read [Compilation](../installing/compilation_EN.html) and [Installation and deployment](../installing/install-deploy_EN.html) to compile and install Doris. diff --git a/docs/documentation/en/downloads/index.rst b/docs/documentation/en/downloads/index.rst new file mode 100644 index 0000000000..78cc4ec691 --- /dev/null +++ b/docs/documentation/en/downloads/index.rst @@ -0,0 +1,10 @@ +============= +Downloads +============= + +.. toctree:: + :maxdepth: 1 + :glob: + + * + diff --git a/docs/documentation/en/getting-started/index.rst b/docs/documentation/en/getting-started/index.rst index 2ce4e86b7e..c9236f6ab3 100644 --- a/docs/documentation/en/getting-started/index.rst +++ b/docs/documentation/en/getting-started/index.rst @@ -1,5 +1,5 @@ ==================== -Getting started +Getting Started ==================== .. toctree:: diff --git a/docs/documentation/en/index.rst b/docs/documentation/en/index.rst index 11676612e7..8b6e2fc3a0 100644 --- a/docs/documentation/en/index.rst +++ b/docs/documentation/en/index.rst @@ -8,6 +8,7 @@ You can simply click "Edit on Github" at right top of a page, and edit the docum .. toctree:: + downloads/index installing/index getting-started/index administrator-guide/index diff --git a/docs/documentation/en/installing/index.rst b/docs/documentation/en/installing/index.rst index 4fa1d6cdc1..6296287f45 100644 --- a/docs/documentation/en/installing/index.rst +++ b/docs/documentation/en/installing/index.rst @@ -1,5 +1,5 @@ =============================== -Compilation and deployment +Compilation and Deployment =============================== .. toctree::