From af97211ecc62298adebd48e6253704fcea6872f4 Mon Sep 17 00:00:00 2001 From: Metalhearf <6446231+Metalhearf@users.noreply.github.com> Date: Thu, 31 Oct 2024 17:30:20 +0100 Subject: [PATCH] Update URLs in docs/conf files for consistency. --- COMPILE.md | 2 +- CONTRIBUTING.md | 20 ++++++++++---------- README.md | 29 ++++++++++++++--------------- ejabberd.doap | 2 +- mix.exs | 4 ++-- src/ejabberd_config.erl | 2 +- test/suite.hrl | 2 +- tools/generate-doap.sh | 2 +- 8 files changed, 31 insertions(+), 32 deletions(-) diff --git a/COMPILE.md b/COMPILE.md index 0313d0b87..67277051c 100644 --- a/COMPILE.md +++ b/COMPILE.md @@ -44,7 +44,7 @@ There are several ways to obtain the ejabberd source code: - Source code package from [ejabberd GitHub Releases][ghr] - Latest development code from [ejabberd Git repository][gitrepo] -[p1dl]: https://www.process-one.net/en/ejabberd/downloads/ +[p1dl]: https://www.process-one.net/download/ejabberd/ [ghr]: https://github.com/processone/ejabberd/releases [gitrepo]: https://github.com/processone/ejabberd diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72619891b..a5d4beda8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.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/README.md b/README.md index b307277ac..f4b21468d 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,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. @@ -39,12 +38,16 @@ Installation There are several ways to install ejabberd: - Source code: compile yourself, see [COMPILE](COMPILE.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 ------------- @@ -61,7 +64,6 @@ Once ejabberd is installed, try: ejabberdctl help man ejabberd.yml - Development ----------- @@ -74,6 +76,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] @@ -84,7 +87,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 --------- @@ -94,13 +96,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)), -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)) +- [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 @@ -117,16 +117,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/ejabberd.doap b/ejabberd.doap index 180b0ec00..afc28a22a 100644 --- a/ejabberd.doap +++ b/ejabberd.doap @@ -19,7 +19,7 @@ - + diff --git a/mix.exs b/mix.exs index 1d34c1098..6bb5936d7 100644 --- a/mix.exs +++ b/mix.exs @@ -212,9 +212,9 @@ defmodule Ejabberd.MixProject do maintainers: ["ProcessOne"], licenses: ["GPL-2.0-or-later"], links: %{"ejabberd.im" => "https://www.ejabberd.im", - "ejabberd Docs" => "http://docs.ejabberd.im", + "ejabberd Docs" => "https://docs.ejabberd.im", "GitHub" => "https://github.com/processone/ejabberd", - "ProcessOne" => "http://www.process-one.net/"}] + "ProcessOne" => "https://www.process-one.net/"}] end defp vars do diff --git a/src/ejabberd_config.erl b/src/ejabberd_config.erl index bd9480513..3a77c2720 100644 --- a/src/ejabberd_config.erl +++ b/src/ejabberd_config.erl @@ -206,7 +206,7 @@ get_lang(Host) -> -spec get_uri() -> binary(). get_uri() -> - <<"http://www.process-one.net/en/ejabberd/">>. + <<"https://www.process-one.net/ejabberd/">>. -spec get_copyright() -> binary(). get_copyright() -> diff --git a/test/suite.hrl b/test/suite.hrl index d8ea3e23b..08bb87df1 100644 --- a/test/suite.hrl +++ b/test/suite.hrl @@ -9,7 +9,7 @@ -define(PUBSUB(Node), <<(?NS_PUBSUB)/binary, "#", Node>>). --define(EJABBERD_CT_URI, <<"http://www.process-one.net/en/ejabberd_ct/">>). +-define(EJABBERD_CT_URI, <<"https://docs.ejabberd.im/developer/extending-ejabberd/testing/">>). -define(recv1(P1), P1 = (fun() -> diff --git a/tools/generate-doap.sh b/tools/generate-doap.sh index 57241fef5..2892aa969 100755 --- a/tools/generate-doap.sh +++ b/tools/generate-doap.sh @@ -45,7 +45,7 @@ write_doap_head() - +