From c028d27765bff3ba73d70f6fc62151309d636d9a Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Mon, 1 Feb 2021 15:26:37 +0100 Subject: [PATCH 1/4] Documentation improvements Add github actions and circleci badges, correct a typo, and a link to the muc_light xep. --- README.md | 13 +++++-------- doc/advanced-configuration/Modules.md | 2 +- doc/index.md | 10 ++++------ 3 files changed, 10 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 038bd66b1ac..203da7bf814 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # MongooseIM platform -[![Build Status](https://travis-ci.org/esl/MongooseIM.svg?branch=master)](https://travis-ci.org/esl/MongooseIM) +[![Build Status](https://github.com/esl/MongooseIM/workflows/CI/badge.svg)](https://github.com/esl/MongooseIM/actions) +[![CircleCI](https://circleci.com/gh/esl/MongooseIM.svg?style=shield&circle-token=53cdda11cfb95bd7a7044c509c89cb73d3fdeb5a)](https://github.com/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) @@ -48,12 +49,8 @@ For a quick start just download: Check out our test results: -* Continuous integration: [https://travis-ci.org/esl/MongooseIM](https://travis-ci.org/esl/MongooseIM) -* Code coverage: [https://coveralls.io/github/esl/MongooseIM](https://coveralls.io/github/esl/MongooseIM) -* Continuous Load Testing: [https://tide.erlang-solutions.com/](https://tide.erlang-solutions.com/) -* Load test history: - ![Load test history](https://tide.erlang-solutions.com/charts/bidaily_last_year.png) - +* Continuous integration: [Github's actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) +* Code coverage: [https://codecov.io/gh/esl/MongooseIM](https://codecov.io/gh/esl/MongooseIM) ## Documentation @@ -95,4 +92,4 @@ Suggestions, questions, thoughts? Contact us directly: * Email us at mongoose-im@erlang-solutions.com * Follow our [Twitter account](https://twitter.com/MongooseIM): [https://twitter.com/MongooseIM](https://twitter.com/MongooseIM) * Like our [Facebook page](https://www.facebook.com/MongooseIM/): [https://www.facebook.com/MongooseIM/](https://www.facebook.com/MongooseIM/) -* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two montly emails as well as access to the free and open archives. +* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives. diff --git a/doc/advanced-configuration/Modules.md b/doc/advanced-configuration/Modules.md index e2d8f5961cd..edffff6c470 100644 --- a/doc/advanced-configuration/Modules.md +++ b/doc/advanced-configuration/Modules.md @@ -131,7 +131,7 @@ Provides `mod_muc` related `mongoose_commands`, accessible via the client REST A Implements a logging subsystem for [mod_muc](../modules/mod_muc.md). ### [mod_muc_light](../modules/mod_muc_light.md) -Implements [XEP Multi-User Chat Light](https://github.com/xsf/xeps/pull/118). +Implements [XEP Multi-User Chat Light](https://xmpp.org/extensions/inbox/muc-light.html). ### [mod_muc_light_commands](../modules/mod_muc_light_commands.md) Provides `mod_muc_light` related `mongoose_commands`, accessible via client REST API. diff --git a/doc/index.md b/doc/index.md index af5ca54c0ad..9e16c36f782 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,6 +1,7 @@ # MongooseIM platform -[![Build Status](https://travis-ci.org/esl/MongooseIM.svg?branch=master)](https://travis-ci.org/esl/MongooseIM) +[![Build Status](https://github.com/esl/MongooseIM/workflows/CI/badge.svg)](https://github.com/esl/MongooseIM/actions) +[![CircleCI](https://circleci.com/gh/esl/MongooseIM.svg?style=shield&circle-token=53cdda11cfb95bd7a7044c509c89cb73d3fdeb5a)](https://github.com/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) @@ -65,11 +66,8 @@ For a quick start just download: Check out our test results: -* Continuous integration: [https://travis-ci.org/esl/MongooseIM](https://travis-ci.org/esl/MongooseIM) +* Continuous integration: [Github's actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) * Code coverage: [https://codecov.io/gh/esl/MongooseIM](https://codecov.io/gh/esl/MongooseIM) -* Continuous Load Testing: [http://tide.erlang-solutions.com/](http://tide.erlang-solutions.com/) -* Load test history: - ![Load test history](https://tide.erlang-solutions.com/charts/bidaily_last_year.png) ## Versions @@ -98,4 +96,4 @@ Suggestions, questions, thoughts? Contact us directly: * Email us at mongoose-im@erlang-solutions.com * Follow our [Twitter account](https://twitter.com/MongooseIM): [https://twitter.com/MongooseIM](https://twitter.com/MongooseIM) * Like our [Facebook page](https://www.facebook.com/MongooseIM/): [https://www.facebook.com/MongooseIM/](https://www.facebook.com/MongooseIM/) -* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two montly emails as well as access to the free and open archives. +* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives. From ffb444c61120b349808c94557fd3482cbd94df79 Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Mon, 1 Feb 2021 15:33:04 +0100 Subject: [PATCH 2/4] Inbox doesn't accept a backend option --- doc/modules/mod_inbox.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/modules/mod_inbox.md b/doc/modules/mod_inbox.md index fc2da5d0db1..0e432f29e4c 100644 --- a/doc/modules/mod_inbox.md +++ b/doc/modules/mod_inbox.md @@ -221,7 +221,6 @@ value: --> ```toml [modules.mod_inbox] - backend = "rdbms" reset_markers = ["displayed"] aff_changes = true remove_on_kicked = true From f511637ab1f3ad52bafe2a69fb128b1e8ed3be01 Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Tue, 2 Feb 2021 09:30:58 +0100 Subject: [PATCH 3/4] Apply review Co-authored-by: Leszek Witkowicz " --- README.md | 10 +++++----- doc/index.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 203da7bf814..91b56e1860e 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ For a quick start just download: Check out our test results: -* Continuous integration: [Github's actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) +* Continuous integration: [Github actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) * Code coverage: [https://codecov.io/gh/esl/MongooseIM](https://codecov.io/gh/esl/MongooseIM) ## Documentation @@ -88,8 +88,8 @@ When developing new features/modules, please make sure you add basic documentati Suggestions, questions, thoughts? Contact us directly: -* Raise a [GitHub issue](https://github.com/esl/MongooseIM/issues): https://github.com/esl/MongooseIM/issues +* Raise a [GitHub issue](https://github.com/esl/MongooseIM/issues) * Email us at mongoose-im@erlang-solutions.com -* Follow our [Twitter account](https://twitter.com/MongooseIM): [https://twitter.com/MongooseIM](https://twitter.com/MongooseIM) -* Like our [Facebook page](https://www.facebook.com/MongooseIM/): [https://www.facebook.com/MongooseIM/](https://www.facebook.com/MongooseIM/) -* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives. +* Follow our [Twitter account](https://twitter.com/MongooseIM) +* Like our [Facebook page](https://www.facebook.com/MongooseIM/) +* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives diff --git a/doc/index.md b/doc/index.md index 9e16c36f782..b288389612c 100644 --- a/doc/index.md +++ b/doc/index.md @@ -66,7 +66,7 @@ For a quick start just download: Check out our test results: -* Continuous integration: [Github's actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) +* Continuous integration: [Github actions](https://github.com/esl/MongooseIM/actions?query=workflow%3ACI) * Code coverage: [https://codecov.io/gh/esl/MongooseIM](https://codecov.io/gh/esl/MongooseIM) ## Versions @@ -92,8 +92,8 @@ When developing new features/modules, please make sure you add basic documentati Suggestions, questions, thoughts? Contact us directly: -* Raise a [GitHub issue](https://github.com/esl/MongooseIM/issues): https://github.com/esl/MongooseIM/issues +* Raise a [GitHub issue](https://github.com/esl/MongooseIM/issues) * Email us at mongoose-im@erlang-solutions.com -* Follow our [Twitter account](https://twitter.com/MongooseIM): [https://twitter.com/MongooseIM](https://twitter.com/MongooseIM) -* Like our [Facebook page](https://www.facebook.com/MongooseIM/): [https://www.facebook.com/MongooseIM/](https://www.facebook.com/MongooseIM/) -* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) at [https://groups.google.com/d/forum/mongooseim-announce](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives. +* Follow our [Twitter account](https://twitter.com/MongooseIM) +* Like our [Facebook page](https://www.facebook.com/MongooseIM/) +* Subscribe to our [mailing list](https://groups.google.com/d/forum/mongooseim-announce) to receive no more than two monthly emails as well as access to the free and open archives. From 3648d6cb82eabd50704cda65f8d8730017317729 Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Tue, 2 Feb 2021 12:36:43 +0100 Subject: [PATCH 4/4] Host specific warning, move to host section --- doc/modules/mod_mam.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/modules/mod_mam.md b/doc/modules/mod_mam.md index 92870f7b632..969230d8efe 100644 --- a/doc/modules/mod_mam.md +++ b/doc/modules/mod_mam.md @@ -63,7 +63,6 @@ Do not add a `` element from MAM v0.6. * **Syntax:** non-empty string * **Default:** `"mod_mam_utils"` * **Example:** `is_archivable_message = "mod_mam_utils"` -* **Warning**: if you are using MUC Light, make sure this option is set to the MUC Light domain Name of a module implementing [`is_archivable_message/3` callback](#is_archivable_message) that determines if the message should be archived. @@ -145,6 +144,7 @@ To disable archive for MUC messages please remove MUC section or any MUC related * **Syntax:** string * **Default:** `"conference.@HOST@"` * **Example:** `modules.mod_mam_meta.muc.host = "conference.@HOST@"` +* **Warning**: if you are using MUC Light, make sure this option is set to the MUC Light domain The MUC host that will be archived if MUC archiving is enabled.