Skip to content

Commit

Permalink
Merge pull request #4376 from esl/fix-mkdocs-links
Browse files Browse the repository at this point in the history
Fix relative links in docs
  • Loading branch information
chrzaszcz committed Sep 12, 2024
2 parents 34a28cf + 4d95cc1 commit 9c1cdf8
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion doc/configuration/configuration-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The section names above are links to the detailed documentation of each section.
!!! Warning
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:

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

## vm.args
Expand Down
4 changes: 2 additions & 2 deletions doc/configuration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In order to configure these hosts independently, use the [`host_config` section]

This is the list of names for the types of hosts that will serve dynamic XMPP domains.
Each host type can be seen as a label for a group of independent domains that use the same server configuration.
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).
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).

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.
MongooseIM will **not** start otherwise.
Expand Down Expand Up @@ -170,7 +170,7 @@ If a stanza is addressed to a subdomain of the served domain and this option is
* **Default:** `["mongoose_router_global", "mongoose_router_localdomain", "mongoose_router_external_localnode", "mongoose_router_external", "mongoose_router_dynamic_domains", "ejabberd_s2s"]`
* **Example:** `routing_modules = ["mongoose_router_global", "mongoose_router_localdomain"]`

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.
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.

## Miscellaneous

Expand Down
4 changes: 2 additions & 2 deletions doc/developers-guide/Stanza-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Next, depending on the type of the stanza, one of the following hooks is called:
* `user_send_iq` for IQ (info/query) stanzas,
* `user_send_xmlel` for other XML elements.

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.
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.

## 3. Message routing

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

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

* `mongoose_router_global`: runs a global `filter_packet` hook.
Expand Down
4 changes: 2 additions & 2 deletions doc/developers-guide/domain_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,5 +146,5 @@ Run `./mongooseimctl domain` to get more information about all supported operati

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

* 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.
* 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.
* 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.
* 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.
2 changes: 1 addition & 1 deletion doc/developers-guide/hooks_description.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ mongoose_hooks:filter_packet({From, To, Acc, Packet})
mongoose_hooks:filter_local_packet({From, To, Acc, Packet})
```

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.
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.

* `filter_packet` is run by `mongoose_router_global` for all routed packets. It is called at the start of the routing procedure.
* `filter_local_packet` is run by `mongoose_local_delivery` when the packet is being routed to a domain hosted by the local server.
Expand Down
2 changes: 1 addition & 1 deletion doc/developers-guide/xep_tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,5 @@ make xeplist

## Examples of generated content

* [Markdown table](../../user-guide/Supported-XEPs/)
* [Markdown table](../user-guide/Supported-XEPs.md)
* [DOAP file](https://raw.githubusercontent.com/esl/MongooseDocs/gh-pages/latest/mongooseim.doap)
2 changes: 1 addition & 1 deletion doc/getting-started/Quick-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ You know `mongooseimctl`, with basic server management commands such as:
* `start`, `restart`, `stop`, `status`, `live`, `foreground`
* `get_loglevel`
Other commands shown above correspond to the [GraphQL Admin API](../../graphql-api/Admin-GraphQL/) operations, and they are grouped into the following categories:
Other commands shown above correspond to the [GraphQL Admin API](../graphql-api/Admin-GraphQL.md) operations, and they are grouped into the following categories:
* `account` contains `registerUser`, `checkUser`, `listUsers`, `removeUser`
* `roster` contains `addContact`, `subscription`, `listContacts`, `setMutualSubscription`
Expand Down
2 changes: 1 addition & 1 deletion doc/migrations/4.0.1_4.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Since release 4.1.0, we are no longer supporting the `*.cfg` MongooseIM configur

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

* [`mod_mam_meta.user_prefs_store`](../modules/mod_mam.md#modulesmod_mam_metauser_prefs_store): `false` is no longer allowed
* [`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)

* [`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`

Expand Down
2 changes: 1 addition & 1 deletion doc/migrations/4.1.0_4.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ALTER TABLE inbox

### Archived groupchat messages in `mod_mam`

The [`archive_groupchats`](../modules/mod_mam.md#modulesmod_mam_metapmarchive_groupchats) option is now set to `false` by default, as documented.
The [`archive_groupchats`](../modules/mod_mam.md#modulesmod_mampmarchive_groupchats) option is now set to `false` by default, as documented.
Before the change, the private message (PM) archive stored incoming groupchat messages as well, contrary to the documentation.
After the upgrade you can manually remove those messages from the database.
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:
Expand Down
2 changes: 1 addition & 1 deletion doc/migrations/5.0.0_5.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The rules for overriding global options in the `host_config` section have been s

* `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.
* `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.
* `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.
* `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).
* `mod_shared_roster_ldap` all options have their `ldap_` prefix dropped.
* `mod_vcard` LDAP options are moved into an LDAP subsection.

Expand Down
Loading

0 comments on commit 9c1cdf8

Please sign in to comment.