Migrate all links from readthedocs to github page

README.md

@@ -1,16 +1,15 @@
 # MongooseIM platform
 
 [![Build Status](https://travis-ci.org/esl/MongooseIM.svg?branch=master)](https://travis-ci.org/esl/MongooseIM)
-[![Documentation Status](https://readthedocs.org/projects/mongooseim/badge/?version=latest)](https://mongooseim.readthedocs.org/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/esl/MongooseIM/branch/master/graph/badge.svg)](https://codecov.io/gh/esl/MongooseIM)
 [![GitHub release](https://img.shields.io/github/release/esl/MongooseIM.svg)](https://github.com/esl/MongooseIM/releases)
 
 
-* [Getting started](https://mongooseim.readthedocs.io/en/latest/user-guide/Getting-started/)
-* [Developer's guide](https://mongooseim.readthedocs.io/en/latest/developers-guide/Testing-MongooseIM/)
+* [Getting started](https://esl.github.io/MongooseDocs/latest/user-guide/Getting-started/)
+* [Developer's guide](https://esl.github.io/MongooseDocs/latest/developers-guide/Testing-MongooseIM/)
 * [Packages](https://www.erlang-solutions.com/resources/download.html)
 * Product page: [https://www.erlang-solutions.com/products/mongooseim.html](https://www.erlang-solutions.com/products/mongooseim.html)
-* Documentation: [https://mongooseim.readthedocs.org/](https://mongooseim.readthedocs.org/)
+* Documentation: [https://esl.github.io/MongooseDocs/](https://esl.github.io/MongooseDocs/)
 
 ## Get to know MongooseIM
 MongooseIM is a robust and efficient chat (or instant messaging) platform aimed at large installations.
@@ -36,7 +35,7 @@ It is brought to you by [Erlang Solutions](https://www.erlang-solutions.com/).
 
 * Home: [http://github.com/esl/MongooseIM](http://github.com/esl/MongooseIM)
 * Product page: [https://www.erlang-solutions.com/products/mongooseim.html](https://www.erlang-solutions.com/products/mongooseim.html)
-* Documentation: [https://mongooseim.readthedocs.org/](https://mongooseim.readthedocs.org/)
+* Documentation: [https://esl.github.io/MongooseDocs/](https://esl.github.io/MongooseDocs/)
 
 ## Download packages
 
@@ -58,33 +57,33 @@ Check out our test results:
 
 ## Documentation
 
-Up-to-date documentation for the MongooseIM master branch can be found on ReadTheDocs: [https://mongooseim.readthedocs.io/en/latest/](https://mongooseim.readthedocs.io/en/latest/).
+Up-to-date documentation for the MongooseIM master branch can be found on ReadTheDocs: [https://esl.github.io/MongooseDocs/latest/](https://esl.github.io/MongooseDocs/latest/).
 
 Latest releases:
-* [4.0.1](https://mongooseim.readthedocs.io/en/4.0.1/)
-* [3.7.1](https://mongooseim.readthedocs.io/en/3.7.1/)
-* [3.6.2](https://mongooseim.readthedocs.io/en/3.6.2/)
-* [3.5.0](https://mongooseim.readthedocs.io/en/3.5.0/)
-* [3.4.0](https://mongooseim.readthedocs.io/en/3.4.0/)
-* [3.3.0](https://mongooseim.readthedocs.io/en/3.3.0/)
-* [3.2.0](https://mongooseim.readthedocs.io/en/3.2.0/)
-* [3.1.0](https://mongooseim.readthedocs.io/en/3.1.0/)
-* [3.0.0](https://mongooseim.readthedocs.io/en/3.0.0/)
+* [4.0.1](https://esl.github.io/MongooseDocs/4.0.1/)
+* [3.7.1](https://esl.github.io/MongooseDocs/3.7.1/)
+* [3.6.2](https://esl.github.io/MongooseDocs/3.6.2/)
+* [3.5.0](https://esl.github.io/MongooseDocs/3.5.0/)
+* [3.4.1](https://esl.github.io/MongooseDocs/3.4.1/)
+* [3.3.0](https://esl.github.io/MongooseDocs/3.3.0/)
+* [3.2.0](https://esl.github.io/MongooseDocs/3.2.0/)
+* [3.1.1](https://esl.github.io/MongooseDocs/3.1.1/)
+* [3.0.1](https://esl.github.io/MongooseDocs/3.0.1/)
 
 
 **MongooseIM documentation highligts:**
 
 When developing new features/modules, please make sure you add basic documentation to the 'doc/' directory, and add a link to your document in 'doc/README.md.'
 
-* [Tutorials](https://mongooseim.readthedocs.io/en/latest/user-guide/How-to-build/). Learn how to:
+* [Tutorials](https://esl.github.io/MongooseDocs/latest/user-guide/How-to-build/). Learn how to:
     * [Build MongooseIM from source code](doc/user-guide/How-to-build.md)
     * [Set up MongoosePush](doc/user-guide/push-notifications/Push-notifications.md)
     * [Set up MongooseICE](doc/user-guide/ICE_tutorial.md)
     * [Build an iOS messaging app](doc/user-guide/iOS_tutorial.md)
-* [User Guide](https://mongooseim.readthedocs.io/en/latest/user-guide/ABCs-of-MongooseIM/). Learn all about how to use MongooseIM in your project. Explore its features, supported XEPs, RFCs and database backends, as well as its architecture and deployment strategies.
-* [Configuration](https://mongooseim.readthedocs.io/en/latest/Basic-configuration/). Explore some of the available options including database backend configuration, access control lists, listener and extension modules.
-* [REST API](https://mongooseim.readthedocs.io/en/latest/rest-api/Client-frontend/). Explore MongooseIM features using our REST API and [Swagger documentation](https://mongooseim.readthedocs.io/en/latest/swagger/index.html).
-* [Operation and maintenance](https://mongooseim.readthedocs.io/en/latest/operation-and-maintenance/Cluster-management-considerations/). See what to consider when building, monitoring, testing and distributing MongooseIM clusters.
+* [User Guide](https://esl.github.io/MongooseDocs/latest/user-guide/ABCs-of-MongooseIM/). Learn all about how to use MongooseIM in your project. Explore its features, supported XEPs, RFCs and database backends, as well as its architecture and deployment strategies.
+* [Configuration](https://esl.github.io/MongooseDocs/latest/Basic-configuration/). Explore some of the available options including database backend configuration, access control lists, listener and extension modules.
+* [REST API](https://esl.github.io/MongooseDocs/latest/rest-api/Client-frontend/). Explore MongooseIM features using our REST API and [Swagger documentation](https://esl.github.io/MongooseDocs/latest/swagger/index.html).
+* [Operation and maintenance](https://esl.github.io/MongooseDocs/latest/operation-and-maintenance/Cluster-management-considerations/). See what to consider when building, monitoring, testing and distributing MongooseIM clusters.
 * [Server developer's guide](doc/developers-guide/Testing-MongooseIM.md). Get all the information you need to expand MongooseIM platform.
 
 

doc/index.md

@@ -1,9 +1,12 @@
 # MongooseIM platform
-[![Build Status](https://travis-ci.org/esl/MongooseIM.svg?branch=master)](https://travis-ci.org/esl/MongooseIM) [![Documentation Status](https://readthedocs.org/projects/mongooseim/badge/?version=latest)](https://mongooseim.readthedocs.org/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/esl/MongooseIM/branch/master/graph/badge.svg)](https://codecov.io/gh/esl/MongooseIM) [![GitHub release](https://img.shields.io/github/release/esl/MongooseIM.svg)](https://github.com/esl/MongooseIM/releases)
 
-* Home: [http://github.com/esl/MongooseIM](http://github.com/esl/MongooseIM)
+[![Build Status](https://travis-ci.org/esl/MongooseIM.svg?branch=master)](https://travis-ci.org/esl/MongooseIM)
+[![codecov](https://codecov.io/gh/esl/MongooseIM/branch/master/graph/badge.svg)](https://codecov.io/gh/esl/MongooseIM)
+[![GitHub release](https://img.shields.io/github/release/esl/MongooseIM.svg)](https://github.com/esl/MongooseIM/releases)
+
+* Home: [https://github.com/esl/MongooseIM](https://github.com/esl/MongooseIM)
 * Product page: [https://www.erlang-solutions.com/products/mongooseim.html](https://www.erlang-solutions.com/products/mongooseim.html)
-* Documentation: [https://mongooseim.readthedocs.org/](https://mongooseim.readthedocs.org/)
+* Documentation: [https://esl.github.io/MongooseDocs/](https://esl.github.io/MongooseDocs/)
 
 
 ## Get to know MongooseIM
@@ -68,22 +71,20 @@ Check out our test results:
 * Load test history:
   ![Load test history](https://tide.erlang-solutions.com/charts/bidaily_last_year.png)
 
-
-
 ## Versions
 
 See the documentation for the latest releases:
 
-* [Master](https://mongooseim.readthedocs.org/en/latest/)
-* [4.0.1](https://mongooseim.readthedocs.io/en/4.0.1/)
-* [3.7.1](https://mongooseim.readthedocs.io/en/3.7.1/)
-* [3.6.2](https://mongooseim.readthedocs.io/en/3.6.2/)
-* [3.5.0](https://mongooseim.readthedocs.io/en/3.5.0/)
-* [3.4.0](https://mongooseim.readthedocs.io/en/3.4.0/)
-* [3.3.0](https://mongooseim.readthedocs.io/en/3.3.0/)
-* [3.2.0](https://mongooseim.readthedocs.io/en/3.2.0/)
-* [3.1.0](https://mongooseim.readthedocs.io/en/3.1.0/)
-* [3.0.0](https://mongooseim.readthedocs.io/en/3.0.0/)
+* [Master](https://esl.github.io/MongooseDocs/latest/)
+* [4.0.1](https://esl.github.io/MongooseDocs/4.0.1/)
+* [3.7.1](https://esl.github.io/MongooseDocs/3.7.1/)
+* [3.6.2](https://esl.github.io/MongooseDocs/3.6.2/)
+* [3.5.0](https://esl.github.io/MongooseDocs/3.5.0/)
+* [3.4.1](https://esl.github.io/MongooseDocs/3.4.1/)
+* [3.3.0](https://esl.github.io/MongooseDocs/3.3.0/)
+* [3.2.0](https://esl.github.io/MongooseDocs/3.2.0/)
+* [3.1.1](https://esl.github.io/MongooseDocs/3.1.1/)
+* [3.0.1](https://esl.github.io/MongooseDocs/3.0.1/)
 
 
 When developing new features/modules, please make sure you add basic documentation to the `doc/` directory, and add a link to your document in `doc/README.md.`

doc/operation-and-maintenance/Reloading-configuration-on-a-running-system.md

@@ -33,6 +33,6 @@ The following options' changes will be ignored when using `mongooseimctl` tool:
 This option is deprecated and not available when using a config file in the TOML
 format.
 
-For the documentation of this option for the `cfg` config format please refer to
-the [MIM 3.7.1 documentation](https://mongooseim.readthedocs.io/en/3.7.1/operation-and-maintenance/Reloading-configuration-on-a-running-system/)
+For the documentation of this option for the `cfg` config format please refer to the
+[MIM 3.7.1 documentation](https://esl.github.io/MongooseDocs/3.7.1/operation-and-maintenance/Reloading-configuration-on-a-running-system/)
 or older.

doc/rest-api/Administration-backend.md

@@ -27,17 +27,17 @@ section of the [listeners](../advanced-configuration/listen.md) documentation.
 
 ## OpenAPI specifications
 
-Read the beautiful [Swagger documentation](http://mongooseim.readthedocs.io/en/latest/swagger/index.html) for more information.
+Read the beautiful [Swagger documentation](https://esl.github.io/MongooseDocs/latest/swagger/index.html) for more information.
 
-[![Swagger](http://nordicapis.com/wp-content/uploads/swagger-Top-Specification-Formats-for-REST-APIs-nordic-apis-sandoval-e1441412425742-300x170.png)](http://mongooseim.readthedocs.io/en/latest/swagger/index.html)
+[![Swagger](https://nordicapis.com/wp-content/uploads/swagger-Top-Specification-Formats-for-REST-APIs-nordic-apis-sandoval-e1441412425742-300x170.png)](https://esl.github.io/MongooseDocs/latest/swagger/index.html)
 
-<iframe src="http://mongooseim.readthedocs.io/en/latest/swagger/index.html"
+<iframe src="https://esl.github.io/MongooseDocs/latest/swagger/index.html"
 height="800" width="800" style="margin-left: -45px;" id="swagger-ui-iframe"></iframe>
 
 <script>
 
 $(document).ready(function() {
-  if (window.location.host.match("readthedocs")){
+  if (window.location.host.match("github")){
     path = window.location.pathname.match("(.*)/rest-api/Administration-backend")[1]
     url = window.location.protocol + "//" + window.location.hostname
     finalURL = url + path + "/swagger/index.html"

doc/rest-api/Client-frontend.md

@@ -13,7 +13,7 @@ Please see the [Authentication](#authentication) section for more details.
 1. The relevant endpoint has to be configured on the server side.
 See the [configuration section](#configuration).
 1. A list of provided actions is documented with Swagger.
-See the beautiful [specification](http://mongooseim.readthedocs.io/en/latest/swagger/index.html?client=true).
+See the beautiful [specification](https://esl.github.io/MongooseDocs/latest/swagger/index.html?client=true).
 
 ## Authentication
 
@@ -80,17 +80,17 @@ then in the final json message these properties will be converted to json map wi
 
 ## OpenAPI specifications
 
-See the beautiful [Swagger documentation](http://mongooseim.readthedocs.io/en/latest/swagger/index.html?client=true) for more information.
+See the beautiful [Swagger documentation](https://esl.github.io/MongooseDocs/latest/swagger/index.html?client=true) for more information.
 
-[![Swagger](http://nordicapis.com/wp-content/uploads/swagger-Top-Specification-Formats-for-REST-APIs-nordic-apis-sandoval-e1441412425742-300x170.png)](http://mongooseim.readthedocs.io/en/latest/swagger/index.html?client=true)
+[![Swagger](https://nordicapis.com/wp-content/uploads/swagger-Top-Specification-Formats-for-REST-APIs-nordic-apis-sandoval-e1441412425742-300x170.png)](https://esl.github.io/MongooseDocs/latest/swagger/index.html?client=true)
 
-<iframe src="http://mongooseim.readthedocs.io/en/latest/swagger/index.html?client=true"
+<iframe src="https://esl.github.io/MongooseDocs/latest/swagger/index.html?client=true"
 height="800" width="800" style="margin-left: -45px;" id="swagger-ui-iframe"></iframe>
 
 <script>
 
 $(document).ready(function() {
-  if (window.location.host.match("readthedocs")){
+  if (window.location.host.match("github")){
     path = window.location.pathname.match("(.*)/REST-API/")[1]
     url = window.location.protocol + "//" + window.location.hostname
     finalURL = url + path + "/swagger/index.html?client=true"

doc/swagger/index.html

@@ -37,41 +37,40 @@
       }
 
       var make_backup_spec_url = function(SpecFile) {
-          return "https://raw.githubusercontent.com/esl/MongooseIM/master/doc/rest-api/" + SpecFile
+        return "https://raw.githubusercontent.com/esl/MongooseIM/master/doc/rest-api/" + SpecFile
       }
 
       var determine_client_mode = function(Search) {
-	var client = Search.match(/client=([^&]+)/)
+        var client = Search.match(/client=([^&]+)/)
         if (client && client.length > 1) {
           return client[1] == "true"
         } else {
           return false
         }
       }
       var backend_or_client_spec = function(CurrentLocation) {
-	var clientMode = determine_client_mode(CurrentLocation.search)
+        var clientMode = determine_client_mode(CurrentLocation.search)
         if (clientMode) {
-	  return "Client-frontend_swagger.yml"
-	} else{
-	  return "Administration-backend_swagger.yml"
-	}
+          return "Client-frontend_swagger.yml"
+        } else{
+          return "Administration-backend_swagger.yml"
+        }
       }
 
       var get_spec_url = function(CurrentLocation){
-	var SpecFile = backend_or_client_spec(CurrentLocation)
-        if (CurrentLocation.host.match("readthedocs")){
-	  return make_spec_url(CurrentLocation, SpecFile)
+        var SpecFile = backend_or_client_spec(CurrentLocation)
+        if (CurrentLocation.host.match("github")){
+          return make_spec_url(CurrentLocation, SpecFile)
         }
         else {
-	  return make_backup_spec_url(SpecFile)
+          return make_backup_spec_url(SpecFile)
         }
       }
 
       var url = get_spec_url(window.location)
 
       console.log(url)
 
-
       hljs.configure({
         highlightSizeThreshold: 5000
       });
@@ -91,7 +90,6 @@
               additionalQueryStringParams: {}
             });
           }
-
         },
         onFailure: function(data) {
           log("Unable to Load SwaggerUI");
@@ -109,7 +107,7 @@
           console.log.apply(console, arguments);
         }
       }
-  });
+    });
   </script>
 </head>
 

rel/files/app.config

@@ -106,7 +106,7 @@
             title => "MongooseIM REST API",
             description =>
               "This is documentation of `MongooseIM REST API`.
-              REST API for client developers [MongooseIM REST API](https://mongooseim.readthedocs.io/en/latest/rest-api/Client-frontend/)",
+              REST API for client developers [MongooseIM REST API](https://esl.github.io/MongooseDocs/latest/rest-api/Client-frontend/)",
             version => "0.1.0"
           }
         }

rel/files/mongooseim.cfg

@@ -417,7 +417,7 @@
 %% This section includes configuration examples; for comprehensive guide
 %% please consult MongooseIM documentation, page "Outgoing connections":
 %% - doc/advanced-configuration/outgoing-connections.md
-%% - https://mongooseim.readthedocs.io/en/latest/advanced-configuration/outgoing-connections/
+%% - https://esl.github.io/MongooseDocs/latest/advanced-configuration/outgoing-connections/
 
 {{{outgoing_pools}}}
 

src/system_metrics/service_mongoose_system_metrics.erl

@@ -168,14 +168,14 @@ msg_removed_from_config() ->
     "    '{service_mongoose_system_metrics, [no_report]}' \n"
     "For more info on how to customise, read, enable, and disable the metrics visit: \n"
     "- MongooseIM docs - \n"
-    "     https://mongooseim.readthedocs.io/en/latest/operation-and-maintenance/System-Metrics-Privacy-Policy/ \n"
+    "     https://esl.github.io/MongooseDocs/latest/operation-and-maintenance/System-Metrics-Privacy-Policy/ \n"
     "- MongooseIM GitHub page - https://github.com/esl/MongooseIM">>.
 
 msg_accept_terms_and_conditions() ->
     <<"We are gathering the MongooseIM system's metrics to analyse the trends and needs of our users, "
     "improve MongooseIM, and know where to focus our efforts. "
     "For more info on how to customise, read, enable, and disable these metrics visit: \n"
     "- MongooseIM docs - \n"
-    "      https://mongooseim.readthedocs.io/en/latest/operation-and-maintenance/System-Metrics-Privacy-Policy/ \n"
+    "      https://esl.github.io/MongooseDocs/latest/operation-and-maintenance/System-Metrics-Privacy-Policy/ \n"
     "- MongooseIM GitHub page - https://github.com/esl/MongooseIM \n"
     "The last sent report is also written to a file ~s">>.

test/config_parser_SUITE.erl

@@ -2280,9 +2280,9 @@ mod_muc_log_opts() ->
      {timezone, <<"local">>, local},
      {timezone, <<"universal">>, universal},
      {spam_prevention, true, true},
-     {top_link, #{<<"target">> => <<"https://mongooseim.readthedocs.io/en/latest/modules/mod_muc_log/">>,
+     {top_link, #{<<"target">> => <<"https://esl.github.io/MongooseDocs/latest/modules/mod_muc_log/">>,
                   <<"text">> => <<"docs">>},
-                {"https://mongooseim.readthedocs.io/en/latest/modules/mod_muc_log/", "docs"}}].
+                {"https://esl.github.io/MongooseDocs/latest/modules/mod_muc_log/", "docs"}}].
 
 mod_muc_log_bad_opts() ->
     %% toml-name toml
@@ -2294,7 +2294,7 @@ mod_muc_log_bad_opts() ->
      {timezone, <<"galactive">>},
      {spam_prevention, 69},
      {top_link, #{<<"target">> => 1, <<"text">> => <<"docs">>}},
-     {top_link, #{<<"target">> => <<"https://mongooseim.readthedocs.io/">>, <<"text">> => <<>>}}
+     {top_link, #{<<"target">> => <<"https://esl.github.io/MongooseDocs/">>, <<"text">> => <<>>}}
     ].
 
 mod_muc_light(_Config) ->