Promote docs.yourls.org (#3291)

6 files changed, 17 insertions, 16 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9bcda616..f73c827b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -35,8 +35,8 @@ For a much more detailed list, simply refer to [commit messages](https://github.
 1.7.9
 ---
 - improved: compatibility of YOURLS with proxies and reversed proxies
-- improved: accept timestamped signature in API requests with [arbitrary hash](https://github.com/YOURLS/YOURLS/wiki/PasswordlessAPI#use-other-hash-algorithms-than-md5)
-- improved: YOURLS pages are now located in `user/` and [documented](https://github.com/YOURLS/YOURLS/wiki/Pages)
+- improved: accept timestamped signature in API requests with [arbitrary hash](https://docs.yourls.org/guide/advanced/passwordless-api.html#use-other-hash-algorithms-than-md5)
+- improved: YOURLS pages are now located in `user/` and [documented](https://docs.yourls.org/guide/extend/pages.html)
 - improved: accessibility, with labels and aria tags in the main admin screen
 - fixed: various little things here and also there
 
@@ -76,7 +76,7 @@ For a much more detailed list, simply refer to [commit messages](https://github.
 1.7.1
 ---
 - added: compatibility with PHP 7
-- added: allow hooks with closures (see [Advanced Hook Syntax](https://github.com/YOURLS/YOURLS/wiki/Advanced-Hook-Syntax))
+- added: allow hooks with closures (see [Advanced Hook Syntax](https://docs.yourls.org/development/hooks.html))
 - improved: you can now search across all fields at once in the admin interface
 - improved: bookmarklets are now human readable in the PHP source, and minified on the fly
 - improved, still not perfect: support for URLs and page titles with encoded chars
diff --git a/README.md b/README.md
index f7546e5e..ad74448b 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Get YOURLS :
 
 Install YOURLS:
 * Read [yourls.org](https://yourls.org) for starters
-* There are important additional information on the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
+* The complete documentation is on [docs.yourls.org](https://docs.yourls.org) and contains everything from beginners to experts.
 
 ## Community news, tips and tricks
 
diff --git a/includes/functions-auth.php b/includes/functions-auth.php
index f7216eb5..52a677a4 100644
--- a/includes/functions-auth.php
+++ b/includes/functions-auth.php
@@ -680,7 +680,7 @@ function yourls_is_user_from_env() {
  *
  * By default, passwords are hashed. They are not if
  *    - there is no password in clear text in the config file (ie everything is already hashed)
- *    - the user defined constant YOURLS_NO_HASH_PASSWORD is true, see https://github.com/YOURLS/YOURLS/wiki/Username-Passwords#but-i-dont-want-to-encrypt-my-password-
+ *    - the user defined constant YOURLS_NO_HASH_PASSWORD is true, see https://docs.yourls.org/guide/essentials/credentials.html#i-don-t-want-to-encrypt-my-password
  *    - YOURLS_USER and YOURLS_PASSWORD are provided by the environment, not the config file
  *
  * @since 1.8.2
diff --git a/includes/functions-plugins.php b/includes/functions-plugins.php
index d7133c97..6e64f94f 100644
--- a/includes/functions-plugins.php
+++ b/includes/functions-plugins.php
@@ -77,7 +77,7 @@ if ( !isset( $yourls_actions ) ) {
  * Typical use:
  *        yourls_add_filter('some_hook', 'function_handler_for_hook');
  *
- * @link  https://github.com/YOURLS/YOURLS/wiki/How-to-make-Plugins
+ * @link  https://docs.yourls.org/development/plugins.html
  * @param string   $hook           the name of the YOURLS element to be filtered or YOURLS action to be triggered
  * @param callback $function_name  the name of the function that is to be called.
  * @param int      $priority       optional. Used to specify the order in which the functions associated with a
@@ -112,7 +112,7 @@ function yourls_add_filter( $hook, $function_name, $priority = 10, $accepted_arg
  * Typical use:
  *        yourls_add_action('some_hook', 'function_handler_for_hook');
  *
- * @link  https://github.com/YOURLS/YOURLS/wiki/How-to-make-Plugins
+ * @link  https://docs.yourls.org/development/plugins.html
  * @param string   $hook           The name of the action to which the $function_to_add is hooked.
  * @param callback $function_name  The name of the function you wish to be called.
  * @param int      $priority       Optional. Used to specify the order in which the functions associated with a particular action
@@ -141,7 +141,7 @@ function yourls_add_action( $hook, $function_name, $priority = 10, $accepted_arg
  *     yourls_add_filter('my_hook_test', $class_instance_with_invoke_method);
  *     yourls_add_filter('my_hook_test', $my_callback_function);
  *
- * @link https://github.com/YOURLS/YOURLS/wiki/Advanced-Hook-Syntax
+ * @link https://docs.yourls.org/development/hooks.html
  * @param  string       $hook            Hook to which the function is attached
  * @param  string|array $function        Used for creating unique id
  * @param  int|bool     $priority        Used in counting how many hooks were applied.  If === false and $function is an object reference,
@@ -299,9 +299,9 @@ function yourls_did_action( $hook ) {
  * Internal function used by yourls_do_action() and yourls_apply_filter() - not meant to be used from
  * outside these functions.
  * This is mostly a debugging function to understand the flow of events.
- * See https://github.com/YOURLS/YOURLS/wiki/Debugging-YOURLS to learn how to use the 'all' hook
+ * See https://docs.yourls.org/development/debugging.html to learn how to use the 'all' hook
  *
- * @link   https://github.com/YOURLS/YOURLS/wiki/Debugging-YOURLS
+ * @link   https://docs.yourls.org/development/debugging.html
  * @since  1.8.1
  * @param  string $type Either 'action' or 'filter'
  * @param  string $hook The hook name, eg 'plugins_loaded'
diff --git a/includes/functions-shorturls.php b/includes/functions-shorturls.php
index cbff13ed..4554fd21 100644
--- a/includes/functions-shorturls.php
+++ b/includes/functions-shorturls.php
@@ -409,7 +409,7 @@ function yourls_keyword_is_free( $keyword  ) {
 /**
  * Check if a keyword matches a "page"
  *
- * @see https://github.com/YOURLS/YOURLS/wiki/Pages
+ * @see https://docs.yourls.org/guide/extend/pages.html
  * @since 1.7.10
  * @param  string $keyword  Short URL $keyword
  * @return bool             true if is page, false otherwise
diff --git a/readme.html b/readme.html
index dcce7302..a27f70bf 100644
--- a/readme.html
+++ b/readme.html
@@ -288,7 +288,7 @@
 				<li>Point your browser to <code>http://your-own-domain-here.com/admin/</code></li>
 			</ol>
 			<a class="anch" href="#Install;auto"><span>&#10148;</span><h3 id="auto" class='first'>Install Guides</h3></a>
-            <p>The <a href="https://yourls.org/wiki">wiki</a> is full of important information. Regarding installation, you'll find help for Apache, IIS and Nginx.</p>
+            <p>The documentation on <a href="https://docs.yourls.org/">docs.yourls.org</a> is full of important information. Regarding installation, you'll find help for Apache and Nginx.</p>
             <p>You will also find numerous unofficial installation guides on <a href="https://yourls.org/awesome">Awesome YOURLS</a>, a curated list of resources.</p>
 
 			<a class="anch" href="#Install;upgrade"><span>&#10148;</span><h2 id="upgrade">Upgrade</h2></a>
@@ -371,7 +371,7 @@
             <ul>
                 <li>You can install YOURLS behind a firewall or a proxy: see <a href="https://yourls.org/proxy">Proxy Support</a></li>
                 <li>File <code>includes/Config/Config.php</code> contains a few more undocumented but self explanatory and commented settings. Add them to your own <code>config.php</code> if you know what you're doing.</li>
-                <li>There are numerous tips and guides on the <a href="https://yourls.org/wiki">Wiki</a>, be sure to read them.</li>
+                <li>There are numerous tips and guides on the <a href="https://docs.yourls.org/">Documentation</a>, be sure to read them.</li>
             </ul>
 		</div>
 
@@ -534,7 +534,8 @@ echo $data->longurl;</tt></pre>
 				<li>We recommend <strong>PHP 7.4</strong> or above</li>
 				<li>You will need at least <strong>MYSQL 5</strong></li>
 				<li>A web server with <strong>mod_rewrite</strong> enabled<br/>
-				<em>Note</em>: YOURLS can also run on <a href="https://github.com/YOURLS/YOURLS/wiki/Nginx-configuration">Nginx</a>, <a href="https://github.com/YOURLS/YOURLS/wiki/Web-Config-IIS">IIS</a> and <a href="https://github.com/lylebrown/YOURLS-Cherokee">Cherokee</a></li>
+				<em>Note</em>: YOURLS can also run on <a href="https://docs.yourls.org/guide/server-configuration.html#nginx">Nginx</a>,
+                    <a href="https://github.com/lylebrown/YOURLS-Cherokee">Cherokee</a> and <a href="https://github.com/YOURLS/awesome-yourls#installation-guides">more</a> !</li>
                 <li><strong>HTTPS</strong> support</li>
 				<li>PHP <a href="http://www.php.net/curl">CURL extension</a> installed if you plan on playing with the API</li>
 			</ol>
@@ -603,7 +604,7 @@ echo $data->longurl;</tt></pre>
 			<a class="anch" href="#FAQ;feedback"><span>&#10148;</span><h3 id="feedback">Feedback, feature requests and bug reporting</h3></a>
 			<ol>
 				<li>Please don't get in touch directly by mail or Twitter. <a href="https://yourls.org/support">Please</a>.</li>
-				<li>Read all the <a href="https://yourls.org/wiki">wiki documents</a>.</li>
+				<li>Read all the <a href="https://docs.yourls.org/">documentation</a>.</li>
 				<li>Search in all the <a href="https://yourls.org/issues">issues</a>, open and closed.</li>
 				<li>Eventually raise a new issue. To do so, please read the <a href="https://yourls.org/contribute">contribute guidelines</a>. Thanks!</li>
 			</ol>
@@ -621,7 +622,7 @@ echo $data->longurl;</tt></pre>
 			<a class="anch" href="#More;ressources"><span>&#10148;</span><h3 id="ressources">Resources</h3></a>
 			<ul>
 				<li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
-				<li>The <a href="https://yourls.org/wiki">wiki</a>: basic and advanced documentation, plugins, tips and more</li>
+				<li>The <a href="https://docs.yourls.org/">documentations</a>: basic and advanced documentation, plugins, tips and more</li>
                 <li><a href="https://yourls.org/awesome">Awesome YOURLS</a> is a curated list of YOURLS resources, plugins, translations, guides and third-party tools.</li>
 			</ul>