From 34eb62a7c26543e5b5b0d7f7201097a7d6517d33 Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Fri, 6 Sep 2024 11:25:52 +0100 Subject: [PATCH] Consistently mark v3 deprecated modules as such. --- docs/3/modules/blockcaps.yml | 2 +- docs/3/modules/censor.yml | 2 +- docs/3/modules/clones.yml | 2 +- docs/3/modules/hostchange.yml | 4 ++++ docs/3/modules/lockserv.yml | 2 +- docs/3/modules/modenotice.yml | 2 +- docs/3/modules/nationalchars.yml | 4 +++- docs/3/modules/regex_pcre.yml | 6 +++++- docs/3/modules/regex_tre.yml | 2 +- docs/3/modules/ssl_mbedtls.yml | 6 +++++- docs/3/modules/userip.yml | 4 ++++ docs/4/breaking-changes.md | 4 ++-- 12 files changed, 29 insertions(+), 11 deletions(-) diff --git a/docs/3/modules/blockcaps.yml b/docs/3/modules/blockcaps.yml index 291cbd83e..865c8c204 100644 --- a/docs/3/modules/blockcaps.yml +++ b/docs/3/modules/blockcaps.yml @@ -4,7 +4,7 @@ introduction: |- !!! warning "" This module is deprecated and has been removed in the next major version of InspIRCd. - You should use [the anticaps module](/3/modules/anticaps) instead. + You should consider using [the anticaps module](/3/modules/anticaps) instead. description: |- This module adds channel mode `B` (blockcaps) which allows channels to block messages which are excessively capitalised. diff --git a/docs/3/modules/censor.yml b/docs/3/modules/censor.yml index d61031a43..4036fdf16 100644 --- a/docs/3/modules/censor.yml +++ b/docs/3/modules/censor.yml @@ -2,7 +2,7 @@ name: censor introduction: |- !!! warning "" - This module has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. You should consider using [the filter module](/3/modules/filter) instead. diff --git a/docs/3/modules/clones.yml b/docs/3/modules/clones.yml index 9cf8d9c5e..8d1a5a209 100644 --- a/docs/3/modules/clones.yml +++ b/docs/3/modules/clones.yml @@ -2,7 +2,7 @@ name: clones introduction: |- !!! warning "" - This module has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. description: |- This module adds the `/CLONES` command which allows server operators to view IP addresses from which there are more than a specified number of connections. diff --git a/docs/3/modules/hostchange.yml b/docs/3/modules/hostchange.yml index 15dca21b3..90aaa6e4c 100644 --- a/docs/3/modules/hostchange.yml +++ b/docs/3/modules/hostchange.yml @@ -1,5 +1,9 @@ name: hostchange +introduction: |- + !!! warning "" + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + description: |- This module allows the server administrator to define custom rules for applying hostnames to users. diff --git a/docs/3/modules/lockserv.yml b/docs/3/modules/lockserv.yml index 794a5bd90..135717018 100644 --- a/docs/3/modules/lockserv.yml +++ b/docs/3/modules/lockserv.yml @@ -2,7 +2,7 @@ name: lockserv introduction: |- !!! warning "" - This module has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. description: |- This module adds the `/LOCKSERV` and `/UNLOCKSERV` commands which allows server operators to control whether users can connect to the local server. diff --git a/docs/3/modules/modenotice.yml b/docs/3/modules/modenotice.yml index 1c0b722d1..8ca69f43d 100644 --- a/docs/3/modules/modenotice.yml +++ b/docs/3/modules/modenotice.yml @@ -2,7 +2,7 @@ name: modenotice introduction: |- !!! warning "" - This module has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. description: |- This module adds the `/MODENOTICE` command which sends a message to all users with the specified user modes set. If multiple user modes are specified, the notice is only sent to users who have all of them set. diff --git a/docs/3/modules/nationalchars.yml b/docs/3/modules/nationalchars.yml index c2f9406b8..24e7b0513 100644 --- a/docs/3/modules/nationalchars.yml +++ b/docs/3/modules/nationalchars.yml @@ -2,7 +2,9 @@ name: nationalchars introduction: |- !!! warning "" - If you want to use a custom 8-bit character set then you're probably better off using [the codepage module](/3/modules/codepage) instead. + This module is deprecated and has been removed in the next major version of InspIRCd. + + You should consider using [the codepage module](/3/modules/codepage) instead. description: |- This module allows the server administrator to define what characters are allowed in nicknames and channel names and how those characters should be compared in a case insensitive way. diff --git a/docs/3/modules/regex_pcre.yml b/docs/3/modules/regex_pcre.yml index 06365ac66..d8b993e13 100644 --- a/docs/3/modules/regex_pcre.yml +++ b/docs/3/modules/regex_pcre.yml @@ -1,6 +1,10 @@ name: regex_pcre -introduction: "" +introduction: |- + !!! warning "" + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + + You should consider using [the regex_pre2 module](/3/modules/regex_pcre2) instead. depends_on: what: a third-party library ([PCRE](https://www.pcre.org)) diff --git a/docs/3/modules/regex_tre.yml b/docs/3/modules/regex_tre.yml index c838def7e..4dd63a716 100644 --- a/docs/3/modules/regex_tre.yml +++ b/docs/3/modules/regex_tre.yml @@ -2,7 +2,7 @@ name: regex_tre introduction: |- !!! warning "" - This module has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. You should consider using [the regex_stdlib module](/3/modules/regex_stdlib) instead. diff --git a/docs/3/modules/ssl_mbedtls.yml b/docs/3/modules/ssl_mbedtls.yml index 5714050f0..41c6f76c1 100644 --- a/docs/3/modules/ssl_mbedtls.yml +++ b/docs/3/modules/ssl_mbedtls.yml @@ -1,6 +1,10 @@ name: ssl_mbedtls -introduction: "" +introduction: |- + !!! warning "" + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + + You should consider using [the ssl_gnutls module](/3/modules/ssl_gnutls) instead. depends_on: what: a third-party library ([mbedTLS](https://tls.mbed.org)) diff --git a/docs/3/modules/userip.yml b/docs/3/modules/userip.yml index f256a75aa..baf5b42f4 100644 --- a/docs/3/modules/userip.yml +++ b/docs/3/modules/userip.yml @@ -1,5 +1,9 @@ name: userip +introduction: |- + !!! warning "" + This module is deprecated and has been moved to [inspircd-contrib](/3/module-manager) in the next major version of InspIRCd. + description: |- This module adds the `/USERIP` command which allows users to find out the IP address of one or more connected users. diff --git a/docs/4/breaking-changes.md b/docs/4/breaking-changes.md index 6726e29ba..d4d9eb5b3 100644 --- a/docs/4/breaking-changes.md +++ b/docs/4/breaking-changes.md @@ -38,10 +38,10 @@ title: v4 Breaking Changes - The modenotice module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration or run `./modulemanager install modenotice` to install it. -- The nopartmsg module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration, run `./modulemanager install nopartmsg` to install it, or migrate to [the muteban module](/4/modules/muteban) which now also applies to part messages. - - The nationalchars module has been removed. In order to upgrade you should switch to the codepage module instead. +- The nopartmsg module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration, run `./modulemanager install nopartmsg` to install it, or migrate to [the muteban module](/4/modules/muteban) which now also applies to part messages. + - The regex_pcre module has been moved to inspircd-contrib. In order to upgrade either migrate remove this module from your configuration, run `./modulemanager install regex_pcre` to install it, or migrate to [the regex_pcre2 module](/4/modules/regex_pcre2). - The regex_tre module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration or run `./modulemanager install regex_tre` to install it.