From e743b2d90a23ac3c5c9a7977a8e30973ef416788 Mon Sep 17 00:00:00 2001 From: Peter Powell Date: Fri, 26 Apr 2019 23:20:40 +0100 Subject: [PATCH] Update documentation links. --- README.md | 4 +- configure | 2 +- docs/conf/links.conf.example | 2 +- docs/conf/modules.conf.example | 48 +++++++++++------------ docs/conf/modules/charybdis.conf.example | 10 ++--- docs/conf/modules/unrealircd.conf.example | 14 +++---- docs/conf/motd.txt.example | 2 +- docs/conf/opermotd.txt.example | 2 +- make/template/main.mk | 4 +- src/modules/extra/README | 4 +- src/modules/m_spanningtree/main.h | 2 +- 11 files changed, 47 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 2e46cea37..e6b2d7fa0 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ If you encounter any bugs then [please file an issue](https://github.com/inspirc ## Installation -Most InspIRCd users running a UNIX-like system build from source. A guide about how to do this is available on [the InspIRCd wiki](https://wiki.inspircd.org/Installation_From_Source). +Most InspIRCd users running a UNIX-like system build from source. A guide about how to do this is available on [the InspIRCd docs site](http://docs.inspircd.org/2/installation/source). Building from source on Windows is generally not recommended but [a guide is available](https://github.com/inspircd/inspircd/blob/insp20/win/README.txt) if you wish to do this. @@ -37,7 +37,7 @@ InspIRCd is licensed under [version 2 of the GNU General Public License](https:/ ## External Links * [Website](https://www.inspircd.org) -* [Documentation](https://wiki.inspircd.org) +* [Documentation](https://docs.inspircd.org) * [GitHub](https://github.com/inspircd) * [Support IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd) — \#inspircd on irc.inspircd.org * [Development IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd.dev) — \#inspircd.dev on irc.inspircd.org diff --git a/configure b/configure index f3aea791f..638d48da0 100755 --- a/configure +++ b/configure @@ -716,7 +716,7 @@ if (($config{USE_GNUTLS} eq "y") || ($config{USE_OPENSSL} eq "y")) { print "Please note: for \e[1;32mSSL support\e[0m you will need to load required\n"; print "modules in your config. This configure script has added those modules to the\n"; print "build process. For more info, please refer to:\n"; - print "\e[1;32mhttps://wiki.inspircd.org/Installation_From_Tarball\e[0m\n"; + print "\e[1;32mhttp://docs.inspircd.org/2/installation/source\e[0m\n"; } print "*** \e[1;32mRemember to edit your configuration files!!!\e[0m ***\n\n\n"; if (($config{OSNAME} eq "OpenBSD") && ($config{CC} ne "eg++")) { diff --git a/docs/conf/links.conf.example b/docs/conf/links.conf.example index ba18c5325..8d62bb42f 100644 --- a/docs/conf/links.conf.example +++ b/docs/conf/links.conf.example @@ -46,7 +46,7 @@ ssl="gnutls" # fingerprint: If defined, this option will force servers to be - # authenticated using SSL Fingerprints. See https://wiki.inspircd.org/SSL + # authenticated using SSL Fingerprints. See http://docs.inspircd.org/2/modules/spanningtree # for more information. This will require an SSL link for both inbound # and outbound connections. #fingerprint="" diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index a538ea879..65d34e70f 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -10,7 +10,7 @@ # # # By default, ALL modules are commented out. You must uncomment them # # or add lines to your config to load modules. Please refer to # -# https://wiki.inspircd.org/2.0/Modules for a list of modules and # +# https://docs.inspircd.org/2/modules for a list of modules and # # each modules link for any additional conf tags they require. # # # # ____ _ _____ _ _ ____ _ _ _ # @@ -313,7 +313,7 @@ # # # Optional - If you specify to use the m_censor module, then you must # # specify some censor tags. See also: # -# https://wiki.inspircd.org/Modules/2.0/censor # +# https://docs.inspircd.org/2/modules/censor # # # @@ -327,7 +327,7 @@ # Optional - If you specify to use m_cgiirc, then you must specify one # or more cgihost tags which indicate authorised CGI:IRC servers which # will be connecting to your network, and an optional cgiirc tag. -# For more information see: https://wiki.inspircd.org/Modules/2.0/cgiirc +# For more information see: https://docs.inspircd.org/2/modules/cgiirc # # Set to yes if you want to notice opers when CGI:IRC clients connect. # @@ -745,8 +745,8 @@ # more blacklists. # # # # # -# For configuration options please see the wiki page for m_dnsbl at # -# https://wiki.inspircd.org/Modules/2.0/dnsbl # +# For configuration options please see the docs page for m_dnsbl at # +# https://docs.inspircd.org/2/modules/dnsbl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Exempt channel operators module: Provides support for allowing # @@ -804,7 +804,7 @@ # and run make install, then uncomment this module to enable it. # This module requires GeoIP to be installed on your system, # use your package manager to find the appropriate packages -# or check the InspIRCd wiki page for this module. +# or check the InspIRCd docs page for this module. # # # The actual allow/ban actions are done by connect classes, not by the @@ -873,7 +873,7 @@ # #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # -# See https://wiki.inspircd.org/Modules/2.0/hostchange for help. # +# See https://docs.inspircd.org/2/modules/hostchange for help. # # # # # @@ -1144,8 +1144,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# m_mssql.so is more complex than described here, see wiki for more # -# info https://wiki.inspircd.org/Modules/2.0/mssql # +# m_mssql.so is more complex than described here, see docs for more # +# info https://docs.inspircd.org/2/modules/mssql # # # @@ -1159,8 +1159,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# m_mysql.so is more complex than described here, see the wiki for # -# more: https://wiki.inspircd.org/Modules/2.0/mysql # +# m_mysql.so is more complex than described here, see the docs for # +# more: https://docs.inspircd.org/2/modules/mysql # # # @@ -1324,8 +1324,8 @@ # #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # -# m_override.so is too complex it describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/override # +# m_override.so is too complex it describe here, see the docs: # +# https://docs.inspircd.org/2/modules/override # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Oper levels module: Gives each oper a level and prevents actions @@ -1417,8 +1417,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# m_pgsql.so is more complex than described here, see the wiki for # -# more: https://wiki.inspircd.org/Modules/2.0/pgsql # +# m_pgsql.so is more complex than described here, see the docs for # +# more: https://docs.inspircd.org/2/modules/pgsql # # # @@ -1735,8 +1735,8 @@ # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_gnutls.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_gnutls # +# m_ssl_gnutls.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_gnutls # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL info module: Allows users to retrieve information about other @@ -1762,8 +1762,8 @@ # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_openssl.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_openssl # +# m_ssl_openssl.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_openssl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Strip color module: Adds channel mode +S that strips mIRC color @@ -1789,8 +1789,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# m_sqlite.so is more complex than described here, see the wiki for # -# more: https://wiki.inspircd.org/Modules/2.0/sqlite3 # +# m_sqlite.so is more complex than described here, see the docs for # +# more: https://docs.inspircd.org/2/modules/sqlite3 # # # @@ -1802,8 +1802,8 @@ # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_sqlauth.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/sqlauth # +# m_sqlauth.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/sqlauth # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL table @@ -1815,7 +1815,7 @@ # dbid - Database ID to use (see SQL modules). # # hash - Hashing provider to use for password hashing. # # # -# See also: https://wiki.inspircd.org/Modules/2.0/sqloper # +# See also: https://docs.inspircd.org/2/modules/sqloper # # # # diff --git a/docs/conf/modules/charybdis.conf.example b/docs/conf/modules/charybdis.conf.example index 91260c7d3..39238ec5f 100644 --- a/docs/conf/modules/charybdis.conf.example +++ b/docs/conf/modules/charybdis.conf.example @@ -37,7 +37,7 @@ # Optional - If you specify to use m_cgiirc, then you must specify one # or more cgihost tags which indicate authorised CGI:IRC servers which # will be connecting to your network, and an optional cgiirc tag. -# For more information see: https://wiki.inspircd.org/Modules/2.0/cgiirc +# For more information see: https://docs.inspircd.org/2/modules/cgiirc # # Set to yes if you want to notice opers when CGI clients connect # @@ -261,8 +261,8 @@ # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_gnutls.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_gnutls # +# m_ssl_gnutls.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_gnutls # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SSL Info module: Allows users to retrieve information about other @@ -288,8 +288,8 @@ # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_openssl.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_openssl # +# m_ssl_openssl.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_openssl # diff --git a/docs/conf/modules/unrealircd.conf.example b/docs/conf/modules/unrealircd.conf.example index 65d713394..1d2ea39cc 100644 --- a/docs/conf/modules/unrealircd.conf.example +++ b/docs/conf/modules/unrealircd.conf.example @@ -59,7 +59,7 @@ # Optional - If you specify to use m_cgiirc, then you must specify one # or more cgihost tags which indicate authorised CGI:IRC servers which # will be connecting to your network, and an optional cgiirc tag. -# For more information see: https://wiki.inspircd.org/Modules/2.0/cgiirc +# For more information see: https://docs.inspircd.org/2/modules/cgiirc # # Set to yes if you want to notice opers when CGI clients connect # @@ -282,8 +282,8 @@ #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # -# m_override.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/override # +# m_override.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/override # @@ -370,8 +370,8 @@ # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_gnutls.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_gnutls # +# m_ssl_gnutls.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_gnutls # @@ -384,8 +384,8 @@ # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_openssl.so is too complex to describe here, see the wiki: # -# https://wiki.inspircd.org/Modules/2.0/ssl_openssl # +# m_ssl_openssl.so is too complex to describe here, see the docs: # +# https://docs.inspircd.org/2/modules/ssl_openssl # diff --git a/docs/conf/motd.txt.example b/docs/conf/motd.txt.example index 891aaa51c..c5266f844 100644 --- a/docs/conf/motd.txt.example +++ b/docs/conf/motd.txt.example @@ -28,7 +28,7 @@ / \ / * Web: https://www.inspircd.org \ | * IRC: irc.inspircd.org #inspircd | - | * Docs: https://wiki.inspircd.org | + | * Docs: https://docs.inspircd.org | | * Bugs: https://inspircd.org/bugs | | | | We hope you like this software. Please do | diff --git a/docs/conf/opermotd.txt.example b/docs/conf/opermotd.txt.example index 4bf7c85e4..7e1c82f33 100644 --- a/docs/conf/opermotd.txt.example +++ b/docs/conf/opermotd.txt.example @@ -28,7 +28,7 @@ / \ / * Web: https://www.inspircd.org \ | * IRC: irc.inspircd.org #inspircd | - | * Docs: https://wiki.inspircd.org | + | * Docs: https://docs.inspircd.org | | * Bugs: https://inspircd.org/bugs | | | | We hope you like this software. Please do | diff --git a/make/template/main.mk b/make/template/main.mk index 23daa7efc..6979e1c74 100644 --- a/make/template/main.mk +++ b/make/template/main.mk @@ -200,8 +200,8 @@ std-header: @echo "* BUILDING INSPIRCD *" @echo "* *" @echo "* This will take a *long* time. *" - @echo "* Why not read our wiki at *" - @echo "* http://wiki.inspircd.org *" + @echo "* Why not read our docs at *" + @echo "* http://docs.inspircd.org *" @echo "* while you wait for make to run? *" @echo "*************************************" diff --git a/src/modules/extra/README b/src/modules/extra/README index b59494df9..f4a9316a1 100644 --- a/src/modules/extra/README +++ b/src/modules/extra/README @@ -1,8 +1,8 @@ This directory stores modules which require external libraries to compile. -For example, m_filter_pcre requires the PCRE libraries. +For example, m_regex_pcre requires the PCRE libraries. To compile any of these modules first ensure you have the required dependencies -(read the online documentation at https://wiki.inspircd.org/) and then symlink +(read the online documentation at https://docs.inspircd.org/) and then symlink the .cpp file from this directory into the parent directory (src/modules/). Alternatively, use the command: ./configure --enable-extras=m_extra.cpp, which will diff --git a/src/modules/m_spanningtree/main.h b/src/modules/m_spanningtree/main.h index 3e0a83111..80758763a 100644 --- a/src/modules/m_spanningtree/main.h +++ b/src/modules/m_spanningtree/main.h @@ -31,7 +31,7 @@ * If you completely change the protocol, completely change the number. * * IMPORTANT: If you make changes, document your changes here, without fail: - * https://wiki.inspircd.org/List_of_protocol_changes_between_versions + * https://docs.inspircd.org/developer/spanningtree/ * * Failure to document your protocol changes will result in a painfully * painful death by pain. You have been warned. -- 2.39.2