Merge pull request #19 from keti-openfx/hotfix/fix-contents-in-doc

fix: 목차관련 동민형 피드백 반영
keti-openfx · Aug 6, 2020 · 4c3a15a · 4c3a15a
2 parents 5e7f3b8 + 75e3316
commit 4c3a15a
Show file tree

Hide file tree

Showing 32 changed files with 46 additions and 77 deletions.
diff --git a/docs/source/1_introduction/index.md b/docs/source/1_introduction/index.md
@@ -1,6 +1,3 @@
 # Introduction
 
-
-
-- OpenFx 소개
-- Benchmark 결과 소개
+- OpenFx 소개
diff --git a/docs/source/2_setup/3_cli_setup/index.md → docs/source/2_setup/1_cli_setup/index.md b/docs/source/2_setup/3_cli_setup/index.md → docs/source/2_setup/1_cli_setup/index.md
diff --git a/docs/source/2_setup/1_on_premise/index.md b/docs/source/2_setup/1_on_premise/index.md
diff --git a/docs/source/2_setup/2_kubernetes_setup/1_kubernetes_setup/index.md b/docs/source/2_setup/2_kubernetes_setup/1_kubernetes_setup/index.md
diff --git a/docs/source/2_setup/2_kubernetes_setup/2_minikube_setup/index.md b/docs/source/2_setup/2_kubernetes_setup/2_minikube_setup/index.md
diff --git a/docs/source/2_setup/2_kubernetes_setup/index.rst b/docs/source/2_setup/2_kubernetes_setup/index.rst
diff --git a/docs/source/2_setup/2_openfx_setup/index.md b/docs/source/2_setup/2_openfx_setup/index.md
@@ -0,0 +1,4 @@
+OpenFx Setup
+====================================
+
+On-premise / Kubernetes & Minikube 설치방법 / OpenFx 설치방법
diff --git a/docs/source/2_setup/index.rst b/docs/source/2_setup/index.rst
@@ -7,7 +7,7 @@ In This Section
 .. toctree::
    :maxdepth: 1
 
-   1_on_premise/index
-   2_kubernetes_setup/index
-   3_cli_setup/index
+   1_cli_setup/index
+   2_openfx_setup/index
+
 
diff --git a/docs/source/3_concepts/2_function/index.md b/docs/source/3_concepts/2_function/index.md
diff --git a/docs/source/3_getting_started/1_overview/index.md b/docs/source/3_getting_started/1_overview/index.md
@@ -0,0 +1,4 @@
+Overview
+====================================
+
+- 함수 생성, 빌드, 테스트, 배포의 일련 과정 설명 및 CLI 명령어 및 flag 전체 설명
diff --git a/...ce/4_tasks/1_deploying_functions/index.md → ...ng_started/2_deploying_functions/index.md b/...ce/4_tasks/1_deploying_functions/index.md → ...ng_started/2_deploying_functions/index.md
diff --git a/docs/source/4_tasks/2_interface/index.md → ...ce/3_getting_started/3_interface/index.md b/docs/source/4_tasks/2_interface/index.md → ...ce/3_getting_started/3_interface/index.md
diff --git a/..._tasks/3_invoke_internal_service/index.md → ...tarted/4_invoke_internal_service/index.md b/..._tasks/3_invoke_internal_service/index.md → ...tarted/4_invoke_internal_service/index.md
@@ -5,9 +5,8 @@ Service mesh 사용 방법
 
 
 
-Golang
+- Golang
 
-- Init function
 - Python2.7 (이하 언어들 모두 동일)
 - Python3.6
 - Node Js

diff --git a/docs/source/3_getting_started/index.rst b/docs/source/3_getting_started/index.rst
@@ -0,0 +1,16 @@
+Getting Started
+====================================
+
+Learn how to perform specific tasks with Nuclio.
+
+In This Section
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   1_overview/index
+   2_deploying_functions/index
+   3_interface/index
+   4_invoke_internal_service/index
+
diff --git a/docs/source/5_examples/index.md → docs/source/4_examples/index.md b/docs/source/5_examples/index.md → docs/source/4_examples/index.md
diff --git a/docs/source/4_tasks/index.rst b/docs/source/4_tasks/index.rst
diff --git a/docs/source/3_concepts/.index.rst.swp → docs/source/5_components/.index.rst.swp b/docs/source/3_concepts/.index.rst.swp → docs/source/5_components/.index.rst.swp
diff --git a/...source/3_concepts/1_architecture/index.md → ...urce/5_components/1_architecture/index.md b/...source/3_concepts/1_architecture/index.md → ...urce/5_components/1_architecture/index.md
diff --git a/docs/source/5_components/2_function/index.md b/docs/source/5_components/2_function/index.md
@@ -0,0 +1,5 @@
+# Function
+
+
+
+- 함수 구조
diff --git a/...ncepts/3_invoke_internal_service/index.md → ...onents/3_invoke_internal_service/index.md b/...ncepts/3_invoke_internal_service/index.md → ...onents/3_invoke_internal_service/index.md
diff --git a/docs/source/3_concepts/4_auth/index.md → docs/source/5_components/4_auth/index.md b/docs/source/3_concepts/4_auth/index.md → docs/source/5_components/4_auth/index.md
diff --git a/docs/source/3_concepts/5_grpc_http/index.md → .../source/5_components/5_grpc_http/index.md b/docs/source/3_concepts/5_grpc_http/index.md → .../source/5_components/5_grpc_http/index.md
diff --git a/docs/source/3_concepts/6_logger/index.md → docs/source/5_components/6_logger/index.md b/docs/source/3_concepts/6_logger/index.md → docs/source/5_components/6_logger/index.md
diff --git a/docs/source/3_concepts/7_gpu/index.md → docs/source/5_components/7_gpu/index.md b/docs/source/3_concepts/7_gpu/index.md → docs/source/5_components/7_gpu/index.md
diff --git a/docs/source/3_concepts/index.rst → docs/source/5_components/index.rst b/docs/source/3_concepts/index.rst → docs/source/5_components/index.rst
@@ -1,4 +1,4 @@
-Concepts
+Components
 ====================================
 Get introduced to basic concepts, architecture, and components of Nuclio.
 

diff --git a/docs/source/7_references/2_cli_reference/index.md b/docs/source/7_references/2_cli_reference/index.md
diff --git a/..._references/3_executor_reference/index.md → ..._references/2_executor_reference/index.md b/..._references/3_executor_reference/index.md → ..._references/2_executor_reference/index.md
diff --git a/..._references/4_runtimes_reference/index.md → ..._references/3_runtimes_reference/index.md b/..._references/4_runtimes_reference/index.md → ..._references/3_runtimes_reference/index.md
diff --git a/...ce/7_references/5_auth_reference/index.md → ...ce/7_references/4_auth_reference/index.md b/...ce/7_references/5_auth_reference/index.md → ...ce/7_references/4_auth_reference/index.md
diff --git a/docs/source/7_references/5_benchmark/index.md b/docs/source/7_references/5_benchmark/index.md
@@ -0,0 +1,4 @@
+Benchmark
+====================================
+
+- OpenFx Benchmark 결과 소개
diff --git a/docs/source/7_references/index.rst b/docs/source/7_references/index.rst
@@ -9,8 +9,8 @@ In This Section
    :maxdepth: 1
 
    1_configure_platform_reference/index
-   2_cli_reference/index   
-   3_executor_reference/index
-   4_runtimes_reference/index
-   5_auth_reference/index
+   2_executor_reference/index
+   3_runtimes_reference/index
+   4_auth_reference/index
+   5_benchmark/index
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,9 +23,9 @@ Table of Contents
 
    1_introduction/index
    2_setup/index
-   3_concepts/index
-   4_tasks/index
-   5_examples/index
+   3_getting_started/index
+   4_examples/index
+   5_components/index
    6_roadmap/index
    7_references/index
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,9 +5,8 @@ Service mesh 사용 방법 @@
-    Golang
+    - Golang
-    - Init function
     - Python2.7 (이하 언어들 모두 동일)
     - Python3.6
     - Node Js
@@ Expand Down @@