From c46b018fdb3d9293e20843e1e48292507ded4db5 Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 10 Jan 2019 15:45:04 -0600 Subject: [PATCH] Reorganize documentation index Moved examples and use cases into a common subdir so those topics will get grouped together in the main sidebar/TOC --- CHANGES | 4 ++++ VERSION | 2 +- .../httpmonitor/file_extraction.bro | 0 .../httpmonitor/http_proxy_01.bro | 0 .../httpmonitor/http_proxy_02.bro | 0 .../httpmonitor/http_proxy_03.bro | 0 .../httpmonitor/http_proxy_04.bro | 0 doc/{ => examples}/httpmonitor/index.rst | 0 doc/{broids => examples/ids}/index.rst | 0 doc/examples/index.rst | 13 +++++++++++ doc/{ => examples}/logs/index.rst | 2 +- doc/{ => examples}/mimestats/index.rst | 0 doc/{ => examples}/mimestats/mimestats.bro | 0 .../scripting/connection_record_01.bro | 0 .../scripting/connection_record_02.bro | 0 .../scripting/data_struct_record_01.bro | 0 .../scripting/data_struct_record_02.bro | 0 .../scripting/data_struct_set_declaration.bro | 0 .../scripting/data_struct_table_complex.bro | 0 .../data_struct_table_declaration.bro | 0 .../scripting/data_struct_vector.bro | 0 .../data_struct_vector_declaration.bro | 0 .../scripting/data_struct_vector_iter.bro | 0 .../scripting/data_type_const.bro | 0 .../scripting/data_type_const_simple.bro | 0 .../scripting/data_type_declaration.bro | 0 .../scripting/data_type_interval.bro | 0 .../scripting/data_type_local.bro | 0 .../scripting/data_type_pattern_01.bro | 0 .../scripting/data_type_pattern_02.bro | 0 .../scripting/data_type_record.bro | 0 .../scripting/data_type_subnets.bro | 0 .../scripting/data_type_time.bro | 0 .../framework_logging_factorial_01.bro | 0 .../framework_logging_factorial_02.bro | 0 .../framework_logging_factorial_03.bro | 0 .../framework_logging_factorial_04.bro | 0 .../scripting/framework_notice_hook_01.bro | 0 .../framework_notice_hook_suppression_01.bro | 0 .../framework_notice_shortcuts_01.bro | 0 .../framework_notice_shortcuts_02.bro | 0 doc/{ => examples}/scripting/http_main.bro | 0 doc/{ => examples}/scripting/index.rst | 0 .../scripting/using_bro_sandbox_01 | 0 .../scripting/using_bro_sandbox_02 | 0 doc/index.rst | 22 +++++++------------ 46 files changed, 27 insertions(+), 16 deletions(-) rename doc/{ => examples}/httpmonitor/file_extraction.bro (100%) rename doc/{ => examples}/httpmonitor/http_proxy_01.bro (100%) rename doc/{ => examples}/httpmonitor/http_proxy_02.bro (100%) rename doc/{ => examples}/httpmonitor/http_proxy_03.bro (100%) rename doc/{ => examples}/httpmonitor/http_proxy_04.bro (100%) rename doc/{ => examples}/httpmonitor/index.rst (100%) rename doc/{broids => examples/ids}/index.rst (100%) create mode 100644 doc/examples/index.rst rename doc/{ => examples}/logs/index.rst (99%) rename doc/{ => examples}/mimestats/index.rst (100%) rename doc/{ => examples}/mimestats/mimestats.bro (100%) rename doc/{ => examples}/scripting/connection_record_01.bro (100%) rename doc/{ => examples}/scripting/connection_record_02.bro (100%) rename doc/{ => examples}/scripting/data_struct_record_01.bro (100%) rename doc/{ => examples}/scripting/data_struct_record_02.bro (100%) rename doc/{ => examples}/scripting/data_struct_set_declaration.bro (100%) rename doc/{ => examples}/scripting/data_struct_table_complex.bro (100%) rename doc/{ => examples}/scripting/data_struct_table_declaration.bro (100%) rename doc/{ => examples}/scripting/data_struct_vector.bro (100%) rename doc/{ => examples}/scripting/data_struct_vector_declaration.bro (100%) rename doc/{ => examples}/scripting/data_struct_vector_iter.bro (100%) rename doc/{ => examples}/scripting/data_type_const.bro (100%) rename doc/{ => examples}/scripting/data_type_const_simple.bro (100%) rename doc/{ => examples}/scripting/data_type_declaration.bro (100%) rename doc/{ => examples}/scripting/data_type_interval.bro (100%) rename doc/{ => examples}/scripting/data_type_local.bro (100%) rename doc/{ => examples}/scripting/data_type_pattern_01.bro (100%) rename doc/{ => examples}/scripting/data_type_pattern_02.bro (100%) rename doc/{ => examples}/scripting/data_type_record.bro (100%) rename doc/{ => examples}/scripting/data_type_subnets.bro (100%) rename doc/{ => examples}/scripting/data_type_time.bro (100%) rename doc/{ => examples}/scripting/framework_logging_factorial_01.bro (100%) rename doc/{ => examples}/scripting/framework_logging_factorial_02.bro (100%) rename doc/{ => examples}/scripting/framework_logging_factorial_03.bro (100%) rename doc/{ => examples}/scripting/framework_logging_factorial_04.bro (100%) rename doc/{ => examples}/scripting/framework_notice_hook_01.bro (100%) rename doc/{ => examples}/scripting/framework_notice_hook_suppression_01.bro (100%) rename doc/{ => examples}/scripting/framework_notice_shortcuts_01.bro (100%) rename doc/{ => examples}/scripting/framework_notice_shortcuts_02.bro (100%) rename doc/{ => examples}/scripting/http_main.bro (100%) rename doc/{ => examples}/scripting/index.rst (100%) rename doc/{ => examples}/scripting/using_bro_sandbox_01 (100%) rename doc/{ => examples}/scripting/using_bro_sandbox_02 (100%) diff --git a/CHANGES b/CHANGES index 65dbbe03d0..7e4a9ff534 100644 --- a/CHANGES +++ b/CHANGES @@ -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 * Add RTD yaml config file (Jon Siwek, Corelight) diff --git a/VERSION b/VERSION index 4d72fbf0fe..3c8e3c7c78 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.6-61 +2.6-62 diff --git a/doc/httpmonitor/file_extraction.bro b/doc/examples/httpmonitor/file_extraction.bro similarity index 100% rename from doc/httpmonitor/file_extraction.bro rename to doc/examples/httpmonitor/file_extraction.bro diff --git a/doc/httpmonitor/http_proxy_01.bro b/doc/examples/httpmonitor/http_proxy_01.bro similarity index 100% rename from doc/httpmonitor/http_proxy_01.bro rename to doc/examples/httpmonitor/http_proxy_01.bro diff --git a/doc/httpmonitor/http_proxy_02.bro b/doc/examples/httpmonitor/http_proxy_02.bro similarity index 100% rename from doc/httpmonitor/http_proxy_02.bro rename to doc/examples/httpmonitor/http_proxy_02.bro diff --git a/doc/httpmonitor/http_proxy_03.bro b/doc/examples/httpmonitor/http_proxy_03.bro similarity index 100% rename from doc/httpmonitor/http_proxy_03.bro rename to doc/examples/httpmonitor/http_proxy_03.bro diff --git a/doc/httpmonitor/http_proxy_04.bro b/doc/examples/httpmonitor/http_proxy_04.bro similarity index 100% rename from doc/httpmonitor/http_proxy_04.bro rename to doc/examples/httpmonitor/http_proxy_04.bro diff --git a/doc/httpmonitor/index.rst b/doc/examples/httpmonitor/index.rst similarity index 100% rename from doc/httpmonitor/index.rst rename to doc/examples/httpmonitor/index.rst diff --git a/doc/broids/index.rst b/doc/examples/ids/index.rst similarity index 100% rename from doc/broids/index.rst rename to doc/examples/ids/index.rst diff --git a/doc/examples/index.rst b/doc/examples/index.rst new file mode 100644 index 0000000000..c8357a7b76 --- /dev/null +++ b/doc/examples/index.rst @@ -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 diff --git a/doc/logs/index.rst b/doc/examples/logs/index.rst similarity index 99% rename from doc/logs/index.rst rename to doc/examples/logs/index.rst index 2a89246560..152c5c4771 100644 --- a/doc/logs/index.rst +++ b/doc/examples/logs/index.rst @@ -121,7 +121,7 @@ default, including: As you can see, some log files are specific to a particular protocol, while others aggregate information across different types of activity. 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 `. .. _bro-cut: diff --git a/doc/mimestats/index.rst b/doc/examples/mimestats/index.rst similarity index 100% rename from doc/mimestats/index.rst rename to doc/examples/mimestats/index.rst diff --git a/doc/mimestats/mimestats.bro b/doc/examples/mimestats/mimestats.bro similarity index 100% rename from doc/mimestats/mimestats.bro rename to doc/examples/mimestats/mimestats.bro diff --git a/doc/scripting/connection_record_01.bro b/doc/examples/scripting/connection_record_01.bro similarity index 100% rename from doc/scripting/connection_record_01.bro rename to doc/examples/scripting/connection_record_01.bro diff --git a/doc/scripting/connection_record_02.bro b/doc/examples/scripting/connection_record_02.bro similarity index 100% rename from doc/scripting/connection_record_02.bro rename to doc/examples/scripting/connection_record_02.bro diff --git a/doc/scripting/data_struct_record_01.bro b/doc/examples/scripting/data_struct_record_01.bro similarity index 100% rename from doc/scripting/data_struct_record_01.bro rename to doc/examples/scripting/data_struct_record_01.bro diff --git a/doc/scripting/data_struct_record_02.bro b/doc/examples/scripting/data_struct_record_02.bro similarity index 100% rename from doc/scripting/data_struct_record_02.bro rename to doc/examples/scripting/data_struct_record_02.bro diff --git a/doc/scripting/data_struct_set_declaration.bro b/doc/examples/scripting/data_struct_set_declaration.bro similarity index 100% rename from doc/scripting/data_struct_set_declaration.bro rename to doc/examples/scripting/data_struct_set_declaration.bro diff --git a/doc/scripting/data_struct_table_complex.bro b/doc/examples/scripting/data_struct_table_complex.bro similarity index 100% rename from doc/scripting/data_struct_table_complex.bro rename to doc/examples/scripting/data_struct_table_complex.bro diff --git a/doc/scripting/data_struct_table_declaration.bro b/doc/examples/scripting/data_struct_table_declaration.bro similarity index 100% rename from doc/scripting/data_struct_table_declaration.bro rename to doc/examples/scripting/data_struct_table_declaration.bro diff --git a/doc/scripting/data_struct_vector.bro b/doc/examples/scripting/data_struct_vector.bro similarity index 100% rename from doc/scripting/data_struct_vector.bro rename to doc/examples/scripting/data_struct_vector.bro diff --git a/doc/scripting/data_struct_vector_declaration.bro b/doc/examples/scripting/data_struct_vector_declaration.bro similarity index 100% rename from doc/scripting/data_struct_vector_declaration.bro rename to doc/examples/scripting/data_struct_vector_declaration.bro diff --git a/doc/scripting/data_struct_vector_iter.bro b/doc/examples/scripting/data_struct_vector_iter.bro similarity index 100% rename from doc/scripting/data_struct_vector_iter.bro rename to doc/examples/scripting/data_struct_vector_iter.bro diff --git a/doc/scripting/data_type_const.bro b/doc/examples/scripting/data_type_const.bro similarity index 100% rename from doc/scripting/data_type_const.bro rename to doc/examples/scripting/data_type_const.bro diff --git a/doc/scripting/data_type_const_simple.bro b/doc/examples/scripting/data_type_const_simple.bro similarity index 100% rename from doc/scripting/data_type_const_simple.bro rename to doc/examples/scripting/data_type_const_simple.bro diff --git a/doc/scripting/data_type_declaration.bro b/doc/examples/scripting/data_type_declaration.bro similarity index 100% rename from doc/scripting/data_type_declaration.bro rename to doc/examples/scripting/data_type_declaration.bro diff --git a/doc/scripting/data_type_interval.bro b/doc/examples/scripting/data_type_interval.bro similarity index 100% rename from doc/scripting/data_type_interval.bro rename to doc/examples/scripting/data_type_interval.bro diff --git a/doc/scripting/data_type_local.bro b/doc/examples/scripting/data_type_local.bro similarity index 100% rename from doc/scripting/data_type_local.bro rename to doc/examples/scripting/data_type_local.bro diff --git a/doc/scripting/data_type_pattern_01.bro b/doc/examples/scripting/data_type_pattern_01.bro similarity index 100% rename from doc/scripting/data_type_pattern_01.bro rename to doc/examples/scripting/data_type_pattern_01.bro diff --git a/doc/scripting/data_type_pattern_02.bro b/doc/examples/scripting/data_type_pattern_02.bro similarity index 100% rename from doc/scripting/data_type_pattern_02.bro rename to doc/examples/scripting/data_type_pattern_02.bro diff --git a/doc/scripting/data_type_record.bro b/doc/examples/scripting/data_type_record.bro similarity index 100% rename from doc/scripting/data_type_record.bro rename to doc/examples/scripting/data_type_record.bro diff --git a/doc/scripting/data_type_subnets.bro b/doc/examples/scripting/data_type_subnets.bro similarity index 100% rename from doc/scripting/data_type_subnets.bro rename to doc/examples/scripting/data_type_subnets.bro diff --git a/doc/scripting/data_type_time.bro b/doc/examples/scripting/data_type_time.bro similarity index 100% rename from doc/scripting/data_type_time.bro rename to doc/examples/scripting/data_type_time.bro diff --git a/doc/scripting/framework_logging_factorial_01.bro b/doc/examples/scripting/framework_logging_factorial_01.bro similarity index 100% rename from doc/scripting/framework_logging_factorial_01.bro rename to doc/examples/scripting/framework_logging_factorial_01.bro diff --git a/doc/scripting/framework_logging_factorial_02.bro b/doc/examples/scripting/framework_logging_factorial_02.bro similarity index 100% rename from doc/scripting/framework_logging_factorial_02.bro rename to doc/examples/scripting/framework_logging_factorial_02.bro diff --git a/doc/scripting/framework_logging_factorial_03.bro b/doc/examples/scripting/framework_logging_factorial_03.bro similarity index 100% rename from doc/scripting/framework_logging_factorial_03.bro rename to doc/examples/scripting/framework_logging_factorial_03.bro diff --git a/doc/scripting/framework_logging_factorial_04.bro b/doc/examples/scripting/framework_logging_factorial_04.bro similarity index 100% rename from doc/scripting/framework_logging_factorial_04.bro rename to doc/examples/scripting/framework_logging_factorial_04.bro diff --git a/doc/scripting/framework_notice_hook_01.bro b/doc/examples/scripting/framework_notice_hook_01.bro similarity index 100% rename from doc/scripting/framework_notice_hook_01.bro rename to doc/examples/scripting/framework_notice_hook_01.bro diff --git a/doc/scripting/framework_notice_hook_suppression_01.bro b/doc/examples/scripting/framework_notice_hook_suppression_01.bro similarity index 100% rename from doc/scripting/framework_notice_hook_suppression_01.bro rename to doc/examples/scripting/framework_notice_hook_suppression_01.bro diff --git a/doc/scripting/framework_notice_shortcuts_01.bro b/doc/examples/scripting/framework_notice_shortcuts_01.bro similarity index 100% rename from doc/scripting/framework_notice_shortcuts_01.bro rename to doc/examples/scripting/framework_notice_shortcuts_01.bro diff --git a/doc/scripting/framework_notice_shortcuts_02.bro b/doc/examples/scripting/framework_notice_shortcuts_02.bro similarity index 100% rename from doc/scripting/framework_notice_shortcuts_02.bro rename to doc/examples/scripting/framework_notice_shortcuts_02.bro diff --git a/doc/scripting/http_main.bro b/doc/examples/scripting/http_main.bro similarity index 100% rename from doc/scripting/http_main.bro rename to doc/examples/scripting/http_main.bro diff --git a/doc/scripting/index.rst b/doc/examples/scripting/index.rst similarity index 100% rename from doc/scripting/index.rst rename to doc/examples/scripting/index.rst diff --git a/doc/scripting/using_bro_sandbox_01 b/doc/examples/scripting/using_bro_sandbox_01 similarity index 100% rename from doc/scripting/using_bro_sandbox_01 rename to doc/examples/scripting/using_bro_sandbox_01 diff --git a/doc/scripting/using_bro_sandbox_02 b/doc/examples/scripting/using_bro_sandbox_02 similarity index 100% rename from doc/scripting/using_bro_sandbox_02 rename to doc/examples/scripting/using_bro_sandbox_02 diff --git a/doc/index.rst b/doc/index.rst index d13a8e51bd..70eafc600a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,8 +3,8 @@ Zeek Manual =========== -Introduction Section -==================== +Introduction +============ .. toctree:: :maxdepth: 2 @@ -15,26 +15,22 @@ Introduction Section quickstart/index.rst configuration/index.rst -.. +.. .. _using-bro: -Using Zeek/Bro Section +Examples and Use Cases ====================== .. toctree:: - :maxdepth: 2 + :maxdepth: 3 - logs/index.rst - httpmonitor/index.rst - broids/index.rst - mimestats/index.rst - scripting/index.rst + examples/index.rst .. -Reference Section -================= +Reference +========= .. toctree:: :maxdepth: 2 @@ -52,5 +48,3 @@ Development devel/plugins.rst * :ref:`General Index ` -* :ref:`search` -