From 0def333550a140ddb5a43e1a861c2a79d0d4b48e Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 14 Feb 2023 16:12:18 +0100 Subject: [PATCH] Fix Remark-lint warnings --- .github/ISSUE_TEMPLATE/bug_report.md | 3 +-- .github/ISSUE_TEMPLATE/feature_request.md | 9 ++++++--- CHANGELOG.md | 6 +++--- CODE_OF_CONDUCT.md | 2 +- COMPILE.md | 22 +++++++++++----------- CONTRIBUTING.md | 5 ++--- README.md | 5 ++--- 7 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9b0b529e5..d984ed09d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,8 +6,7 @@ assignees: '' --- -Before creating a ticket, please consider if this should fit the discussion forum better: -https://github.com/processone/ejabberd/discussions +Before creating a ticket, please consider if this should fit the [discussion forum](https://github.com/processone/ejabberd/discussions) better. ## Environment diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2bca321a2..0ac588c37 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,17 +7,20 @@ assignees: '' --- -Before creating a ticket, please consider if this should fit the discussion forum better: -https://github.com/processone/ejabberd/discussions +Before creating a ticket, please consider if this should fit the [discussion forum](https://github.com/processone/ejabberd/discussions) better. **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +A clear and concise description of what the problem is. Ex. I'm always frustrated when... **Describe the solution you'd like** + A clear and concise description of what you want to happen. **Describe alternatives you've considered** + A clear and concise description of any alternative solutions or features you've considered. **Additional context** + Add any other context or screenshots about the feature request here. diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bad89f4b..6e1aabd65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -486,7 +486,7 @@ Translations: changed to logging disabled - Increase default shaper limits (this should help with delays for clients that are using jingle) -- Fix couple compatibility problems which prevented working on +- Fix couple compatibility problems which prevented working on erlang R19 - Fix sending presence unavailable when session terminates for clients that only send directed presences (helps with sometimes @@ -501,7 +501,7 @@ Translations: - Add support of ssl connection when connection to mysql database (configured with `sql_ssl: true` option) - Experimental support for cockroachdb when configured - with postgres connector + with postgres connector - Add cache and optimize queries issued by `mod_shared_roster`, this should greatly improve performance of this module when used with `sql` backend @@ -798,6 +798,6 @@ Translations: # Version 18.12 * MAM data store compression -* Proxy protocol support (http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) +* Proxy protocol support * MUC Self-Ping optimization (XEP-0410) * Bookmarks conversion (XEP-0411) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d3b197910..a9145ba2f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at conduct@process-one.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at the email address: conduct AT process-one.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/COMPILE.md b/COMPILE.md index 5bcfaa581..34709ea2f 100644 --- a/COMPILE.md +++ b/COMPILE.md @@ -15,20 +15,20 @@ Requirements To compile ejabberd you need: - - GNU Make - - GCC - - Libexpat ≥ 1.95 - - Libyaml ≥ 0.1.4 - - Erlang/OTP ≥ 19.3 - - OpenSSL ≥ 1.0.0 +- GNU Make +- GCC +- Libexpat ≥ 1.95 +- Libyaml ≥ 0.1.4 +- Erlang/OTP ≥ 19.3 +- OpenSSL ≥ 1.0.0 Other optional libraries are: - - Zlib ≥ 1.2.3, for Stream Compression support (XEP-0138) - - PAM library, for Pluggable Authentication Modules (PAM) - - ImageMagick's Convert program and Ghostscript fonts, for CAPTCHA - challenges - - Elixir ≥ 1.10.3, to support Elixir, and alternative to rebar/rebar3 +- Zlib ≥ 1.2.3, for Stream Compression support (XEP-0138) +- PAM library, for Pluggable Authentication Modules (PAM) +- ImageMagick's Convert program and Ghostscript fonts, for CAPTCHA + challenges +- Elixir ≥ 1.10.3, to support Elixir, and alternative to rebar/rebar3 If your system splits packages in libraries and development headers, install the development packages too. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 136ef3077..a0048c4b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,9 +34,9 @@ To save your and our time, we will systematically close all issues that are requ support and redirect people to the section you are reading right now. Other channels for support are: -- [ejabberd Mailing List][list] -- [ejabberd XMPP room][muc]: ejabberd@conference.process-one.net +- ejabberd XMPP room: [ejabberd@conference.process-one.net][muc] - [ejabberd XMPP room logs][logs] +- [ejabberd Mailing List][list] ### Found an Issue or Bug? @@ -147,4 +147,3 @@ gives us the option to relicense the code with a more permissive license in the [doc-repo]: https://github.com/processone/docs.ejabberd.im [developer-setup]: https://docs.ejabberd.im/developer/ [cla]: https://www.process-one.net/resources/ejabberd-cla.pdf -[license]: https://github.com/processone/ejabberd/blob/master/COPYING diff --git a/README.md b/README.md index 026959eb2..8faa5d78b 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ or in your local machine as explained in [Localization][localization]. Documentation for developers is available in [ejabberd docs: Developers][docs-dev]. Security reports or concerns should preferably be reported privately, -please send an email to the address: contact [at] process-one [dot] net +please send an email to the address: contact at process-one dot net or some other method from [ProcessOne Contact][p1contact]. For commercial offering and support, including [ejabberd Business Edition][p1home] @@ -85,7 +85,7 @@ Community There are several places to get in touch with other ejabberd developers and administrators: -- [ejabberd XMPP chatroom][muc]: ejabberd@conference.process-one.net +- ejabberd XMPP chatroom: [ejabberd@conference.process-one.net][muc] - [Mailing list][list] - [GitHub Discussions][discussions] - [Stack Overflow][stackoverflow] @@ -105,7 +105,6 @@ and [ejabberd translations](https://github.com/processone/ejabberd-po/) under MI [erlang]: https://www.erlang.org/ [features]: https://docs.ejabberd.im/admin/introduction/ [fluux]: https://fluux.io/ -[github]: https://github.com/processone/ejabberd [homebrew]: https://docs.ejabberd.im/admin/installation/#homebrew [hubecs]: https://hub.docker.com/r/ejabberd/ecs/ [im]: https://ejabberd.im/