Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split listeners documentation into multiple files #4327

Merged
merged 9 commits into from
Jul 26, 2024
Merged

Conversation

gustawlippa
Copy link
Contributor

@gustawlippa gustawlippa commented Jul 23, 2024

This PR splits the Options: Listen section of the documentation into multiple files, one for each of: general options, C2S, S2S, XMPP Components and HTTP listeners.

It also fixes small issues I found when reviewing the docs, like typos, warnings, missing links.

@mongoose-im

This comment was marked as outdated.

Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.31%. Comparing base (541aced) to head (e6d3c4d).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4327      +/-   ##
==========================================
- Coverage   84.33%   84.31%   -0.03%     
==========================================
  Files         553      553              
  Lines       33731    33731              
==========================================
- Hits        28447    28440       -7     
- Misses       5284     5291       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mongoose-im

This comment was marked as outdated.

@gustawlippa gustawlippa marked this pull request as ready for review July 24, 2024 11:17
@mongoose-im

This comment was marked as outdated.

@gustawlippa gustawlippa marked this pull request as draft July 24, 2024 13:17
@mongoose-im

This comment was marked as outdated.

@gustawlippa gustawlippa marked this pull request as ready for review July 24, 2024 14:11
@mongoose-im
Copy link
Collaborator

mongoose-im commented Jul 25, 2024

elasticsearch_and_cassandra_26 / elasticsearch_and_cassandra_mnesia / d6347f1
Reports root/ big
OK: 439 / Failed: 0 / User-skipped: 47 / Auto-skipped: 0


small_tests_25 / small_tests / d6347f1
Reports root / small


small_tests_26 / small_tests / d6347f1
Reports root / small


small_tests_26_arm64 / small_tests / d6347f1
Reports root / small


ldap_mnesia_25 / ldap_mnesia / d6347f1
Reports root/ big
OK: 2337 / Failed: 0 / User-skipped: 905 / Auto-skipped: 0


ldap_mnesia_26 / ldap_mnesia / d6347f1
Reports root/ big
OK: 2337 / Failed: 0 / User-skipped: 905 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / d6347f1
Reports root/ big
OK: 4621 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


dynamic_domains_mysql_redis_26 / mysql_redis / d6347f1
Reports root/ big
OK: 4588 / Failed: 0 / User-skipped: 144 / Auto-skipped: 0


internal_mnesia_26 / internal_mnesia / d6347f1
Reports root/ big
OK: 2477 / Failed: 0 / User-skipped: 765 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / d6347f1
Reports root/ big
OK: 4621 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_26 / odbc_mssql_mnesia / d6347f1
Reports root/ big
OK: 4618 / Failed: 0 / User-skipped: 114 / Auto-skipped: 0


pgsql_cets_26 / pgsql_cets / d6347f1
Reports root/ big
OK: 4532 / Failed: 0 / User-skipped: 178 / Auto-skipped: 0


pgsql_mnesia_25 / pgsql_mnesia / d6347f1
Reports root/ big
OK: 5012 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0


pgsql_mnesia_26 / pgsql_mnesia / d6347f1
Reports root/ big
OK: 5012 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0


mysql_redis_26 / mysql_redis / d6347f1
Reports root/ big
OK: 4991 / Failed: 0 / User-skipped: 139 / Auto-skipped: 0


mssql_mnesia_26 / odbc_mssql_mnesia / d6347f1
Reports root/ big
OK: 5009 / Failed: 0 / User-skipped: 121 / Auto-skipped: 0

Copy link
Member

@chrzaszcz chrzaszcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I added one minor comment - not necessary to address.

doc/migrations/4.0.1_4.1.0.md Outdated Show resolved Hide resolved
Co-authored-by: Paweł Chrząszcz <pawel.chrzaszcz@erlang-solutions.com>
@mongoose-im
Copy link
Collaborator

mongoose-im commented Jul 25, 2024

elasticsearch_and_cassandra_26 / elasticsearch_and_cassandra_mnesia / e6d3c4d
Reports root/ big
OK: 439 / Failed: 0 / User-skipped: 47 / Auto-skipped: 0


small_tests_25 / small_tests / e6d3c4d
Reports root / small


small_tests_26 / small_tests / e6d3c4d
Reports root / small


small_tests_26_arm64 / small_tests / e6d3c4d
Reports root / small


ldap_mnesia_25 / ldap_mnesia / e6d3c4d
Reports root/ big
OK: 2337 / Failed: 0 / User-skipped: 905 / Auto-skipped: 0


ldap_mnesia_26 / ldap_mnesia / e6d3c4d
Reports root/ big
OK: 2337 / Failed: 0 / User-skipped: 905 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / e6d3c4d
Reports root/ big
OK: 4621 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


dynamic_domains_mysql_redis_26 / mysql_redis / e6d3c4d
Reports root/ big
OK: 4588 / Failed: 0 / User-skipped: 144 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / e6d3c4d
Reports root/ big
OK: 4621 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


internal_mnesia_26 / internal_mnesia / e6d3c4d
Reports root/ big
OK: 2477 / Failed: 0 / User-skipped: 765 / Auto-skipped: 0


pgsql_cets_26 / pgsql_cets / e6d3c4d
Reports root/ big
OK: 4532 / Failed: 0 / User-skipped: 178 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_26 / odbc_mssql_mnesia / e6d3c4d
Reports root/ big
OK: 4618 / Failed: 0 / User-skipped: 114 / Auto-skipped: 0


pgsql_mnesia_25 / pgsql_mnesia / e6d3c4d
Reports root/ big
OK: 5012 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0


pgsql_mnesia_26 / pgsql_mnesia / e6d3c4d
Reports root/ big
OK: 5012 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0


mysql_redis_26 / mysql_redis / e6d3c4d
Reports root/ big
OK: 4991 / Failed: 0 / User-skipped: 139 / Auto-skipped: 0


mssql_mnesia_26 / odbc_mssql_mnesia / e6d3c4d
Reports root/ big
OK: 5009 / Failed: 0 / User-skipped: 121 / Auto-skipped: 0

@chrzaszcz chrzaszcz merged commit 853aec3 into master Jul 26, 2024
4 checks passed
@chrzaszcz chrzaszcz deleted the docs/split-listen branch July 26, 2024 10:18
@jacekwegr jacekwegr added this to the 6.3.0 milestone Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants