From ddb6ddb0401509234b8520ae36cba0a9d47442a7 Mon Sep 17 00:00:00 2001 From: gethvi Date: Tue, 27 Feb 2024 16:23:33 +0100 Subject: [PATCH 1/2] DOC: Updates links to new documentation. --- .github/pull_request_template.md | 2 +- NEWS.md | 8 ++++---- contrib/eventdb/README.md | 2 +- intelmq/bin/intelmqctl.py | 2 +- intelmq/bots/parsers/generic/parser_csv.py | 2 +- intelmq/lib/bot.py | 4 ++-- setup.py | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e635634b8..76458f19b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ # Please read the notes below and replace them with the description of you pull request -Make sure you follow the instructions in the [Developer Guide](https://intelmq.readthedocs.io/en/latest/dev/guide.html) - it describes how to run the test suite and which coding rules to follow. +Make sure you follow the instructions in the [Developer Guide](https://docs.intelmq.org/latest/dev/intro/) - it describes how to run the test suite and which coding rules to follow. # Commits diff --git a/NEWS.md b/NEWS.md index 80404d6d5..756f8a3f4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -59,7 +59,7 @@ Deb-packages of intelmq-api 3.2.0 are delayed for some distributions because of #### Shadowserver Reports API collector The misleading `country` parameter has been depreciated and a `reports` parameter has been added. The backwards-compatibility will be removed in IntelMQ version 4.0.0. -See the [Shadowserver Reports API bot's documentation](https://intelmq.readthedocs.io/en/latest/user/bots.html#shadowserver-reports-api). +See the [Shadowserver Reports API bot's documentation](https://docs.intelmq.org/latest/user/bots/#shadowserver-reports-api). #### GitHub Collector GitHub removed the basic `Username/Password` Authentication in favor of personal access tokens. So the GitHub Collector uses an Personal Access Token for authentication [GitHub Documentation: Generate a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) @@ -76,7 +76,7 @@ IntelMQ previously supported two feeds: "Feodo Tracker IPs" (downloaded as CSV f #### Field name checks The field names for all data added to messages must match a pre-defined format. The check which ensures this, was ineffective prior to this version and is effective again starting with version 3.1.0. -The [Data format documentation](https://intelmq.readthedocs.io/en/maintenance/dev/data-format.html#rules-for-keys) describes the required format. +The [Data format documentation](https://docs.intelmq.org/latest/dev/data-format/#rules-for-keys) describes the required format. ### Logrotate The packaged configuration for *logrotate* falsely contained options applying to other programs' log files. This caused wrong ownership of log files. @@ -172,7 +172,7 @@ New features: * negation of arbitrary expressions and expression groups separated by brackets through a prepended `!`, e.g `! src.port :in [80, 443]` * non-string values accepted by `add`/`add!`/`update` -The [sieve bot documentation](https://intelmq.readthedocs.io/en/maintenance/user/bots.html#intelmq-bots-experts-sieve-expert) has been updated to reflect on these new changes. +The [sieve bot documentation](https://docs.intelmq.org/latest/user/bots/#sieve) has been updated to reflect on these new changes. ### Data format The classification scheme has been updated to better match the [Reference Security Incident Taxonomy (RSIT)](https://github.com/enisaeu/Reference-Security-Incident-Taxonomy-Task-Force/). The following labels were renamed, deleted or merged into others: @@ -307,7 +307,7 @@ The `intelmqctl upgrade-config` command automatically fixes a configuration if t Shadowserver changed some of their feeds, for more information see [Changes in Sinkhole and Honeypot Report Types and Formats](https://www.shadowserver.org/news/changes-in-sinkhole-and-honeypot-report-types-and-formats/). Support for the legacy feeds has not been removed yet. -The [Shadowserver Parser Bot documentation](https://intelmq.readthedocs.io/en/maintenance/user/bots.html#shadowserver-supported-reports) lists the supported feeds, as well as the legacy feeds. +The [Shadowserver Parser Bot documentation](https://docs.intelmq.org/latest/user/bots/#shadowserver) lists the supported feeds, as well as the legacy feeds. 2.3.2 Bugfix release (2021-04-27) diff --git a/contrib/eventdb/README.md b/contrib/eventdb/README.md index 1fd5ddd33..7693a900a 100644 --- a/contrib/eventdb/README.md +++ b/contrib/eventdb/README.md @@ -11,7 +11,7 @@ EventDB Utilities It queries the database for all distinct malware names with the taxonomy "malicious-code" and sets another column to the malware family name. - Apply Domain Suffix: Writes the public domain suffix to the `source.domain_suffix` / `destination.domain_suffix` columns, extracted from `source.fqdn` / `destination.fqdn`. - PostgreSQL trigger keeping track of the oldest inserted/updated "time.source" data. This can be useful to (re-)generate statistics or aggregation data. -- SQL queries to set up a separate `raws` table, described in https://intelmq.readthedocs.io/en/latest/user/eventdb.html#separating-raw-values-in-postgresql-using-view-and-trigger +- SQL queries to set up a separate `raws` table, described in https://docs.intelmq.org/latest/admin/database/postgresql/#separating-raw-values-in-postgresql-using-view-and-trigger Usage ----- diff --git a/intelmq/bin/intelmqctl.py b/intelmq/bin/intelmqctl.py index 9ad9266d0..d02c8972b 100644 --- a/intelmq/bin/intelmqctl.py +++ b/intelmq/bin/intelmqctl.py @@ -898,7 +898,7 @@ def check(self, no_connections=False, check_executables=True): if orphan_queues: check_logger.warning("Orphaned queues found: '%s'. Possible leftover from past reconfigurations " "without cleanup. Have a look at the FAQ at " - "https://intelmq.readthedocs.io/en/maintenance/user/FAQ.html" + "https://docs.intelmq.org/latest/admin/faq/" "#orphaned-queues", orphan_queues) check_logger.info('Checking harmonization configuration.') diff --git a/intelmq/bots/parsers/generic/parser_csv.py b/intelmq/bots/parsers/generic/parser_csv.py index 3401c8276..e82b107af 100644 --- a/intelmq/bots/parsers/generic/parser_csv.py +++ b/intelmq/bots/parsers/generic/parser_csv.py @@ -28,7 +28,7 @@ from intelmq.lib.datatypes import TimeFormat DATA_CONVERSIONS = {'json': lambda data: json.loads(data)} -DOCS = "https://intelmq.readthedocs.io/en/latest/guides/Bots.html#generic-csv-parser" +DOCS = "https://docs.intelmq.org/latest/user/bots/#generic-csv" class GenericCsvParserBot(ParserBot): diff --git a/intelmq/lib/bot.py b/intelmq/lib/bot.py index d04b24b7c..f1b0ed333 100644 --- a/intelmq/lib/bot.py +++ b/intelmq/lib/bot.py @@ -224,7 +224,7 @@ def handle_sighup_signal_threading(signum: int, self.logger.error('Multithreading is configured, but is not ' 'available for this bot. Look at the FAQ ' 'for a list of reasons for this. ' - 'https://intelmq.readthedocs.io/en/latest/user/FAQ.html' + 'https://docs.intelmq.org/latest/admin/faq/' '#multithreading-is-not-available-for-this-bot') elif (getattr(self, 'instances_threads', 1) > 1 and disable_multithreading): @@ -1033,7 +1033,7 @@ def process_message(self, *messages: Union[libmessage.Message, dict]): Return value is a dict with the complete pipeline state. Multiple messages can be given as positional argument. The pipeline needs to be configured accordinglit with BotLibSettings, - see https://intelmq.readthedocs.io/en/develop/dev/library.html + see https://docs.intelmq.org/latest/dev/library/ Access the output queue e.g. with return_value['output'] """ diff --git a/setup.py b/setup.py index 7930b1434..7bbe279fc 100644 --- a/setup.py +++ b/setup.py @@ -67,7 +67,7 @@ include_package_data=True, url='https://github.com/certtools/intelmq/', project_urls={ - 'Documentation': 'https://intelmq.readthedocs.io/', + 'Documentation': 'https://docs.intelmq.org/', 'Source and Issue Tracker': 'https://github.com/certtools/intelmq/', }, license='AGPLv3', From 7df8899e9a26c3f9dc9179eece00cb8f7a64c318 Mon Sep 17 00:00:00 2001 From: gethvi Date: Tue, 27 Feb 2024 16:37:13 +0100 Subject: [PATCH 2/2] Changes unreleased version to 3.3.0 and adds NEWS for the new docs. --- CHANGELOG.md | 2 +- NEWS.md | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1351c9122..4bcff7a15 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ -3.2.2 (unreleased) +3.3.0 (unreleased) ------------------ ### Configuration diff --git a/NEWS.md b/NEWS.md index 756f8a3f4..eb77d3d2d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -10,9 +10,12 @@ This file lists all changes which have an affect on the administration of IntelM Please refer to the change log for a full list of changes. -3.2.2 Bugfix release (unreleased) +3.3.0 Feature release (unreleased) --------------------------------- +### Documentation +The documentation is now available at [docs.intelmq.org](https://docs.intelmq.org/). Documentation has been updated and restructured into User, Administrator and Developer Guide. It provides modern look with various quality of life improvements. + ### Requirements ### Tools