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.

Sign up for GitHub

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

Jump to bottom

Add missing CETS docs and enable Mnesia by default #4087

Merged
merged 4 commits into from
Aug 9, 2023
Merged

Add missing CETS docs and enable Mnesia by default #4087

merged 4 commits into from
Aug 9, 2023

Conversation

chrzaszcz
Copy link
Member

@chrzaszcz chrzaszcz commented Aug 8, 2023 •
edited
Loading

Make the Mnesia internal database enabled by default - this way the transition is simpler.
If the section is included, it would overwrite this default.

  • Add migration guide (but there is nothing mandatory for the user)
  • Fill in missing options
  • Unify backend option docs
  • Always mention internal_databases to make sure the user does not forget

@mongoose-im

This comment was marked as outdated.

Sign in to view
@mongoose-im

This comment was marked as outdated.

Sign in to view
@codecov
Copy link

codecov bot commented Aug 8, 2023 •
edited
Loading

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.50% 🎉

Comparison is base (257371d) 83.37% compared to head (2667580) 83.87%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #4087      +/-   ##
==========================================
+ Coverage   83.37%   83.87%   +0.50%     
==========================================
  Files         551      551              
  Lines       33544    33545       +1     
==========================================
+ Hits        27967    28137     +170     
+ Misses       5577     5408     -169
Files Changed Coverage Δ
src/config/mongoose_config_spec.erl 100.00% <100.00%> (ø)

... and 30 files with indirect coverage changes

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

arcusfelis
arcusfelis reviewed Aug 8, 2023
View reviewed changes
Copy link
Contributor

@arcusfelis arcusfelis left a comment

Choose a reason for hiding this comment

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

Added comments

arcusfelis
arcusfelis reviewed Aug 8, 2023
View reviewed changes
doc/modules/mod_bosh.md Outdated Show resolved Hide resolved
Base automatically changed from feature/cets to master August 8, 2023 14:57
arcusfelis
arcusfelis reviewed Aug 8, 2023
View reviewed changes
Copy link
Contributor

@arcusfelis arcusfelis left a comment

Choose a reason for hiding this comment

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

double check that links work (in docs and on github)

@chrzaszcz
Copy link
Member Author

chrzaszcz commented Aug 9, 2023 •
edited
Loading

double check that links work (in docs and on github)

The way it works is that each link like internal-databases.md is rendered as ../internal-databases by mkdocs. Just internal-databases would be invalid. The docs won't render on GitHub properly because mkdocs has slightly different syntax, so I don't think it's a good idea to require checking both. I will change to the *.md version though. Anyway, we are using both versions in docs, and we could use one of them consistently, but it's out of scope for now.

@chrzaszcz chrzaszcz changed the title Cets/add missing docs Add missing CETS docs and make Mnesia enabled by default Aug 9, 2023
@chrzaszcz chrzaszcz changed the title Add missing CETS docs and make Mnesia enabled by default Add missing CETS docs and enable Mnesia by default Aug 9, 2023
@mongoose-im

This comment was marked as outdated.

Sign in to view
@mongoose-im

This comment was marked as outdated.

Sign in to view
@chrzaszcz
Enable mnesia by default
fc712bf 
'internal_databases' is a new option and it would be easier for the
user to have Mnesia enabled as before, when this sesction is omitted.

Leaving this section empty still makes it possible to configure no
internal databases at all.
@chrzaszcz
Simplify the format of 'internal_databases'
d129c47
@chrzaszcz
Update docs for internal databases
0241c21 
Add warnings about the backend configuration that needs to be changed
if you choose CETS instead of Mnesia.
@chrzaszcz
Add migration information for internal databases
2667580
@mongoose-im
Copy link
Collaborator

mongoose-im commented Aug 9, 2023 •
edited
Loading

elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 2667580
Reports root/ big
OK: 369 / Failed: 0 / User-skipped: 38 / Auto-skipped: 0

small_tests_24 / small_tests / 2667580
Reports root / small

small_tests_25 / small_tests / 2667580
Reports root / small

small_tests_25_arm64 / small_tests / 2667580
Reports root / small

ldap_mnesia_24 / ldap_mnesia / 2667580
Reports root/ big
OK: 2262 / Failed: 0 / User-skipped: 831 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 2667580
Reports root/ big
OK: 4225 / Failed: 0 / User-skipped: 84 / Auto-skipped: 0

dynamic_domains_mysql_redis_25 / mysql_redis / 2667580
Reports root/ big
OK: 4193 / Failed: 0 / User-skipped: 116 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 2667580
Reports root/ big
OK: 4225 / Failed: 0 / User-skipped: 84 / Auto-skipped: 0

ldap_mnesia_25 / ldap_mnesia / 2667580
Reports root/ big
OK: 2262 / Failed: 0 / User-skipped: 831 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 2667580
Reports root/ big
OK: 4222 / Failed: 0 / User-skipped: 87 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / 2667580
Reports root/ big
OK: 4610 / Failed: 0 / User-skipped: 91 / Auto-skipped: 0

internal_mnesia_25 / internal_mnesia / 2667580
Reports root/ big
OK: 2408 / Failed: 0 / User-skipped: 685 / Auto-skipped: 0

pgsql_cets_25 / pgsql_cets / 2667580
Reports root/ big
OK: 4580 / Failed: 0 / User-skipped: 121 / Auto-skipped: 0

mssql_mnesia_25 / odbc_mssql_mnesia / 2667580
Reports root/ big
OK: 4607 / Failed: 0 / User-skipped: 94 / Auto-skipped: 0

pgsql_mnesia_25 / pgsql_mnesia / 2667580
Reports root/ big
OK: 4610 / Failed: 0 / User-skipped: 91 / Auto-skipped: 0

mysql_redis_25 / mysql_redis / 2667580
Reports root/ big
OK: 4590 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0

@chrzaszcz chrzaszcz marked this pull request as ready for review August 9, 2023 13:56
arcusfelis
arcusfelis approved these changes Aug 9, 2023
View reviewed changes
Copy link
Contributor

@arcusfelis arcusfelis 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

@arcusfelis arcusfelis merged commit 45e214f into master Aug 9, 2023
4 checks passed
@arcusfelis arcusfelis deleted the cets/add-missing-docs branch August 9, 2023 14:31
@chrzaszcz chrzaszcz added this to the 6.2.0 milestone Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arcusfelis arcusfelis arcusfelis approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
6.2.0
Development

Successfully merging this pull request may close these issues.
3 participants
@chrzaszcz @mongoose-im @arcusfelis