Skip to content

Commit 9c1cdf8

Browse files
authored
Merge pull request #4376 from esl/fix-mkdocs-links
Fix relative links in docs
2 parents 34a28cf + 4d95cc1 commit 9c1cdf8

13 files changed

+24
-24
lines changed

Diff for: doc/configuration/configuration-files.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The section names above are links to the detailed documentation of each section.
3030
!!! Warning
3131
It is recommended to use the same configuration file for all nodes in the cluster, but there is no protection against using different option values for each node, because it can happen in two cases:
3232

33-
* During a [rolling upgrade](../../operation-and-maintenance/Rolling-upgrade) procedure, when nodes are restarted one by one with new configuration.
33+
* During a [rolling upgrade](../operation-and-maintenance/Rolling-upgrade.md) procedure, when nodes are restarted one by one with new configuration.
3434
* When you need different network-specific parameters (e.g. listening IP addresses) for each node.
3535

3636
## vm.args

Diff for: doc/configuration/general.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ In order to configure these hosts independently, use the [`host_config` section]
4444

4545
This is the list of names for the types of hosts that will serve dynamic XMPP domains.
4646
Each host type can be seen as a label for a group of independent domains that use the same server configuration.
47-
In order to configure these host types independently, use the [`host_config` section](./host_config.md). The domains can be added or removed dynamically with the [command line interface](../../developers-guide/domain_management#command-line-interface) or using the [API](../../developers-guide/domain_management#api).
47+
In order to configure these host types independently, use the [`host_config` section](./host_config.md). The domains can be added or removed dynamically with the [command line interface](../developers-guide/domain_management.md#command-line-interface) or using the [API](../developers-guide/domain_management.md#api).
4848

4949
If you use the host type mechanism, make sure you only configure modules which support dynamic domains in the [`modules`](./Modules.md) or [`host_config.modules`](./host_config.md#host_configmodules) sections.
5050
MongooseIM will **not** start otherwise.
@@ -170,7 +170,7 @@ If a stanza is addressed to a subdomain of the served domain and this option is
170170
* **Default:** `["mongoose_router_global", "mongoose_router_localdomain", "mongoose_router_external_localnode", "mongoose_router_external", "mongoose_router_dynamic_domains", "ejabberd_s2s"]`
171171
* **Example:** `routing_modules = ["mongoose_router_global", "mongoose_router_localdomain"]`
172172

173-
Provides an ordered list of modules used for routing messages. All available modules are enabled by default, and you can change their order or disable some of them by providing your own list. See the [Message routing](../../developers-guide/Stanza-routing/#3-message-routing) section of the developer's guide for more information.
173+
Provides an ordered list of modules used for routing messages. All available modules are enabled by default, and you can change their order or disable some of them by providing your own list. See the [Message routing](../developers-guide/Stanza-routing.md#3-message-routing) section of the developer's guide for more information.
174174

175175
## Miscellaneous
176176

Diff for: doc/developers-guide/Stanza-routing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Next, depending on the type of the stanza, one of the following hooks is called:
1919
* `user_send_iq` for IQ (info/query) stanzas,
2020
* `user_send_xmlel` for other XML elements.
2121

22-
Each hook can be handled by multiple modules subscribed to it. Those modules do various complementary tasks, like storing the message in an archive, sending carbon copies, checking the stanza against privacy lists etc. It is possible for a handler to immediately stop routing at this point, preventing execution of any subsequent handlers or hooks. See [hooks description](../hooks_description/#hooks-called-for-session_established) for more information.
22+
Each hook can be handled by multiple modules subscribed to it. Those modules do various complementary tasks, like storing the message in an archive, sending carbon copies, checking the stanza against privacy lists etc. It is possible for a handler to immediately stop routing at this point, preventing execution of any subsequent handlers or hooks. See [hooks description](hooks_description.md#hooks-called-for-session_established) for more information.
2323

2424
## 3. Message routing
2525

@@ -28,7 +28,7 @@ The stanza is routed by `ejabberd_router:route/3`, which passes it through a cha
2828
1. `Mod:filter/3`, which either drops the stanza, stopping the routing chain, or returns it for further processing, modifying it if necessary.
2929
2. `Mod:route/3`, which either handles the stanza, stopping the routing chain, or returns it for further processing, modifying it if necessary.
3030

31-
A list of routing modules can be set in the [`routing_modules`](../../configuration/general#generalrouting_modules) option.
31+
A list of routing modules can be set in the [`routing_modules`](../configuration/general.md#generalrouting_modules) option.
3232
The default behaviour is the following:
3333

3434
* `mongoose_router_global`: runs a global `filter_packet` hook.

Diff for: doc/developers-guide/domain_management.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ Run `./mongooseimctl domain` to get more information about all supported operati
146146

147147
You can manage domains with one of our API's:
148148

149-
* The [GraphQL API](../../graphql-api/Admin-GraphQL) has the same funtionality as the command line interface. The <a href="../../graphql-api/admin-graphql-doc.html#query-domain">queries</a> and <a href="../../graphql-api/admin-graphql-doc.html#mutation-domain">mutations</a> for domains are grouped under the `domain` category.
150-
* The [REST API](../../rest-api/Administration-backend) (deprecated) supports domain management as well. See <a href="../../swagger/index.html#/Dynamic_domains">Dynamic Domains</a> for details.
149+
* The [GraphQL API](../graphql-api/Admin-GraphQL.md) has the same funtionality as the command line interface. The <a href="../../graphql-api/admin-graphql-doc.html#query-domain">queries</a> and <a href="../../graphql-api/admin-graphql-doc.html#mutation-domain">mutations</a> for domains are grouped under the `domain` category.
150+
* The [REST API](../rest-api/Administration-backend.md) (deprecated) supports domain management as well. See <a href="../../swagger/index.html#/Dynamic_domains">Dynamic Domains</a> for details.

Diff for: doc/developers-guide/hooks_description.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ mongoose_hooks:filter_packet({From, To, Acc, Packet})
6565
mongoose_hooks:filter_local_packet({From, To, Acc, Packet})
6666
```
6767

68-
These hooks are run when the packet is being [routed](../Stanza-routing/#3-message-routing) by `ejaberd_router:route/4`, which is the most general function used to route stanzas across the entire cluster. For example, `mongoose_c2s` calls it after calling the `user_send_message` or `user_send_iq` hook, and multiple modules use it for sending replies and errors.
68+
These hooks are run when the packet is being [routed](Stanza-routing.md#3-message-routing) by `ejaberd_router:route/4`, which is the most general function used to route stanzas across the entire cluster. For example, `mongoose_c2s` calls it after calling the `user_send_message` or `user_send_iq` hook, and multiple modules use it for sending replies and errors.
6969

7070
* `filter_packet` is run by `mongoose_router_global` for all routed packets. It is called at the start of the routing procedure.
7171
* `filter_local_packet` is run by `mongoose_local_delivery` when the packet is being routed to a domain hosted by the local server.

Diff for: doc/developers-guide/xep_tool.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ make xeplist
9090

9191
## Examples of generated content
9292

93-
* [Markdown table](../../user-guide/Supported-XEPs/)
93+
* [Markdown table](../user-guide/Supported-XEPs.md)
9494
* [DOAP file](https://raw.githubusercontent.com/esl/MongooseDocs/gh-pages/latest/mongooseim.doap)

Diff for: doc/getting-started/Quick-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ You know `mongooseimctl`, with basic server management commands such as:
413413
* `start`, `restart`, `stop`, `status`, `live`, `foreground`
414414
* `get_loglevel`
415415
416-
Other commands shown above correspond to the [GraphQL Admin API](../../graphql-api/Admin-GraphQL/) operations, and they are grouped into the following categories:
416+
Other commands shown above correspond to the [GraphQL Admin API](../graphql-api/Admin-GraphQL.md) operations, and they are grouped into the following categories:
417417
418418
* `account` contains `registerUser`, `checkUser`, `listUsers`, `removeUser`
419419
* `roster` contains `addContact`, `subscription`, `listContacts`, `setMutualSubscription`

Diff for: doc/migrations/4.0.1_4.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Since release 4.1.0, we are no longer supporting the `*.cfg` MongooseIM configur
2222

2323
* [`mod_http_upload.max_file_size`](../modules/mod_http_upload.md#modulesmod_http_uploadmax_file_size): `undefined` is no longer allowed
2424

25-
* [`mod_mam_meta.user_prefs_store`](../modules/mod_mam.md#modulesmod_mam_metauser_prefs_store): `false` is no longer allowed
25+
* [`mod_mam_meta.user_prefs_store`](../modules/mod_mam.md#modulesmod_mamuser_prefs_store): `false` is no longer allowed (note: the module is called `mod_mam` in the most recent versions)
2626

2727
* [`mod_muc_light.config_schema`](../modules/mod_muc_light.md#modulesmod_muc_lightconfig_schema): the usage of `value` and `type` fields was replaced with one of the following fields: `string_value`, `integer_value` or `float_value`
2828

Diff for: doc/migrations/4.1.0_4.2.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ALTER TABLE inbox
2323

2424
### Archived groupchat messages in `mod_mam`
2525

26-
The [`archive_groupchats`](../modules/mod_mam.md#modulesmod_mam_metapmarchive_groupchats) option is now set to `false` by default, as documented.
26+
The [`archive_groupchats`](../modules/mod_mam.md#modulesmod_mampmarchive_groupchats) option is now set to `false` by default, as documented.
2727
Before the change, the private message (PM) archive stored incoming groupchat messages as well, contrary to the documentation.
2828
After the upgrade you can manually remove those messages from the database.
2929
For example, when the MUC domain is `muc.localhost` and `rdbms_message_format` has the default value `internal`, one can remove such messages with the following query:

Diff for: doc/migrations/5.0.0_5.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The rules for overriding global options in the `host_config` section have been s
5151

5252
* `mod_auth_token` has a new configuration format - if you are using this module, amend the [`validity_period`](../modules/mod_auth_token.md#modulesmod_auth_tokenvalidity_period) option.
5353
* `mod_event_pusher` has an updated configuration format - the `backend` subsection is removed and the `http` backend has a new `handlers` option. Adjust your configuration according to [`mod_event_pusher`](../modules/mod_event_pusher.md) documentation.
54-
* `mod_mam_meta` does not have the `rdbms_message_format` and `simple` options anymore. Use [`db_jid_format`](../modules/mod_mam.md#modulesmod_mam_metadb_jid_format) and [`db_message_format`](../modules/mod_mam.md#modulesmod_mam_metadb_message_format) instead.
54+
* `mod_mam_meta` does not have the `rdbms_message_format` and `simple` options anymore. Use [`db_jid_format`](../modules/mod_mam.md#modulesmod_mamdb_jid_format) and [`db_message_format`](../modules/mod_mam.md#modulesmod_mamdb_message_format) instead. (note: the module is called `mod_mam` in the most recent versions).
5555
* `mod_shared_roster_ldap` all options have their `ldap_` prefix dropped.
5656
* `mod_vcard` LDAP options are moved into an LDAP subsection.
5757

0 commit comments

Comments
 (0)