From 00051d6e032c6603c760c9a0ebe5cfeedb15c660 Mon Sep 17 00:00:00 2001 From: Yuri Shkuro Date: Wed, 9 Nov 2016 19:43:42 -0500 Subject: [PATCH] Refactor docs --- docs/about/_about.rst | 11 +++++++++++ docs/about/architecture.rst | 4 ++++ docs/{about.rst => about/features.rst} | 13 ++----------- docs/about/history.rst | 4 ++++ docs/about/roadmap.rst | 4 ++++ docs/conf.py | 5 ++++- .../_getting_started.rst} | 13 +++++-------- docs/getting_started/backend_in_docker.rst | 6 ++++++ docs/getting_started/tracing_sample_app.rst | 6 ++++++ docs/index.rst | 4 ++-- 10 files changed, 48 insertions(+), 22 deletions(-) create mode 100644 docs/about/_about.rst create mode 100644 docs/about/architecture.rst rename docs/{about.rst => about/features.rst} (75%) create mode 100644 docs/about/history.rst create mode 100644 docs/about/roadmap.rst rename docs/{getting_started.rst => getting_started/_getting_started.rst} (72%) create mode 100644 docs/getting_started/backend_in_docker.rst create mode 100644 docs/getting_started/tracing_sample_app.rst diff --git a/docs/about/_about.rst b/docs/about/_about.rst new file mode 100644 index 000000000000..05b3b616267b --- /dev/null +++ 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 new file mode 100644 index 000000000000..6d693bbf7d16 --- /dev/null +++ b/docs/about/architecture.rst @@ -0,0 +1,4 @@ +Architecture +============ + +Coming soon... diff --git a/docs/about.rst b/docs/about/features.rst similarity index 75% rename from docs/about.rst rename to docs/about/features.rst index aeaab7cd4fdd..ee650dd5010c 100644 --- a/docs/about.rst +++ b/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 `_ 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 new file mode 100644 index 000000000000..9f81b5b23e2a --- /dev/null +++ b/docs/about/history.rst @@ -0,0 +1,4 @@ +History +======= + +Coming soon... diff --git a/docs/about/roadmap.rst b/docs/about/roadmap.rst new file mode 100644 index 000000000000..b1c7d852b343 --- /dev/null +++ b/docs/about/roadmap.rst @@ -0,0 +1,4 @@ +Roadmap +======= + +Coming soon... diff --git a/docs/conf.py b/docs/conf.py index 345f19461ce5..264d4a5105e2 100644 --- 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 b/docs/getting_started/_getting_started.rst similarity index 72% rename from docs/getting_started.rst rename to docs/getting_started/_getting_started.rst index e959e6f93ccd..d53a84c8ad7f 100644 --- a/docs/getting_started.rst +++ b/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 `_. -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 new file mode 100644 index 000000000000..e1ae50eb2195 --- /dev/null +++ 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 new file mode 100644 index 000000000000..4fe8679784ae --- /dev/null +++ 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 index 9300e53c1dd8..c8d115a712df 100644 --- 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