diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 4b4f1a4..01c8b3e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,22 +12,9 @@ reasons (for example in isolating cross-project performance issues). .. toctree:: :maxdepth: 2 - background - api - integration - collectors - similar_projects + user/index -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/api.rst b/doc/source/user/api.rst similarity index 100% rename from doc/source/api.rst rename to doc/source/user/api.rst diff --git a/doc/source/background.rst b/doc/source/user/background.rst similarity index 100% rename from doc/source/background.rst rename to doc/source/user/background.rst diff --git a/doc/source/collectors.rst b/doc/source/user/collectors.rst similarity index 100% rename from doc/source/collectors.rst rename to doc/source/user/collectors.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..fe317da --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,27 @@ +================ +Using OSProfiler +================ + +OSProfiler provides a tiny but powerful library that is used by +most (soon to be all) OpenStack projects and their python clients. It +provides functionality to generate 1 trace per request, that goes +through all involved services. This trace can then be extracted and used +to build a tree of calls which can be quite handy for a variety of +reasons (for example in isolating cross-project performance issues). + +.. toctree:: + :maxdepth: 2 + + background + api + integration + collectors + similar_projects + +Release Notes +============= + +.. toctree:: + :maxdepth: 1 + + history diff --git a/doc/source/integration.rst b/doc/source/user/integration.rst similarity index 100% rename from doc/source/integration.rst rename to doc/source/user/integration.rst diff --git a/doc/source/similar_projects.rst b/doc/source/user/similar_projects.rst similarity index 100% rename from doc/source/similar_projects.rst rename to doc/source/user/similar_projects.rst