[FLINK-12639] [docs] add "getting started" section to documentation t…

…o expand in FLIP-42
deepfield · Jun 27, 2019 · e377bf6 · e377bf6
1 parent b760d55
commit e377bf6
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 12 deletions.
diff --git a/docs/concepts/index.md b/docs/concepts/index.md
@@ -1,10 +1,9 @@
 ---
 title: Concepts
 nav-id: concepts
-nav-pos: 1
+nav-pos: 2
 nav-title: '<i class="fa fa-map-o title appetizer" aria-hidden="true"></i> Concepts'
 nav-parent_id: root
-section-break: true
 layout: redirect
 redirect: /concepts/programming-model.html
 permalink: /concepts/index.html

diff --git a/docs/concepts/index.zh.md b/docs/concepts/index.zh.md
@@ -1,10 +1,9 @@
 ---
 title: 概念
 nav-id: concepts
-nav-pos: 1
+nav-pos: 2
 nav-title: '<i class="fa fa-map-o title appetizer" aria-hidden="true"></i> 概念'
 nav-parent_id: root
-section-break: true
 layout: redirect
 redirect: /concepts/programming-model.html
 permalink: /concepts/index.html

diff --git a/docs/examples/index.md → docs/getting-started/examples/index.md b/docs/examples/index.md → docs/getting-started/examples/index.md
@@ -2,8 +2,8 @@
 title: Examples
 nav-id: examples
 nav-title: '<i class="fa fa-file-code-o title appetizer" aria-hidden="true"></i> Examples'
-nav-parent_id: root
-nav-pos: 3
+nav-parent_id: getting-started
+nav-pos: 2
 nav-show_overview: true
 ---
 <!--

diff --git a/docs/examples/index.zh.md → docs/getting-started/examples/index.zh.md b/docs/examples/index.zh.md → docs/getting-started/examples/index.zh.md
@@ -2,8 +2,8 @@
 title: 示例
 nav-id: examples
 nav-title: '<i class="fa fa-file-code-o title appetizer" aria-hidden="true"></i> 示例'
-nav-parent_id: root
-nav-pos: 3
+nav-parent_id: getting-started
+nav-pos: 2
 nav-show_overview: true
 ---
 <!--

diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
@@ -0,0 +1,26 @@
+---
+title: "Getting Started"
+nav-id: getting-started
+nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Getting Started'
+nav-parent_id: root
+section-break: true
+nav-pos: 1
+---
+<!--
+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:https://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.
+-->
diff --git a/docs/getting-started/index.zh.md b/docs/getting-started/index.zh.md
@@ -0,0 +1,26 @@
+---
+title: "Getting Started"
+nav-id: getting-started
+nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Getting Started'
+nav-parent_id: root
+section-break: true
+nav-pos: 1
+---
+<!--
+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:https://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.
+-->
diff --git a/docs/tutorials/api_tutorials.md → ...etting-started/tutorials/api_tutorials.md b/docs/tutorials/api_tutorials.md → ...etting-started/tutorials/api_tutorials.md
diff --git a/docs/tutorials/api_tutorials.zh.md → ...ing-started/tutorials/api_tutorials.zh.md b/docs/tutorials/api_tutorials.zh.md → ...ing-started/tutorials/api_tutorials.zh.md
diff --git a/docs/tutorials/datastream_api.md → ...tting-started/tutorials/datastream_api.md b/docs/tutorials/datastream_api.md → ...tting-started/tutorials/datastream_api.md
diff --git a/docs/tutorials/datastream_api.zh.md → ...ng-started/tutorials/datastream_api.zh.md b/docs/tutorials/datastream_api.zh.md → ...ng-started/tutorials/datastream_api.zh.md
diff --git a/docs/tutorials/flink_on_windows.md → ...ing-started/tutorials/flink_on_windows.md b/docs/tutorials/flink_on_windows.md → ...ing-started/tutorials/flink_on_windows.md
diff --git a/docs/tutorials/flink_on_windows.zh.md → ...-started/tutorials/flink_on_windows.zh.md b/docs/tutorials/flink_on_windows.zh.md → ...-started/tutorials/flink_on_windows.zh.md
diff --git a/docs/tutorials/index.md → docs/getting-started/tutorials/index.md b/docs/tutorials/index.md → docs/getting-started/tutorials/index.md
@@ -2,8 +2,8 @@
 title: "Tutorials"
 nav-id: tutorials
 nav-title: '<i class="fa fa-power-off title appetizer" aria-hidden="true"></i> Tutorials'
-nav-parent_id: root
-nav-pos: 2
+nav-parent_id: getting-started
+nav-pos: 1
 ---
 <!--
 Licensed to the Apache Software Foundation (ASF) under one

diff --git a/docs/tutorials/index.zh.md → docs/getting-started/tutorials/index.zh.md b/docs/tutorials/index.zh.md → docs/getting-started/tutorials/index.zh.md
@@ -2,8 +2,8 @@
 title: "教程"
 nav-id: tutorials
 nav-title: '<i class="fa fa-power-off title appetizer" aria-hidden="true"></i> 教程'
-nav-parent_id: root
-nav-pos: 2
+nav-parent_id: getting-started
+nav-pos: 1
 ---
 <!--
 Licensed to the Apache Software Foundation (ASF) under one

diff --git a/docs/tutorials/local_setup.md → .../getting-started/tutorials/local_setup.md b/docs/tutorials/local_setup.md → .../getting-started/tutorials/local_setup.md
diff --git a/docs/tutorials/local_setup.zh.md → ...tting-started/tutorials/local_setup.zh.md b/docs/tutorials/local_setup.zh.md → ...tting-started/tutorials/local_setup.zh.md
diff --git a/docs/tutorials/setup_instructions.md → ...g-started/tutorials/setup_instructions.md b/docs/tutorials/setup_instructions.md → ...g-started/tutorials/setup_instructions.md
diff --git a/docs/tutorials/setup_instructions.zh.md → ...tarted/tutorials/setup_instructions.zh.md b/docs/tutorials/setup_instructions.zh.md → ...tarted/tutorials/setup_instructions.zh.md