Reorganize documentation index

Moved examples and use cases into a common subdir so those topics will
get grouped together in the main sidebar/TOC
This commit is contained in:
Jon Siwek 2019-01-10 15:45:04 -06:00
parent b1b7027982
commit c46b018fdb
46 changed files with 27 additions and 16 deletions

View file

@ -1,4 +1,8 @@
2.6-62 | 2019-01-10 15:45:04 -0600
* Reorganize documentation index (Jon Siwek, Corelight)
2.6-61 | 2019-01-10 13:40:04 -0600 2.6-61 | 2019-01-10 13:40:04 -0600
* Add RTD yaml config file (Jon Siwek, Corelight) * Add RTD yaml config file (Jon Siwek, Corelight)

View file

@ -1 +1 @@
2.6-61 2.6-62

13
doc/examples/index.rst Normal file
View file

@ -0,0 +1,13 @@
======================
Examples and Use Cases
======================
.. toctree::
:maxdepth: 2
logs/index.rst
httpmonitor/index.rst
ids/index.rst
mimestats/index.rst
scripting/index.rst

View file

@ -121,7 +121,7 @@ default, including:
As you can see, some log files are specific to a particular protocol, As you can see, some log files are specific to a particular protocol,
while others aggregate information across different types of activity. while others aggregate information across different types of activity.
For a complete list of log files and a description of its purpose, For a complete list of log files and a description of its purpose,
see :doc:`Log Files <../script-reference/log-files>`. see :doc:`Log Files </script-reference/log-files>`.
.. _bro-cut: .. _bro-cut:

View file

@ -3,8 +3,8 @@
Zeek Manual Zeek Manual
=========== ===========
Introduction Section Introduction
==================== ============
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -19,22 +19,18 @@ Introduction Section
.. _using-bro: .. _using-bro:
Using Zeek/Bro Section Examples and Use Cases
====================== ======================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
logs/index.rst examples/index.rst
httpmonitor/index.rst
broids/index.rst
mimestats/index.rst
scripting/index.rst
.. ..
Reference Section Reference
================= =========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -52,5 +48,3 @@ Development
devel/plugins.rst devel/plugins.rst
* :ref:`General Index <genindex>` * :ref:`General Index <genindex>`
* :ref:`search`