Change doc/ subdir into a git submodule

The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek 2019-01-17 14:09:29 -06:00
parent 0d685efbf5
commit 2ff746fea7
693 changed files with 26 additions and 105609 deletions

View file

@ -1,15 +0,0 @@
:tocdepth: 3
policy/tuning/__load__.bro
==========================
This loads the default tuning
:Imports: :doc:`policy/tuning/defaults </scripts/policy/tuning/defaults/index>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,14 +0,0 @@
:tocdepth: 3
policy/tuning/defaults/__load__.bro
===================================
:Imports: :doc:`policy/tuning/defaults/extracted_file_limits.bro </scripts/policy/tuning/defaults/extracted_file_limits.bro>`, :doc:`policy/tuning/defaults/packet-fragments.bro </scripts/policy/tuning/defaults/packet-fragments.bro>`, :doc:`policy/tuning/defaults/warnings.bro </scripts/policy/tuning/defaults/warnings.bro>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,20 +0,0 @@
:tocdepth: 3
policy/tuning/defaults/extracted_file_limits.bro
================================================
:Imports: :doc:`base/files/extract </scripts/base/files/extract/index>`
Summary
~~~~~~~
Redefinitions
#############
========================================================================== =
:bro:id:`FileExtract::default_limit`: :bro:type:`count` :bro:attr:`&redef`
========================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,23 +0,0 @@
:orphan:
Package: policy/tuning/defaults
===============================
Sets various defaults, and prints warning messages to stdout under
certain conditions.
:doc:`/scripts/policy/tuning/defaults/__load__.bro`
:doc:`/scripts/policy/tuning/defaults/packet-fragments.bro`
:doc:`/scripts/policy/tuning/defaults/warnings.bro`
This file is meant to print messages on stdout for settings that would be
good to set in most cases or other things that could be done to achieve
better detection.
:doc:`/scripts/policy/tuning/defaults/extracted_file_limits.bro`

View file

@ -1,20 +0,0 @@
:tocdepth: 3
policy/tuning/defaults/packet-fragments.bro
===========================================
Summary
~~~~~~~
Redefinitions
#############
=============================================================== ============================================================================
:bro:id:`frag_timeout`: :bro:type:`interval` :bro:attr:`&redef` Shorten the fragment timeout from never expiring to expiring fragments after
five minutes.
=============================================================== ============================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,17 +0,0 @@
:tocdepth: 3
policy/tuning/defaults/warnings.bro
===================================
This file is meant to print messages on stdout for settings that would be
good to set in most cases or other things that could be done to achieve
better detection.
:Imports: :doc:`base/utils/site.bro </scripts/base/utils/site.bro>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,34 +0,0 @@
:orphan:
Package: policy/tuning
======================
Miscellaneous tuning parameters.
:doc:`/scripts/policy/tuning/__load__.bro`
This loads the default tuning
:doc:`/scripts/policy/tuning/defaults/__load__.bro`
:doc:`/scripts/policy/tuning/defaults/packet-fragments.bro`
:doc:`/scripts/policy/tuning/defaults/warnings.bro`
This file is meant to print messages on stdout for settings that would be
good to set in most cases or other things that could be done to achieve
better detection.
:doc:`/scripts/policy/tuning/defaults/extracted_file_limits.bro`
:doc:`/scripts/policy/tuning/json-logs.bro`
Loading this script will cause all logs to be written
out as JSON by default.
:doc:`/scripts/policy/tuning/track-all-assets.bro`

View file

@ -1,21 +0,0 @@
:tocdepth: 3
policy/tuning/json-logs.bro
===========================
Loading this script will cause all logs to be written
out as JSON by default.
Summary
~~~~~~~
Redefinitions
#############
================================================================= =
:bro:id:`LogAscii::use_json`: :bro:type:`bool` :bro:attr:`&redef`
================================================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -1,23 +0,0 @@
:tocdepth: 3
policy/tuning/track-all-assets.bro
==================================
:Imports: :doc:`base/frameworks/software </scripts/base/frameworks/software/index>`, :doc:`policy/protocols/conn/known-hosts.bro </scripts/policy/protocols/conn/known-hosts.bro>`, :doc:`policy/protocols/conn/known-services.bro </scripts/policy/protocols/conn/known-services.bro>`, :doc:`policy/protocols/ssl/known-certs.bro </scripts/policy/protocols/ssl/known-certs.bro>`
Summary
~~~~~~~
Redefinitions
#############
======================================================================= =
:bro:id:`Known::cert_tracking`: :bro:type:`Host` :bro:attr:`&redef`
:bro:id:`Known::host_tracking`: :bro:type:`Host` :bro:attr:`&redef`
:bro:id:`Known::service_tracking`: :bro:type:`Host` :bro:attr:`&redef`
:bro:id:`Software::asset_tracking`: :bro:type:`Host` :bro:attr:`&redef`
======================================================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~