-
Notifications
You must be signed in to change notification settings - Fork 428
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
change readthedocs theme to material #2960
Conversation
8833.1 / Erlang 23.0.3 / small_tests / e2dc9f4 8833.2 / Erlang 23.0.3 / internal_mnesia / e2dc9f4 jingle_SUITE:all:resp_4xx_from_sip_proxy_results_in_session_terminate{'EXIT',
{fw_error,
{ct_framework,error_notification,
{{case_clause,[]},
[{ct_framework,error_notification,4,
[{file,"ct_framework.erl"},{line,997}]},
{test_server_sup,framework_call,4,
[{file,"test_server_sup.erl"},{line,778}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1268}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1195}]}]}}}} 8833.3 / Erlang 23.0.3 / odbc_mssql_mnesia / e2dc9f4 8833.4 / Erlang 23.0.3 / mysql_redis / e2dc9f4 8833.7 / Erlang 23.0.3 / elasticsearch_and_cassandra_mnesia / e2dc9f4 8833.5 / Erlang 23.0.3 / riak_mnesia / e2dc9f4 8833.6 / Erlang 23.0.3 / ldap_mnesia / e2dc9f4 8833.9 / Erlang 22.3 / pgsql_mnesia / e2dc9f4 |
Codecov Report
@@ Coverage Diff @@
## master #2960 +/- ##
==========================================
+ Coverage 79.16% 79.23% +0.07%
==========================================
Files 377 377
Lines 32795 32795
==========================================
+ Hits 25961 25986 +25
+ Misses 6834 6809 -25
Continue to review full report at Codecov.
|
8836.1 / Erlang 23.0.3 / small_tests / 3657f53 8836.4 / Erlang 23.0.3 / mysql_redis / 3657f53 pubsub_SUITE:dag+collection_config:disable_notifications_leaf_test{'EXIT',
{fw_error,
{ct_framework,error_notification,
{{case_clause,[]},
[{ct_framework,error_notification,4,
[{file,"ct_framework.erl"},{line,997}]},
{test_server_sup,framework_call,4,
[{file,"test_server_sup.erl"},{line,778}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1268}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1195}]}]}}}} 8836.3 / Erlang 23.0.3 / odbc_mssql_mnesia / 3657f53 8836.2 / Erlang 23.0.3 / internal_mnesia / 3657f53 8836.7 / Erlang 23.0.3 / elasticsearch_and_cassandra_mnesia / 3657f53 8836.5 / Erlang 23.0.3 / riak_mnesia / 3657f53 8836.6 / Erlang 23.0.3 / ldap_mnesia / 3657f53 8836.9 / Erlang 22.3 / pgsql_mnesia / 3657f53 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing work man, huge patience to go through every single file and fix every single indentation, code block, links... I'm enormously thankful 👏
Just a few comments to apply, and then let me know when you think this is finished so we can merge 😄
8838.1 / Erlang 23.0.3 / small_tests / 18f197e 8838.2 / Erlang 23.0.3 / internal_mnesia / 18f197e 8838.3 / Erlang 23.0.3 / odbc_mssql_mnesia / 18f197e 8838.4 / Erlang 23.0.3 / mysql_redis / 18f197e 8838.5 / Erlang 23.0.3 / riak_mnesia / 18f197e 8838.7 / Erlang 23.0.3 / elasticsearch_and_cassandra_mnesia / 18f197e 8838.6 / Erlang 23.0.3 / ldap_mnesia / 18f197e 8838.9 / Erlang 22.3 / pgsql_mnesia / 18f197e |
doc/custom.css
Outdated
@@ -2,3 +2,8 @@ img#mim-readme-logo { | |||
margin-right: 1.5em; | |||
margin-bottom: 1em; | |||
} | |||
|
|||
:root { | |||
--md-primary-fg-color: #459bb6; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
8848.1 / Erlang 23.0.3 / small_tests / 680c262 8848.2 / Erlang 23.0.3 / internal_mnesia / 680c262 8848.3 / Erlang 23.0.3 / odbc_mssql_mnesia / 680c262 8848.4 / Erlang 23.0.3 / mysql_redis / 680c262 8848.5 / Erlang 23.0.3 / riak_mnesia / 680c262 8848.6 / Erlang 23.0.3 / ldap_mnesia / 680c262 8848.7 / Erlang 23.0.3 / elasticsearch_and_cassandra_mnesia / 680c262 8848.9 / Erlang 22.3 / pgsql_mnesia / 680c262 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@leszke , @kmakiela great work! I really like the new look and feel of the docs 🎉
@leszke thanks for going so carefully though the documentation and fixing all the links, headers and indentation issues. I really appreciate the effort 💪 Great attention to detail!
I reviewed following sections and they look good as well:
- developer's guide
- modules
- and the commits that follow
I there's only one fix comment for the mod_pubsub
, once this is fixed we can approve and merge.
|
||
* 3.4.1 alert: **not supported** | ||
* 3.4.2 drop: **not supported** | ||
* 3.4.3 error: **supported** | ||
* 3.4.4 notify: **supported**. Notifications for the `stored` and `direct` conditions are sent as soon as the message has been stored or sent to the recipient. | ||
|
||
* 6. Error Handling | ||
6\. Error Handling |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
- 'mod_event_pusher': | ||
- 'mod_event_pusher': 'modules/mod_event_pusher.md' | ||
- 'HTTP backend': 'modules/mod_event_pusher_http.md' | ||
- 'Push backend': 'modules/mod_event_pusher_push.md' | ||
- 'SNS backend': 'modules/mod_event_pusher_sns.md' | ||
- 'RabbitMQ backend': 'modules/mod_event_pusher_rabbit.md' | ||
- 'mod_extdisco': 'modules/mod_extdisco.md' | ||
- 'mod_global_distrib': 'modules/mod_global_distrib.md' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
doc/modules/mod_pubsub.md
Outdated
|
||
Implementation of [XEP-0060 (Personal Eventing Protocol)](http://xmpp.org/extensions/xep-0163.html). | ||
Implementation of [XEP-0163 (Personal Eventing Protocol)](http://xmpp.org/extensions/xep-0163.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great catch!
Thank for the review. But before we merge I personally would like somebody to take care and reply to my concerns I shared in PR description 🙂 |
Comments on the concerns from the PR description below:
Please create a ticket for that so that we don't forget about it when we decide how to proceed with tide.
Unless there would be some special formatting for the notes, let's leave it as subsection. It goes into the table of contents as it is a header and we want to have a header there.
I could see them being useful for the user. No harm in leaving them. I actually prefer to have a bit more links than not enough.
Still contribution. I went though the list and plenty of PR were merged, some were cherry picked and some are still hanging. Even the open and closed ones are still valid contributions that it's good to have there even for our reference.
I don't have the same feeling about this section. This is the top page that introduces all the authentication related parts. It's good that it has intro and link method specific options. It may seem redundant but I find it useful from user perspective.
I could not find the PR you mention, could you point to the exact line?
Could you create a ticket for that, so we don't forget about it |
I would log these in one issue not to multiply them too much.
For this one, the nesting level is 4, why it looks odd, I think it should be 3 for consistency.
I think these ones don't need any actions, they look fine. |
8849.1 / Erlang 23.0.3 / small_tests / 8cf534a 8849.2 / Erlang 23.0.3 / internal_mnesia / 8cf534a 8849.4 / Erlang 23.0.3 / mysql_redis / 8cf534a 8849.3 / Erlang 23.0.3 / odbc_mssql_mnesia / 8cf534a 8849.7 / Erlang 23.0.3 / elasticsearch_and_cassandra_mnesia / 8cf534a 8849.5 / Erlang 23.0.3 / riak_mnesia / 8cf534a 8849.6 / Erlang 23.0.3 / ldap_mnesia / 8cf534a 8849.9 / Erlang 22.3 / pgsql_mnesia / 8cf534a |
@leszke that part from TODO https://github.com/esl/MongooseIM/blob/c06428b2d3c6d1b5e3fdd1013f44a0cd1ec216d0/doc/developers-guide/Hooks-and-handlers.md : (mongooseim@localhost)1> gen_mod:is_loaded(<<"localhost">>, mod_hook_example).
false
(mongooseim@localhost)2> gen_mod:start_module(<<"localhost">>, mod_hook_example, [no_opts]).
{ok,ok}
(mongooseim@localhost)3> gen_mod:is_loaded(<<"localhost">>, mod_hook_example).
true
(mongooseim@localhost)4> mongoose_logs:set_module_loglevel(mod_hook_example, info).
ok
(mongooseim@localhost)5> mod_hook_example:run_custom_hook(<<"localhost">>).
when=2020-12-02T10:29:14.875981+00:00 level=error what=first_handler pid=<0.2321.0> at=mod_hook_example:first_handler/2:40 value=5 result=7 argument=2
when=2020-12-02T10:29:14.876248+00:00 level=error what=stopping_handler pid=<0.2321.0> at=mod_hook_example:stopping_handler/2:46 value=7 result=9 argument=2
ok
when=2020-12-02T10:29:14.876453+00:00 level=error what=hook_finished pid=<0.2321.0> at=mod_hook_example:run_custom_hook/1:35 result_acc_{example,value}=9 result_acc_timestamp=1606904954871246 result_acc_stanza=undefined result_acc_ref=#Ref<0.186499973.2771648514.42380> result_acc_origin_stanza=undefined result_acc_origin_pid=<0.2321.0> result_acc_origin_location_mfa={mod_hook_example,run_custom_hook,1} result_acc_origin_location_line=31 result_acc_origin_location_file=/Users/mikhailuvarov/erlang/esl/MongooseIM/src/mod_hook_example.erl result_acc_non_strippable= result_acc_mongoose_acc=true result_acc_lserver=localhost result=9 |
😁 the art of camouflage is strong with this one. It is in the one and only line of this section, under the link to XEP which is actually the link to the PR itself. |
I ran regex through the files and unified the way XEPs are shown, also spotted yet another broken link-that-wasn't-actually-the-link 💪 in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely amazing ❤️
PR is ready and thirsting for your comments.
Includes #2946.
What have I pushed so far, is ready for review. The purpose is to facilitate reviewing process.
I'm also sharing my remarks I got down yesterday. Since it's a drama to comment on GH something that wasn't modified by PR, I'm leaving them this way: