Skip to content

Commit

Permalink
Merge pull request rabbitmq#12357 from rabbitmq/fix-non-canonical-links
Browse files Browse the repository at this point in the history
Fix non-canonical and broken links
  • Loading branch information
dumbbell authored Sep 24, 2024
2 parents 474d76f + 5158460 commit 8268a11
Show file tree
Hide file tree
Showing 24 changed files with 103 additions and 106 deletions.
2 changes: 1 addition & 1 deletion deps/rabbit/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ exports_files(glob([
]) + ["INSTALL"])

_APP_ENV = """[
%% See https://www.rabbitmq.com/consumers.html#acknowledgement-timeout
%% See https://www.rabbitmq.com/docs/consumers#acknowledgement-timeout
%% 30 minutes
{consumer_timeout, 1800000},
{tcp_listeners, [5672]},
Expand Down
2 changes: 1 addition & 1 deletion deps/rabbit/INSTALL
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Please see https://www.rabbitmq.com/download.html for installation
Please see https://www.rabbitmq.com/docs/download for installation
guides.
3 changes: 2 additions & 1 deletion deps/rabbit/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ define PROJECT_ENV
%% see rabbitmq-server#248
%% and rabbitmq-server#667
{channel_operation_timeout, 15000},
%% See https://www.rabbitmq.com/consumers.html#acknowledgement-timeout
%% See https://www.rabbitmq.com/docs/consumers#acknowledgement-timeout
%% 30 minutes
{consumer_timeout, 1800000},

Expand Down Expand Up @@ -307,6 +307,7 @@ web-manpages: $(WEB_MANPAGES) $(MD_MANPAGES)
gsub(/class="D1"/, "class=\"D1 lang-bash\"", line); \
gsub(/class="Bd Bd-indent"/, "class=\"Bd Bd-indent lang-bash\"", line); \
gsub(/&#[xX]201[cCdD];/, "\\"", line); \
gsub(/\.html/, "", line); \
print line; \
} } \
' > "$@"
Expand Down
36 changes: 18 additions & 18 deletions deps/rabbit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RabbitMQ Server

[RabbitMQ](https://rabbitmq.com) is a [feature rich](https://rabbitmq.com/documentation.html), multi-protocol messaging broker. It supports:
[RabbitMQ](https://www.rabbitmq.com) is a [feature rich](https://www.rabbitmq.com/docs), multi-protocol messaging broker. It supports:

* AMQP 0-9-1
* AMQP 1.0
Expand All @@ -10,38 +10,38 @@

## Installation

* [Installation guides](https://rabbitmq.com/download.html) for various platforms
* [Kubernetes Cluster Operator](https://www.rabbitmq.com/kubernetes/operator/operator-overview.html)
* [Changelog](https://www.rabbitmq.com/changelog.html)
* [Installation guides](https://www.rabbitmq.com/docs/download) for various platforms
* [Kubernetes Cluster Operator](https://www.rabbitmq.com/kubernetes/operator/operator-overview)
* [Releases](https://github.com/rabbitmq/rabbitmq-server/releases) on GitHub
* [Supported and unsupported series](https://www.rabbitmq.com/versions.html)
* [Supported Erlang versions](https://www.rabbitmq.com/which-erlang.html)
* [Supported and unsupported series](https://www.rabbitmq.com/release-information)
* [Supported Erlang versions](https://www.rabbitmq.com/docs/which-erlang)


## Tutorials & Documentation

* [RabbitMQ tutorials](https://rabbitmq.com/getstarted.html)
* [All documentation guides](https://rabbitmq.com/documentation.html)
* [CLI tools guide](https://rabbitmq.com/cli.html)
* [Configuration guide](https://rabbitmq.com/configure.html)
* [Client libraries and tools](https://rabbitmq.com/devtools.html)
* [Monitoring guide](https://rabbitmq.com/monitoring.html)
* [Production checklist](https://rabbitmq.com/production-checklist.html)
* [RabbitMQ tutorials](https://www.rabbitmq.com/tutorials)
* [All documentation guides](https://www.rabbitmq.com/docs)
* [CLI tools guide](https://www.rabbitmq.com/docs/cli)
* [Configuration guide](https://www.rabbitmq.com/docs/configure)
* [Client libraries and tools](https://www.rabbitmq.com/client-libraries/devtools)
* [Monitoring guide](https://www.rabbitmq.com/docs/monitoring)
* [Production checklist](https://www.rabbitmq.com/docs/production-checklist)
* [Runnable tutorials](https://github.com/rabbitmq/rabbitmq-tutorials/)
* [Documentation source](https://github.com/rabbitmq/rabbitmq-website/)


## Getting Help

* [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users)
* [Commercial support](https://rabbitmq.com/services.html) from [Pivotal](https://pivotal.io) for open source RabbitMQ
* [Community Slack](https://rabbitmq-slack.herokuapp.com/)
* [Commercial support](https://tanzu.vmware.com/rabbitmq/oss) from [Broadcom](https://tanzu.vmware.com) for open source RabbitMQ
* [Community Discord](https://www.rabbitmq.com/discord)
* [Community Slack](https://www.rabbitmq.com/slack)
* `#rabbitmq` on Freenode


## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) and our [development process overview](https://rabbitmq.com/github.html).
See [CONTRIBUTING.md](./CONTRIBUTING.md) and our [development process overview](https://www.rabbitmq.com/github).

Questions about contributing, internals and so on are very welcome on the [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).

Expand All @@ -53,8 +53,8 @@ RabbitMQ server is [licensed under the MPL 2.0](LICENSE-MPL-RabbitMQ).

## Building From Source and Packaging

* [Building RabbitMQ from Source](https://rabbitmq.com/build-server.html)
* [Building RabbitMQ Distribution Packages](https://rabbitmq.com/build-server.html)
* [Building RabbitMQ from Source](https://www.rabbitmq.com/docs/build-server)
* [Building RabbitMQ Distribution Packages](https://www.rabbitmq.com/docs/build-server)


## Copyright
Expand Down
2 changes: 1 addition & 1 deletion deps/rabbit/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Supported Versions

See [RabbitMQ Release Series](https://www.rabbitmq.com/versions.html) for a list of currently supported
See [RabbitMQ Release Series](https://www.rabbitmq.com/release-information) for a list of currently supported
versions.

Vulnerabilities reported for versions out of support will not be investigated.
Expand Down
12 changes: 4 additions & 8 deletions deps/rabbit/docs/README-for-packages
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,24 @@ This is rabbitmq-server, a message broker implementing AMQP 0-9-1, AMQP 1.0,
STOMP and MQTT.

Most of the documentation for RabbitMQ is provided on the RabbitMQ web
site. You can see documentation for the current version at
site. You can see documentation for the current and previous versions at

https://www.rabbitmq.com/documentation.html

and for previous versions at

https://www.rabbitmq.com/previous.html
https://www.rabbitmq.com/docs

Man pages are installed with this package. Of particular interest are
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-queues(8).
They interact with a running node. rabbitmq-plugins(8) is used to manage plugins.
All of these should be run as the superuser. Learn more about
CLI tools at

https://www.rabbitmq.com/cli.html
https://www.rabbitmq.com/docs/cli

An example configuration file is provided in the same directory as
this README. Copy it to /etc/rabbitmq/rabbitmq.conf to use it. The
RabbitMQ server must be restarted after changing the configuration
file. Learn more about configuration at

https://www.rabbitmq.com/configure.html
https://www.rabbitmq.com/docs/configure

An example policy file for HA queues is provided in the same directory
as this README. Copy and chmod +x it to
Expand Down
8 changes: 4 additions & 4 deletions deps/rabbit/docs/advanced.config.example
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
%% ----------------------------------------------------------------------------
%% Advanced Erlang Networking/Clustering Options.
%%
%% See https://www.rabbitmq.com/clustering.html for details
%% See https://www.rabbitmq.com/docs/clustering for details
%% ----------------------------------------------------------------------------
%% Sets the net_kernel tick time.
%% Please see http://erlang.org/doc/man/kernel_app.html and
%% https://www.rabbitmq.com/nettick.html for further details.
%% https://www.rabbitmq.com/docs/nettick for further details.
%%
%% {kernel, [{net_ticktime, 60}]},
%% ----------------------------------------------------------------------------
%% RabbitMQ Shovel Plugin
%%
%% See https://www.rabbitmq.com/shovel.html for details
%% See https://www.rabbitmq.com/docs/shovel for details
%% ----------------------------------------------------------------------------

{rabbitmq_shovel,
Expand Down Expand Up @@ -87,7 +87,7 @@

%% The LDAP plugin can perform a variety of queries against your
%% LDAP server to determine questions of authorisation. See
%% https://www.rabbitmq.com/ldap.html#authorisation for more
%% https://www.rabbitmq.com/docs/ldap#authorisation for more
%% information.

%% Set the query to use when determining vhost access
Expand Down
30 changes: 15 additions & 15 deletions deps/rabbit/docs/rabbitmq-diagnostics.8
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
is a command line tool that provides commands used for diagnostics, monitoring
and health checks of RabbitMQ nodes.
See the
.Lk https://rabbitmq.com/documentation.html "RabbitMQ documentation guides"
.Lk https://www.rabbitmq.com/docs "RabbitMQ documentation guides"
to learn more about RabbitMQ diagnostics, monitoring and health checks.

.Nm
Expand All @@ -40,7 +40,7 @@ health checks are available to be used interactively and by monitoring tools.
By default if it is not possible to connect to and authenticate with the target node
(for example if it is stopped), the operation will fail.
To learn more, see the
.Lk https://rabbitmq.com/monitoring.html "RabbitMQ Monitoring guide"
.Lk https://www.rabbitmq.com/docs/monitoring "RabbitMQ Monitoring guide"
.
.\" ------------------------------------------------------------------
.Sh OPTIONS
Expand Down Expand Up @@ -81,14 +81,14 @@ Default is
.It Fl l , Fl -longnames
Must be specified when the cluster is configured to use long (FQDN) node names.
To learn more, see the
.Lk https://rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
.Lk https://www.rabbitmq.com/docs/clustering "RabbitMQ Clustering guide"
.It Fl -erlang-cookie Ar cookie
Shared secret to use to authenticate to the target node.
Prefer using a local file or the
.Ev RABBITMQ_ERLANG_COOKIE
environment variable instead of specifying this option on the command line.
To learn more, see the
.Lk https://rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
.Lk https://www.rabbitmq.com/docs/cli "RabbitMQ CLI Tools guide"
.El
.\" ------------------------------------------------------------------
.Sh COMMANDS
Expand Down Expand Up @@ -215,7 +215,7 @@ in
Lists resource alarms, if any, in the cluster.
.Pp
See
.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide"
.Lk https://www.rabbitmq.com/docs/alarms "RabbitMQ Resource Alarms guide"
to learn more.
.Pp
Example:
Expand All @@ -236,7 +236,7 @@ Health check that fails (returns with a non-zero code) if there are alarms
in effect on any of the cluster nodes.
.Pp
See
.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide"
.Lk https://www.rabbitmq.com/docs/alarms "RabbitMQ Resource Alarms guide"
to learn more.
.Pp
Example:
Expand Down Expand Up @@ -268,7 +268,7 @@ Health check that fails (returns with a non-zero code) if there are alarms
in effect on the target node.
.Pp
See
.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide"
.Lk https://www.rabbitmq.com/docs/alarms "RabbitMQ Resource Alarms guide"
to learn more.
.Pp
Example:
Expand All @@ -285,7 +285,7 @@ The check only validates if a new TCP connection is accepted. It does not
perform messaging protocol handshake or authenticate.
.Pp
See
.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide"
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
to learn more.
.Pp
Example:
Expand All @@ -299,7 +299,7 @@ is not listening on the specified port (there is no listener that
uses that port).
.Pp
See
.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide"
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
to learn more.
.Pp
Example:
Expand All @@ -312,7 +312,7 @@ Health check that fails (returns with a non-zero code) if the target node
does not have a listener for the specified protocol.
.Pp
See
.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide"
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
to learn more.
.Pp
Example:
Expand Down Expand Up @@ -369,7 +369,7 @@ Example:
Runs a peer discovery on the target node and prints the discovered nodes, if any.
.Pp
See
.Lk https://rabbitmq.com/cluster-formation.html "RabbitMQ Cluster Formation guide"
.Lk https://www.rabbitmq.com/docs/cluster-formation "RabbitMQ Cluster Formation guide"
to learn more.
.Pp
Example:
Expand All @@ -389,7 +389,7 @@ to authenticate CLI tools and peers. The value can be compared with the hash
found in error messages of CLI tools.
.Pp
See
.Lk https://rabbitmq.com/clustering.html#erlang-cookie "RabbitMQ Clustering guide"
.Lk https://www.rabbitmq.com/docs/clustering#erlang-cookie "RabbitMQ Clustering guide"
to learn more.
.Pp
Example:
Expand Down Expand Up @@ -492,7 +492,7 @@ what protocols and ports the node is listening on for client, CLI tool
and peer connections.
.Pp
See
.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide"
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
to learn more.
.Pp
Example:
Expand Down Expand Up @@ -544,7 +544,7 @@ terabytes
.El
.Pp
See
.Lk https://rabbitmq.com/memory-use.html "RabbitMQ Memory Use guide"
.Lk https://www.rabbitmq.com/docs/memory-use "RabbitMQ Memory Use guide"
to learn more.
.Pp
Example:
Expand Down Expand Up @@ -615,7 +615,7 @@ Note that RabbitMQ can be configured to only accept a subset of those
versions, for example, SSLv3 is deactivated by default.
.Pp
See
.Lk https://rabbitmq.com/ssl.html "RabbitMQ TLS guide"
.Lk https://www.rabbitmq.com/docs/ssl "RabbitMQ TLS guide"
to learn more.
.Pp
Example:
Expand Down
8 changes: 4 additions & 4 deletions deps/rabbit/docs/rabbitmq-plugins.8
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.Nm
is a command line tool for managing RabbitMQ plugins.
See the
.Lk https://www.rabbitmq.com/plugins.html "RabbitMQ Plugins guide"
.Lk https://www.rabbitmq.com/docs/plugins "RabbitMQ Plugins guide"
for an overview of RabbitMQ plugins and how they are used.

.Nm
Expand Down Expand Up @@ -65,7 +65,7 @@ can be specified to make
resolve and update plugin state directly (without contacting the node).
Such changes will only have an effect on next node start.
To learn more, see the
.Lk https://www.rabbitmq.com/plugins.html "RabbitMQ Plugins guide"
.Lk https://www.rabbitmq.com/docs/plugins "RabbitMQ Plugins guide"
.
.\" ------------------------------------------------------------------
.Sh OPTIONS
Expand Down Expand Up @@ -106,14 +106,14 @@ Default is
.It Fl l , Fl -longnames
Must be specified when the cluster is configured to use long (FQDN) node names.
To learn more, see the
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
.Lk https://www.rabbitmq.com/docs/clustering "RabbitMQ Clustering guide"
.It Fl -erlang-cookie Ar cookie
Shared secret to use to authenticate to the target node.
Prefer using a local file or the
.Ev RABBITMQ_ERLANG_COOKIE
environment variable instead of specifying this option on the command line.
To learn more, see the
.Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
.Lk https://www.rabbitmq.com/docs/cli "RabbitMQ CLI Tools guide"
.El
.\" ------------------------------------------------------------------
.Sh COMMANDS
Expand Down
8 changes: 4 additions & 4 deletions deps/rabbit/docs/rabbitmq-queues.8
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
is a command line tool that provides commands used to manage queues,
for example, grow, shrink or rebalance replicas of replicated queue types.
See the
.Lk https://www.rabbitmq.com/quorum-queues.html "RabbitMQ quorum queues guide"
.Lk https://www.rabbitmq.com/docs/quorum-queues "RabbitMQ quorum queues guide"
and the general
.Lk https://www.rabbitmq.com/queues.html "RabbitMQ queues guide"
.Lk https://www.rabbitmq.com/docs/queues "RabbitMQ queues guide"
to learn more about queue types in RabbitMQ.
.
.\" ------------------------------------------------------------------
Expand Down Expand Up @@ -73,14 +73,14 @@ Default is
.It Fl l , Fl -longnames
Must be specified when the cluster is configured to use long (FQDN) node names.
To learn more, see the
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
.Lk https://www.rabbitmq.com/docs/clustering "RabbitMQ Clustering guide"
.It Fl -erlang-cookie Ar cookie
Shared secret to use to authenticate to the target node.
Prefer using a local file or the
.Ev RABBITMQ_ERLANG_COOKIE
environment variable instead of specifying this option on the command line.
To learn more, see the
.Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
.Lk https://www.rabbitmq.com/docs/cli "RabbitMQ CLI Tools guide"
.El
.\" ------------------------------------------------------------------
.Sh COMMANDS
Expand Down
Loading

0 comments on commit 8268a11

Please sign in to comment.