From 19e5f4da085249c37df54fe4bc2905dc5f37d528 Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 2 Dec 2024 15:08:00 +0100 Subject: [PATCH] Update content from ejabberd by running "make clean extract" --- content/README-GIT.md | 29 ++++++++++---------- content/admin/configuration/modules.md | 10 +++++-- content/admin/configuration/toplevel.md | 7 +++-- content/contributing/index.md | 20 +++++++------- content/developer/ejabberd-api/admin-api.md | 6 +++- content/developer/ejabberd-api/admin-tags.md | 4 ++- 6 files changed, 44 insertions(+), 32 deletions(-) diff --git a/content/README-GIT.md b/content/README-GIT.md index 26553018..ad9b9404 100644 --- a/content/README-GIT.md +++ b/content/README-GIT.md @@ -26,7 +26,6 @@

- [ejabberd][im] is an open-source, robust, scalable and extensible realtime platform built using [Erlang/OTP][erlang], that includes [XMPP][xmpp] Server, [MQTT][mqtt] Broker and [SIP][sip] Service. @@ -41,12 +40,16 @@ Installation There are several ways to install ejabberd: - Source code: compile yourself, see [COMPILE](admin/install/source.md) -- Installers: [ProcessOne Download][p1download] and [GitHub Releases][releases] for releases, [GitHub Actions](https://github.com/processone/ejabberd/actions/workflows/installers.yml) for master branch (run/deb/rpm for x64 and arm64) -- `ecs` container image: [Docker Hub][hubecs] and [Github Packages][packagesecs], see [ecs README][docker-ecs-readme] (for x64) -- `ejabberd` container image: [Github Packages][packages] for releases and master branch, see [CONTAINER](CONTAINER.md) (for x64 and arm64) +- Installers: + - [ProcessOne Download Page][p1download] or [GitHub Releases][releases] for releases. + - [GitHub Actions](https://github.com/processone/ejabberd/actions/workflows/installers.yml) for master branch (`run`/`deb`/`rpm` for `x64` and `arm64`) +- Docker Containers: + - `ecs` container image: [Docker Hub][hubecs] and [Github Packages][packagesecs], see [ecs README][docker-ecs-readme] (for `x64`) + - `ejabberd` container image: [Github Packages][packages] for releases and master branch, see [CONTAINER](CONTAINER.md) (for `x64` and `arm64`) - Using your [Operating System package][osp] - Using the [Homebrew][homebrew] package manager +More info can be found in the `Installation` part of [ejabberd Docs](https://docs.ejabberd.im/admin/install/). Documentation ------------- @@ -63,7 +66,6 @@ Once ejabberd is installed, try: ejabberdctl help man ejabberd.yml - Development ----------- @@ -76,6 +78,7 @@ or in your local machine as explained in [Localization][localization]. Documentation for developers is available in [ejabberd docs: Developers][docs-dev]. There are nightly builds of ejabberd, both for `master` branch and for Pull Requests: + - Installers: go to [GitHub Actions: Installers](https://github.com/processone/ejabberd/actions/workflows/installers.yml), open the most recent commit, on the bottom of that commit page, download the `ejabberd-packages.zip` artifact. - `ejabberd` container image: go to [ejabberd Github Packages][packages] @@ -86,7 +89,6 @@ or some other method from [ProcessOne Contact][p1contact]. For commercial offering and support, including [ejabberd Business Edition][p1home] and [Fluux (ejabberd in the Cloud)][fluux], please check [ProcessOne ejabberd page][p1home]. - Community --------- @@ -96,13 +98,11 @@ There are several places to get in touch with other ejabberd developers and admi - [GitHub Discussions][discussions] - [Stack Overflow][stackoverflow] - License ------- -ejabberd is released under the GNU General Public License v2 (see [COPYING](COPYING.md)), -and [ejabberd translations](https://github.com/processone/ejabberd-po/) under MIT License. - +- `ejabberd` is released under the __GNU General Public License v2__ (see [COPYING](COPYING.md)) +- [ejabberd translations](https://github.com/processone/ejabberd-po/) under __MIT License__. [discussions]: https://github.com/processone/ejabberd/discussions [docker-ecs-readme]: https://github.com/processone/docker-ejabberd/tree/master/ecs#readme @@ -119,16 +119,15 @@ and [ejabberd translations](https://github.com/processone/ejabberd-po/) under MI [mqtt]: https://mqtt.org/ [muc]: xmpp:ejabberd@conference.process-one.net [osp]: https://docs.ejabberd.im/admin/install/os-package/ -[p1contact]: https://www.process-one.net/en/company/contact/ -[p1download]: https://www.process-one.net/en/ejabberd/downloads/ -[p1home]: https://www.process-one.net/en/ejabberd/ +[p1contact]: https://www.process-one.net/contact/ +[p1download]: https://www.process-one.net/download/ejabberd/ +[p1home]: https://www.process-one.net/ejabberd/ [packages]: https://github.com/processone/ejabberd/pkgs/container/ejabberd [packagesecs]: https://github.com/processone/docker-ejabberd/pkgs/container/ecs [releases]: https://github.com/processone/ejabberd/releases [sip]: https://en.wikipedia.org/wiki/Session_Initiation_Protocol [stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest [weblate]: https://hosted.weblate.org/projects/ejabberd/ejabberd-po/ -[xeps]: https://www.process-one.net/en/ejabberd/protocols/ +[xeps]: https://www.process-one.net/ejabberd-features/ [xmpp]: https://xmpp.org/ [xmppej]: https://xmpp.org/software/servers/ejabberd/ - diff --git a/content/admin/configuration/modules.md b/content/admin/configuration/modules.md index 38a69b66..d3e19da1 100644 --- a/content/admin/configuration/modules.md +++ b/content/admin/configuration/modules.md @@ -5,8 +5,11 @@ search: # Modules Options -> This section describes modules options of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The modules -that changed in this version are marked with 🟤. +!!! info "Please note" + + This section describes modules options of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). + + The modules that changed in this version are marked with 🟤. mod\_adhoc ---------- @@ -1192,7 +1195,8 @@ mod\_matrix\_gw -[Matrix](https://matrix.org/) gateway. +[Matrix](https://matrix.org/) gateway. Erlang/OTP 25 or higher is +required to use this module. __Available options:__ diff --git a/content/admin/configuration/toplevel.md b/content/admin/configuration/toplevel.md index 8a70d227..df614a97 100644 --- a/content/admin/configuration/toplevel.md +++ b/content/admin/configuration/toplevel.md @@ -5,8 +5,11 @@ search: # Top-Level Options -> This section describes top level options of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The options -that changed in this version are marked with 🟤. +!!! info "Please note" + + This section describes top level options of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). + + The options that changed in this version are marked with 🟤. ## access\_rules diff --git a/content/contributing/index.md b/content/contributing/index.md index 72619891..a5d4beda 100644 --- a/content/contributing/index.md +++ b/content/contributing/index.md @@ -25,18 +25,18 @@ support platforms, the best being [Stack Overflow][stackoverflow]. Stack Overflow is a much better place to ask questions since: -- there are thousands of people willing to help on Stack Overflow -- questions and answers stay available for public viewing so your question / answer might help +* there are thousands of people willing to help on Stack Overflow +* questions and answers stay available for public viewing so your question / answer might help someone else -- Stack Overflow's voting system assures that the best answers are prominently visible. +* Stack Overflow's voting system assures that the best answers are prominently visible. To save your and our time, we will systematically close all issues that are requests for general support and redirect people to the section you are reading right now. Other channels for support are: -- ejabberd XMPP room: [ejabberd@conference.process-one.net][muc] -- [ejabberd XMPP room logs][logs] -- [ejabberd Mailing List][list] + +* ejabberd XMPP room: [ejabberd@conference.process-one.net][muc] +* [ejabberd Mailing List][list] ### Found an Issue or Bug? @@ -80,6 +80,7 @@ Before you submit your pull request consider the following guidelines: ```shell git checkout -b my-fix-branch master ``` + * Test your changes and, if relevant, expand the automated test suite. * Create your patch commit, including appropriate test cases. * If the changes affect public APIs, change or add relevant [documentation][doc-repo]. @@ -88,6 +89,7 @@ Before you submit your pull request consider the following guidelines: ```shell git commit -a ``` + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. * Push your branch to GitHub: @@ -128,22 +130,20 @@ That's it! Thank you for your contribution! Upon submitting a Pull Request, we will ask you to sign our CLA if you haven't done so before. It's a quick process, we promise, and you will be able to do it all online -You can read [ProcessOne Contribution License Agreement][cla] in PDF. +Here's a link to the [ProcessOne Contribution License Agreement][cla]. This is part of the legal framework of the open-source ecosystem that adds some red tape, but protects both the contributor and the company / foundation behind the project. It also gives us the option to relicense the code with a more permissive license in the future. - [coc]: https://github.com/processone/ejabberd/blob/master/CODE_OF_CONDUCT.md [stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest [list]: https://lists.jabber.ru/mailman/listinfo/ejabberd [muc]: xmpp:ejabberd@conference.process-one.net -[logs]: https://process-one.net/logs/ejabberd@conference.process-one.net/ [github]: https://github.com/processone/ejabberd [github-issues]: https://github.com/processone/ejabberd/issues [github-new-issue]: https://github.com/processone/ejabberd/issues/new [github-pr]: https://github.com/processone/ejabberd/pulls [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 +[cla]: https://cla.process-one.net/ diff --git a/content/developer/ejabberd-api/admin-api.md b/content/developer/ejabberd-api/admin-api.md index 4933655b..5f1882dd 100644 --- a/content/developer/ejabberd-api/admin-api.md +++ b/content/developer/ejabberd-api/admin-api.md @@ -5,7 +5,11 @@ search: # API Reference -> This section describes API commands of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). The commands that changed in this version are marked with 🟤. +!!! info "Please note" + + This section describes API commands of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). + + The commands that changed in this version are marked with 🟤 diff --git a/content/developer/ejabberd-api/admin-tags.md b/content/developer/ejabberd-api/admin-tags.md index 86745b0b..f9c95327 100644 --- a/content/developer/ejabberd-api/admin-tags.md +++ b/content/developer/ejabberd-api/admin-tags.md @@ -1,6 +1,8 @@ # API Tags -> This section enumerates the API tags of ejabberd [24.10](../../archive/24.10/index.md). If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md). +!!! info "Please note" + + This section enumerates the API tags of ejabberd [24.10](../../archive/24.10/index.md).35. If you are using an old ejabberd release, please refer to the corresponding archived version of this page in the [Archive](../../archive/index.md).