[Enhancement] documents rebuild with Vuepress (#3408)

.gitignore

@@ -3,7 +3,9 @@
 be/output
 be/build
 output
-docs/build
+docs/.temp
+docs/.vuepress/dist
+docs/node_modules
 gensrc/build
 fe/target
 thirdparty/src

.travis.yml

@@ -0,0 +1,58 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+language: node_js
+# nodejs版本
+node_js: 
+    - '8'
+
+# Travis-CI Caching
+cache:
+  directories:
+    - docs/node_modules
+
+
+# S: Build Lifecycle
+install:
+  - cd docs && npm install
+
+before_script:
+  - export PR=https://api.github.com/repos/$TRAVIS_REPO_SLUG/pulls/$TRAVIS_PULL_REQUEST
+  - export BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo `curl -s $PR | jq -r .head.ref`; fi)
+  - echo $BRANCH
+  - sed -i 's/base:.*,/base:\"\/'$BRANCH'\/\",/g' .vuepress/config.js 
+  - sed -i 's/docsBranch:.*,/docsBranch:\"'$BRANCH'\",/g' .vuepress/config.js 
+  - rm -rf site-repo
+
+script:
+  - npm run build
+
+after_script:
+  - if [ "$TRAVIS_EVENT_TYPE" != "push" ]; then exit 0; fi
+  - git config user.name "${GIT_NAME}"
+  - git config user.email "${GIT_EMAIL}"
+  - git clone https://${SITE_REPO} site-repo
+  - cd site-repo
+  - mkdir -p ${BRANCH} && rm -rf ${BRANCH}/*
+  - cp -r ../.vuepress/dist/* ./${BRANCH}/
+  - git checkout ${SITE_BRANCH}
+  - git add .
+  - git commit -am "Auto Build"
+  - git push --force --quiet "https://${SITE_PUSH_TOKEN}@${SITE_REPO}" ${SITE_BRANCH}:${SITE_BRANCH}
+
+branches:
+  only:
+    - master
+    - /^branch-.*$/

LICENSE.txt

@@ -630,3 +630,27 @@ be/src/util/condition_variable* : BSD-style license
 Copyright (c) 2011 The Chromium Authors. All rights reserved.
 Use of this source code is governed by a BSD-style license that can be
 found in the LICENSE file.
+
+--------------------------------------------------------------------------------
+
+docs/.vuepress/* The MIT License (MIT)
+
+Copyright (c) 2018-present, Yuxi (Evan) You
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

docs/.markdownlint.yml

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+{
+  "default": true,
+  "MD013": false,
+}

docs/.markdownlintignore

@@ -0,0 +1,2 @@
+node_modules
+.vuepress

docs/.vuepress/config.js

@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+function convertSidebar(list, path) {
+  if (list.length > 0) {
+      list.forEach((element, i) => {
+        if (element.children) {
+            convertSidebar(element.children, path + element.directoryPath)
+            delete element.directoryPath
+        } else {
+            list[i] = path + element
+        }
+      });
+  }
+  return list
+}
+
+module.exports = {
+  base: '',
+  locales: {
+    '/en/': {
+      lang: 'en',
+      title: 'Apache Doris',
+      description: 'Apache Doris'
+    },
+    '/zh-CN/': {
+      lang: 'zh-CN',
+      title: 'Apache Doris',
+      description: 'Apache Doris'
+    }
+  },
+  head: [
+    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
+    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
+    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
+    ['meta', { name: 'msapplication-TileColor', content: '#000000' }]
+  ],
+  title: 'Apache Doris',
+  description: 'Apache Doris',
+  themeConfig: {
+    title: 'Doris',
+    logo: '/images/doris-logo-only.png',
+    search: true,
+    smoothScroll: true,
+    searchMaxSuggestions: 10,
+    nextLinks: true,
+    prevLinks: true,
+    repo: 'apache/incubator-doris',
+    repoLabel: 'GitHub',
+    lastUpdated: 'Last Updated',
+    editLinks: true,
+    docsDir: 'docs',
+    docsBranch: '',
+    locales: {
+      '/en/': {
+        selectText: 'Languages',
+        label: 'English',
+        ariaLabel: 'Languages',
+        editLinkText: 'Edit this page on GitHub',
+        algolia: {},
+        nav: [
+          {
+            text: 'Home', link: '/en/'
+          },
+          {
+            text: 'Docs', link: '/en/installing/compilation'
+          },
+          {
+            text: 'Download', link: '/en/downloads/downloads'
+          },
+          {
+            text: 'Apache', link: 'https://www.apache.org/', target: '_blank'
+          }
+        ],
+        sidebar: convertSidebar(require('./sidebar/en.js'), '/en/')
+      },
+      '/zh-CN/': {
+        selectText: '选择语言',
+        label: '简体中文',
+        editLinkText: '在 GitHub 上编辑此页',
+        nav: [
+          {
+            text: '主页', link: '/zh-CN/'
+          },
+          {
+            text: '文档', link: '/zh-CN/installing/compilation'
+          },
+          {
+            text: '下载', link: '/zh-CN/downloads/downloads'
+          },
+          {
+            text: 'Apache', link: 'https://www.apache.org/', target: '_blank'
+          }
+        ],
+        algolia: {},
+        sidebar: {
+          '/zh-CN/': convertSidebar(require('./sidebar/zh-CN.js'), '/zh-CN/')
+        }
+      }
+    }
+  },
+  plugins: [
+    'reading-progress', 'plugin-back-to-top', 'plugin-medium-zoom'
+  ]
+};