Refactor docs

ideepika · Oct 22, 2017 · 00051d6 · 00051d6
1 parent 23f2b5b
commit 00051d6
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 22 deletions.
diff --git a/docs/about/_about.rst b/docs/about/_about.rst
@@ -0,0 +1,11 @@
+About Jaeger
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   features
+   architecture
+   history
+   roadmap
+
diff --git a/docs/about/architecture.rst b/docs/about/architecture.rst
@@ -0,0 +1,4 @@
+Architecture
+============
+
+Coming soon...
diff --git a/docs/about.rst → docs/about/features.rst b/docs/about.rst → docs/about/features.rst
@@ -1,9 +1,5 @@
-.. about:
-
-About Jaeger
-============
-
-Jaeger is Uber's Distributed Tracing System.
+Features
+========
 
 * Built in the style of Google's Dapper
 * Provides `OpenTracing <http://opentracing.io>`_ compatible instrumentation libraries
@@ -16,8 +12,3 @@ Jaeger is Uber's Distributed Tracing System.
 * Backend components are implemented in Go
 * Uses Cassandra as the storage layer
 
-Coming soon:
-
-* architecture
-* history
-* roadmap
diff --git a/docs/about/history.rst b/docs/about/history.rst
@@ -0,0 +1,4 @@
+History
+=======
+
+Coming soon...
diff --git a/docs/about/roadmap.rst b/docs/about/roadmap.rst
@@ -0,0 +1,4 @@
+Roadmap
+=======
+
+Coming soon...
diff --git a/docs/conf.py b/docs/conf.py
@@ -132,7 +132,10 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'collapse_navigation': False,
+    # 'navigation_depth': 4,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []

diff --git a/docs/getting_started.rst → docs/getting_started/_getting_started.rst b/docs/getting_started.rst → docs/getting_started/_getting_started.rst
@@ -1,5 +1,3 @@
-.. getting_started:
-
 Getting Started with Jaeger
 ===========================
 
@@ -10,10 +8,9 @@ Jaeger client libraries are already open source and for now can be used with Zip
 You can see a HOW-TO example in the blog post `Tracing HTTP request latency in Go with OpenTracing
 <https://medium.com/@YuriShkuro/tracing-http-request-latency-in-go-with-opentracing-7cc1282a100a>`_.
 
-Starting Jaeger Backend in Docker Container
--------------------------------------------
-Coming soon...
+.. toctree::
+   :maxdepth: 2
+
+   backend_in_docker
+   tracing_sample_app
 
-Tracing a Sample Application
-----------------------------
-Coming soon...
diff --git a/docs/getting_started/backend_in_docker.rst b/docs/getting_started/backend_in_docker.rst
@@ -0,0 +1,6 @@
+.. getting_started:
+
+Running Jaeger in Docker Container
+==================================
+
+Coming soon...
diff --git a/docs/getting_started/tracing_sample_app.rst b/docs/getting_started/tracing_sample_app.rst
@@ -0,0 +1,6 @@
+.. getting_started:
+
+Tracing a Sample Application
+============================
+
+Coming soon...
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,6 @@ Welcome to Jaeger's documentation!
 .. toctree::
    :maxdepth: 2
 
-   about
-   getting_started
+   about/_about
+   getting_started/_getting_started