From f8620d0ed228766db4b5fd6bd43a216120713dcf Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Thu, 25 May 2023 13:21:11 -0600 Subject: [PATCH] docs: update url to docs.suricata.io --- Makefile.am | 2 +- README.md | 4 ++-- doc/INSTALL | 2 +- doc/Setting_up_IPSinline_for_Linux.txt | 2 +- .../devguide/codebase/contributing/contribution-process.rst | 2 +- doc/userguide/devguide/codebase/unittests-c.rst | 4 ++-- .../devguide/extending/app-layer/app-layer-frames.rst | 2 +- lua/fast.lua | 2 +- src/suricata.h | 2 +- suricata.yaml.in | 6 +++--- threshold.config | 4 ++-- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Makefile.am b/Makefile.am index b061fa475eb1..a5a71f710efc 100644 --- a/Makefile.am +++ b/Makefile.am @@ -54,7 +54,7 @@ endif @echo "updated and managed with the suricata-update tool." @echo "" @echo "For more information please see:" - @echo " https://suricata.readthedocs.io/en/latest/rule-management/index.html" + @echo " https://docs.suricata.io/en/latest/rule-management/index.html" @echo "" install-library: diff --git a/README.md b/README.md index 436dc5ce8209..206712806bed 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ Introduction Installation ------------ -https://suricata.readthedocs.io/en/latest/install.html +https://docs.suricata.io/en/latest/install.html User Guide ---------- -You can follow the [Suricata user guide](https://suricata.readthedocs.io/en/latest/) to get started. +You can follow the [Suricata user guide](https://docs.suricata.io/en/latest/) to get started. Contributing ------------ diff --git a/doc/INSTALL b/doc/INSTALL index f7cb93311021..08b2effe8a41 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -2,4 +2,4 @@ See doc/userguide/install.rst An hosted version of this can be found at Read The Docs: -https://suricata.readthedocs.io/en/latest/install.html +https://docs.suricata.io/en/latest/install.html diff --git a/doc/Setting_up_IPSinline_for_Linux.txt b/doc/Setting_up_IPSinline_for_Linux.txt index f499a8994c78..3e2ee62beb26 100644 --- a/doc/Setting_up_IPSinline_for_Linux.txt +++ b/doc/Setting_up_IPSinline_for_Linux.txt @@ -1,5 +1,5 @@ Autogenerated on 2012-11-29 -from - https://suricata.readthedocs.io/en/latest/setting-up-ipsinline-for-linux.html +from - https://docs.suricata.io/en/latest/setting-up-ipsinline-for-linux.html Setting up IPS/inline for Linux diff --git a/doc/userguide/devguide/codebase/contributing/contribution-process.rst b/doc/userguide/devguide/codebase/contributing/contribution-process.rst index 4bb7405cd8f0..198ff142afc2 100644 --- a/doc/userguide/devguide/codebase/contributing/contribution-process.rst +++ b/doc/userguide/devguide/codebase/contributing/contribution-process.rst @@ -203,7 +203,7 @@ If you are writing or updating *documentation pages*, please: * when adding diagrams or images, we prefer alternatives that can be generated automatically, if possible; * bear in mind that our documentation is published on `Read the Docs `_ and can also be + /docs.suricata.io/en/latest/#suricata-user-guide>`_ and can also be built to pdf, so it is important that it looks good in such formats. diff --git a/doc/userguide/devguide/codebase/unittests-c.rst b/doc/userguide/devguide/codebase/unittests-c.rst index bed54c87db88..0ae7bdf92e0c 100644 --- a/doc/userguide/devguide/codebase/unittests-c.rst +++ b/doc/userguide/devguide/codebase/unittests-c.rst @@ -19,7 +19,7 @@ If you would like to compile Suricata with unit tests, enter the following durin ./configure --enable-unittests -The unit tests specific command line options can be found at `Command Line Options `_. +The unit tests specific command line options can be found at `Command Line Options `_. Example: You can run tests specifically on flowbits. This is how you should do that:: @@ -42,7 +42,7 @@ This will be very verbose. You can also add the ``SC_LOG_OP_FILTER`` to limit th SC_LOG_LEVEL=Debug SC_LOG_OP_FILTER="(something|somethingelse)" suricata -u This example will show all lines (debug, info, and all other levels) that contain either something or something else. -Keep in mind the `log level `_ precedence: if you choose *Info* level, for instance, Suricata won't show messages from the other levels. +Keep in mind the `log level `_ precedence: if you choose *Info* level, for instance, Suricata won't show messages from the other levels. Writing Unit Tests - C codebase =============================== diff --git a/doc/userguide/devguide/extending/app-layer/app-layer-frames.rst b/doc/userguide/devguide/extending/app-layer/app-layer-frames.rst index ec16ea91c9b2..a810f5588dcd 100644 --- a/doc/userguide/devguide/extending/app-layer/app-layer-frames.rst +++ b/doc/userguide/devguide/extending/app-layer/app-layer-frames.rst @@ -7,7 +7,7 @@ Application Layer Frame Support Baseline ======== -- `Suricata rules format `_ +- `Suricata rules format `_ General Concepts ================ diff --git a/lua/fast.lua b/lua/fast.lua index 17551900bec8..ffb3b01f6e7c 100644 --- a/lua/fast.lua +++ b/lua/fast.lua @@ -10,7 +10,7 @@ -- To learn more about all the API functions suricata provides for your lua scripts -- and the lua output extension in general see: --- http://suricata.readthedocs.io/en/latest/output/lua-output.html +-- http://docs.suricata.io/en/latest/output/lua-output.html function init() local needs = {} diff --git a/src/suricata.h b/src/suricata.h index f4ce718f7eb3..82b049f583e2 100644 --- a/src/suricata.h +++ b/src/suricata.h @@ -82,7 +82,7 @@ #define DEFAULT_PID_BASENAME "suricata.pid" #define DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME -#define DOC_URL "https://suricata.readthedocs.io/en/" +#define DOC_URL "https://docs.suricata.io/en/" const char *GetDocURL(void); /* runtime engine control flags */ diff --git a/suricata.yaml.in b/suricata.yaml.in index 947a68268228..fdf68f0a7040 100644 --- a/suricata.yaml.in +++ b/suricata.yaml.in @@ -3,7 +3,7 @@ # Suricata configuration file. In addition to the comments describing all # options in this file, full documentation can be found at: -# https://suricata.readthedocs.io/en/latest/configuration/suricata-yaml.html +# https://docs.suricata.io/en/latest/configuration/suricata-yaml.html # This configuration file generated by Suricata @PACKAGE_VERSION@. suricata-version: "@MAJOR_MINOR@" @@ -217,7 +217,7 @@ outputs: - dns: # This configuration uses the new DNS logging format, # the old configuration is still available: - # https://suricata.readthedocs.io/en/latest/output/eve/eve-json-output.html#dns-v1-format + # https://docs.suricata.io/en/latest/output/eve/eve-json-output.html#dns-v1-format # As of Suricata 5.0, version 2 of the eve dns output # format is the default. @@ -539,7 +539,7 @@ outputs: # Lua Output Support - execute lua script to generate alert and event # output. # Documented at: - # https://suricata.readthedocs.io/en/latest/output/lua-output.html + # https://docs.suricata.io/en/latest/output/lua-output.html - lua: enabled: no #scripts-dir: /etc/suricata/lua-output/ diff --git a/threshold.config b/threshold.config index bb992b6ee767..670a57a973a6 100644 --- a/threshold.config +++ b/threshold.config @@ -13,11 +13,11 @@ # suppress gen_id , sig_id # suppress gen_id , sig_id , track , ip # -# The options are documented at https://suricata.readthedocs.io/en/latest/configuration/global-thresholds.html +# The options are documented at https://docs.suricata.io/en/latest/configuration/global-thresholds.html # # Please note that thresholding can also be set inside a signature. The interaction between rule based thresholds # and global thresholds is documented here: -# https://suricata.readthedocs.io/en/latest/configuration/global-thresholds.html#global-thresholds-vs-rule-thresholds +# https://docs.suricata.io/en/latest/configuration/global-thresholds.html#global-thresholds-vs-rule-thresholds # Limit to 10 alerts every 10 seconds for each source host #threshold gen_id 0, sig_id 0, type limit, track by_src, count 10, seconds 10