Fix small documentation issues #3303

gustawlippa · 2021-09-24T15:16:18Z

This PR addresses removes duplicates from docs, removes Tide mentions for now, adds links to mod_inbox and removes @HOSTS@ mentions.

As Tide is not live, maybe it's better not to advertise it for now.

doc/Contributions.md

vkatsuba · 2021-09-28T08:35:08Z

doc/developers-guide/Testing-MongooseIM.md

-We have our own load testing infrastructure, called Tide, which is triggered after every successful test run, and gives us a feedback on changes to MongooseIM performance.
-
-Test results are publicly available on the [Hello Tide!](http://tide.erlang-solutions.com/public) page.
+We use [amoc](https://github.com/esl/amoc) and [amoc-arsenal-xmpp](https://github.com/esl/amoc-arsenal-xmpp/) to perform tests that give us a feedback on changes to MongooseIM performance.


Maybe need highlight MongooseIM maybe MongooseIM or MongooseIM

I don't think that's a convention used anywhere in the docs regarding the name MongooseIM - is it really needed?

I suppose it's make sense to highlight MongooseIM, but up to you, this is not a critical issue, this is just proposing.

I must admit I'm not a fan of it - "MongooseIM" is already capitalised, and it is the name of the program the documentation is about, no real need to highlight it there any more. If we had some different font for the name that we used everywhere, or something like a different way of writing the name then I would be more for it.
Maybe we can think about this change in the context of some other PR, as it would probably entail changing "MongooseIM" throughout the docs.

doc/developers-guide/domain_management.md

vkatsuba · 2021-09-28T08:39:11Z

doc/user-guide/Features.md

@@ -64,7 +64,7 @@ MongooseIM gathers over 50 different XMPP-related metrics, allowing close monito

 Erlang Solutions also provides [WombatOAM](https://www.erlang-solutions.com/products/wombat-oam.html), an Erlang VM monitoring solution, that enables ops and devs to better understand what going on in a MongooseIM cluster.

-For load testing consider [Tide](http://tide.erlang-solutions.com/), another Erlang Solutions' tool that enables devs and ops to validate their scalability, given the clients scenarios.
+For load testing we use [our own tools](../Contributions.md#amoc), that enable us to validate MongooseIM's scalability, given different scenarios.


Maybe need highlight MongooseIM maybe MongooseIM or MongooseIM

vkatsuba

Please, make sure that the last commit will be without prefix [skip ci] to check build documentation CI.

mongoose-im · 2021-09-28T09:10:20Z

small_tests_24 / small_tests / b2a117c
Reports root / small

internal_mnesia_24 / internal_mnesia / b2a117c
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 293 / Auto-skipped: 0

small_tests_23 / small_tests / b2a117c
Reports root / small

dynamic_domains_24 / pgsql_mnesia / b2a117c
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / b2a117c
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

ldap_mnesia_23 / ldap_mnesia / b2a117c
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

dynamic_domains_23 / pgsql_mnesia / b2a117c
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / b2a117c
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

mysql_redis_24 / mysql_redis / b2a117c
Reports root/ big
OK: 3056 / Failed: 1 / User-skipped: 228 / Auto-skipped: 0

mam_SUITE:rdbms_cache_prefs_cases:messages_filtered_when_prefs_default_policy_is_never

{error,{test_case_failed,"ASSERT EQUAL\n\tExpected []\n\tValue [ok]\n"}}

Report log

elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / b2a117c
Reports root/ big
OK: 1862 / Failed: 0 / User-skipped: 319 / Auto-skipped: 0

pgsql_mnesia_23 / pgsql_mnesia / b2a117c
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

mssql_mnesia_24 / odbc_mssql_mnesia / b2a117c
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / b2a117c
Reports root/ big
OK: 1709 / Failed: 0 / User-skipped: 322 / Auto-skipped: 0

codecov · 2021-09-28T09:10:35Z

Codecov Report

Merging #3303 (55f0dc3) into master (8b8c294) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3303      +/-   ##
==========================================
+ Coverage   80.19%   80.20%   +0.01%     
==========================================
  Files         398      398              
  Lines       32584    32584              
==========================================
+ Hits        26130    26134       +4     
+ Misses       6454     6450       -4

Impacted Files	Coverage Δ
src/domain/mongoose_domain_sql.erl	`82.85% <0.00%> (-2.86%)`	⬇️
src/domain/mongoose_domain_loader.erl	`77.35% <0.00%> (-1.89%)`	⬇️
src/admin_extra/service_admin_extra_gdpr.erl	`94.82% <0.00%> (-1.73%)`	⬇️
src/mam/mod_mam.erl	`88.33% <0.00%> (-0.84%)`	⬇️
src/ejabberd_sm.erl	`84.26% <0.00%> (-0.33%)`	⬇️
src/mod_muc_room.erl	`77.12% <0.00%> (-0.06%)`	⬇️
src/mod_muc_log.erl	`77.88% <0.00%> (ø)`
src/pubsub/mod_pubsub_db_mnesia.erl	`92.85% <0.00%> (+0.42%)`	⬆️
src/metrics/mongoose_metrics.erl	`96.10% <0.00%> (+0.64%)`	⬆️
src/rdbms/mongoose_rdbms.erl	`61.69% <0.00%> (+0.80%)`	⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b8c294...55f0dc3. Read the comment docs.

doc/developers-guide/domain_management.md

mongoose-im · 2021-09-28T10:03:43Z

small_tests_24 / small_tests / c0e566f
Reports root / small

internal_mnesia_24 / internal_mnesia / c0e566f
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 293 / Auto-skipped: 0

small_tests_23 / small_tests / c0e566f
Reports root / small

dynamic_domains_24 / pgsql_mnesia / c0e566f
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

dynamic_domains_23 / pgsql_mnesia / c0e566f
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / c0e566f
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

ldap_mnesia_23 / ldap_mnesia / c0e566f
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / c0e566f
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / c0e566f
Reports root/ big
OK: 1862 / Failed: 0 / User-skipped: 319 / Auto-skipped: 0

mssql_mnesia_24 / odbc_mssql_mnesia / c0e566f
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

pgsql_mnesia_23 / pgsql_mnesia / c0e566f
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

mysql_redis_24 / mysql_redis / c0e566f
Reports root/ big
OK: 3056 / Failed: 1 / User-skipped: 228 / Auto-skipped: 0

mam_SUITE:rdbms_async_cache_prefs_cases:messages_filtered_when_prefs_default_policy_is_roster

{error,{test_case_failed,"ASSERT EQUAL\n\tExpected []\n\tValue [ok]\n"}}

Report log

riak_mnesia_24 / riak_mnesia / c0e566f
Reports root/ big
OK: 1709 / Failed: 0 / User-skipped: 322 / Auto-skipped: 0

mongoose-im · 2021-09-28T10:09:24Z

small_tests_24 / small_tests / 55f0dc3
Reports root / small

internal_mnesia_24 / internal_mnesia / 55f0dc3
Reports root/ big
OK: 1589 / Failed: 0 / User-skipped: 293 / Auto-skipped: 0

small_tests_23 / small_tests / 55f0dc3
Reports root / small

ldap_mnesia_24 / ldap_mnesia / 55f0dc3
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

dynamic_domains_24 / pgsql_mnesia / 55f0dc3
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

dynamic_domains_23 / pgsql_mnesia / 55f0dc3
Reports root/ big
OK: 2698 / Failed: 0 / User-skipped: 184 / Auto-skipped: 0

elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / 55f0dc3
Reports root/ big
OK: 1862 / Failed: 0 / User-skipped: 319 / Auto-skipped: 0

ldap_mnesia_23 / ldap_mnesia / 55f0dc3
Reports root/ big
OK: 1486 / Failed: 0 / User-skipped: 396 / Auto-skipped: 0

mysql_redis_24 / mysql_redis / 55f0dc3
Reports root/ big
OK: 3050 / Failed: 0 / User-skipped: 228 / Auto-skipped: 0

pgsql_mnesia_23 / pgsql_mnesia / 55f0dc3
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

mssql_mnesia_24 / odbc_mssql_mnesia / 55f0dc3
Reports root/ big
OK: 3077 / Failed: 2 / User-skipped: 211 / Auto-skipped: 0

carboncopy_SUITE:all:prop_forward_received_chat_messages

{error,
  {{assertEqual,
     [{module,carboncopy_SUITE},
      {line,278},
      {expression,
        "proper : quickcheck ( proper : conjunction ( [ { PropName , Property } ] ) , [ verbose , long_result , { numtests , 3 } ] )"},
      {expected,true},
      {value,
        [[{forward_received,
          [{5,<<"Now, fair Hippolyta, our nuptial hour">>}]}]]}]},
   [{carboncopy_SUITE,run_prop,2,
      [{file,"/home/circleci/app/big_tests/tests/carboncopy_SUITE.erl"},
       {line,278}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1292}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1224}]}]}}

Report log

carboncopy_SUITE:all:prop_forward_sent_chat_messages

{error,
  {{assertEqual,
     [{module,carboncopy_SUITE},
      {line,278},
      {expression,
        "proper : quickcheck ( proper : conjunction ( [ { PropName , Property } ] ) , [ verbose , long_result , { numtests , 3 } ] )"},
      {expected,true},
      {value,
        [[{forward_sent,
          [{5,<<"Now, fair Hippolyta, our nuptial hour">>}]}]]}]},
   [{carboncopy_SUITE,run_prop,2,
      [{file,"/home/circleci/app/big_tests/tests/carboncopy_SUITE.erl"},
       {line,278}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1292}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1224}]}]}}

Report log

riak_mnesia_24 / riak_mnesia / 55f0dc3
Reports root/ big
OK: 1709 / Failed: 0 / User-skipped: 322 / Auto-skipped: 0

small_tests_23 / small_tests / 55f0dc3
Reports root / small

pgsql_mnesia_24 / pgsql_mnesia / 55f0dc3
Reports root/ big
OK: 3067 / Failed: 0 / User-skipped: 211 / Auto-skipped: 0

chrzaszcz

Looks good!

gustawlippa added 4 commits September 24, 2021 17:12

[skip ci] Remove duplicates

dd6d660

[skip ci] Add amoc-arsenal-xmpp, remove Tide

75618c9

As Tide is not live, maybe it's better not to advertise it for now.

[skip ci] Link mod_inbox with the XMPP extension

fb3750c

[skip ci] Remove @hosts@ mentions

55f1674

gustawlippa marked this pull request as ready for review September 28, 2021 08:25

vkatsuba reviewed Sep 28, 2021

View reviewed changes

doc/Contributions.md Outdated Show resolved Hide resolved

vkatsuba reviewed Sep 28, 2021

View reviewed changes

doc/developers-guide/domain_management.md Outdated Show resolved Hide resolved

vkatsuba reviewed Sep 28, 2021

View reviewed changes

[skip ci] Add license links

be3fecd

vkatsuba reviewed Sep 28, 2021

View reviewed changes

doc/developers-guide/domain_management.md Outdated Show resolved Hide resolved

Unify error descriptions

c0e566f

gustawlippa force-pushed the doc-update branch from b2a117c to c0e566f Compare September 28, 2021 09:52

Apply review

55f0dc3

vkatsuba approved these changes Sep 28, 2021

View reviewed changes

vkatsuba merged commit 818530a into master Sep 28, 2021

vkatsuba deleted the doc-update branch September 28, 2021 10:59

vkatsuba mentioned this pull request Sep 28, 2021

Fix @HOSTS@ to @HOST@ #3229

Closed

chrzaszcz reviewed Sep 28, 2021

View reviewed changes

Premwoik added this to the 5.0.0 milestone Oct 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix small documentation issues #3303

Fix small documentation issues #3303

gustawlippa commented Sep 24, 2021 •

edited

Loading

vkatsuba Sep 28, 2021

gustawlippa Sep 28, 2021

vkatsuba Sep 28, 2021

gustawlippa Sep 28, 2021

vkatsuba Sep 28, 2021

vkatsuba left a comment

mongoose-im commented Sep 28, 2021 •

edited

Loading

codecov bot commented Sep 28, 2021 •

edited

Loading

mongoose-im commented Sep 28, 2021 •

edited

Loading

mongoose-im commented Sep 28, 2021 •

edited

Loading

chrzaszcz left a comment

Fix small documentation issues #3303

Fix small documentation issues #3303

Conversation

gustawlippa commented Sep 24, 2021 • edited Loading

vkatsuba Sep 28, 2021

Choose a reason for hiding this comment

gustawlippa Sep 28, 2021

Choose a reason for hiding this comment

vkatsuba Sep 28, 2021

Choose a reason for hiding this comment

gustawlippa Sep 28, 2021

Choose a reason for hiding this comment

vkatsuba Sep 28, 2021

Choose a reason for hiding this comment

vkatsuba left a comment

Choose a reason for hiding this comment

mongoose-im commented Sep 28, 2021 • edited Loading

codecov bot commented Sep 28, 2021 • edited Loading

Codecov Report

mongoose-im commented Sep 28, 2021 • edited Loading

mongoose-im commented Sep 28, 2021 • edited Loading

chrzaszcz left a comment

Choose a reason for hiding this comment

gustawlippa commented Sep 24, 2021 •

edited

Loading

mongoose-im commented Sep 28, 2021 •

edited

Loading

codecov bot commented Sep 28, 2021 •

edited

Loading

mongoose-im commented Sep 28, 2021 •

edited

Loading

mongoose-im commented Sep 28, 2021 •

edited

Loading