Skip to content

Commit

Permalink
Merge pull request #773 from wazo-platform/fix-404-links
Browse files Browse the repository at this point in the history
Fix 404 links

Summary of change
Fix failing tests on this Zuul job: https://zuul.wazo.community/zuul/t/local/build/ff36daa7a36345cd9d702224644fa687

Reviewed-by: wazo-community-zuul[bot]
  • Loading branch information
wazo-community-zuul[bot] authored Nov 20, 2024
2 parents 19edf63 + 9a68a62 commit 2c43c7a
Show file tree
Hide file tree
Showing 16 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion content/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ your skills and wills:

- you can add new features by following [the code contribution guide](/contribute/code) and [the REST API contribution guidelines](/contribute/rest).
- you can provide feedback on the currently developed features by reviewing [active Pull Requests](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr++archived%3Afalse+user%3Awazo-platform).
- you can test the system following [the installation guide](/uc-doc/installation/install-system) and play with [the API](/documentation). Report any issue in [the ticketing system](https://wazo-dev.atlassian.net/).
- you can test the system following [the installation guide](/uc-doc/installation) and play with [the API](/documentation). Report any issue in [the ticketing system](https://wazo-dev.atlassian.net/).
- you can add support for [new physical phones](/uc-doc/contributors/provisioning/developing_plugins).
- you can contribute to this documentation by adding pages or correcting anything in [the wazo-platform.org git repository](https://github.com/wazo-platform/wazo-platform.org).

Expand Down
2 changes: 1 addition & 1 deletion content/contribute/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ After writing your code and checking that it does not break any tests,
you should try it. The "easiest" way to do so is to use a virtual
machine with a working engine. You should avoid testing in a production
environment to avoid outage for you and your users. To install your test
engine follow the [installation](/uc-doc/installation/install-system) documentation.
engine follow the [installation](/uc-doc/installation) documentation.

Now that you have a test engine, you want to try your code on it. Before
starting, I suggest you take a snapshot of your virtual machine to be
Expand Down
20 changes: 10 additions & 10 deletions content/websocketd/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ To use the service, you need to:
encrypted WebSocket connection.
2. authenticate to it by providing a wazo-auth token that has the `websocketd` ACL. If you don't
know how to obtain a wazo-auth token from your Wazo, consult the
[documentation on wazo-auth](https://wazo-platform.org/uc-doc/system/wazo-auth/introduction).
[documentation on wazo-auth](/uc-doc/system/wazo-auth).

For example, if you want to use the service located at `example.org` with the token `some-token-id`,
you would use the URL `wss://example.org/api/websocketd/?token=some-token-id&version=2`.

The [SSL/TLS certificate](https://wazo-platform.org/uc-doc/system/https_certificate) that is used by
The [SSL/TLS certificate](/uc-doc/system/https_certificate) that is used by
the WebSocket server is the same as the one used by the Wazo web interface and the REST APIs. By
default, this is a self-signed certificate, and web browsers will prevent connections from being
successfully established for security reasons. On most web browsers, this can be circumvented by
first visiting the `https://<wazo-ip>/api/websocketd/` URL and adding a security exception. Other solutions to
this problem are described in the
[connection section](https://wazo-platform.org/uc-doc/system/https_certificate).
[connection section](/uc-doc/system/https_certificate).

After a successful connection and authentication to the service, the server will send the following
message:
Expand All @@ -26,16 +26,16 @@ message:

This indicates that the server is ready to accept more commands from the client. Had an error
happened, the server would have closed the connection, possibly with one of the
[service specific WebSocket close code](https://wazo-platform.org/uc-doc/api_sdk/websocket#ws-status-code).
[service specific WebSocket close code](/uc-doc/api_sdk/websocket#ws-status-code).

The message you see is part of the small
[JSON-based protocol](https://wazo-platform.org/uc-doc/api_sdk/websocket#ws-protocol) that is used
[JSON-based protocol](/uc-doc/api_sdk/websocket#ws-protocol) that is used
for the client/server interaction.

To receive events on your WebSocket connection, you need to tell the server which type of events you
are interested in, and then tell it to start sending you these events. For example, if you are
interested in the
["endpoint_status_update" events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#endpoint-status-update),
["endpoint_status_update" events](/uc-doc/api_sdk/message_bus#endpoint-status-update),
you send the following command:

{"op": "subscribe", "data": {"event_name": "endpoint_status_update"}}
Expand Down Expand Up @@ -176,7 +176,7 @@ receives will be logged to the console.
## Reference

The WebSocket service is provided by `wazo-websocketd`, and its behaviour can be configured via its
[configuration files](https://wazo-platform.org/uc-doc/system/configuration_files) located under the
[configuration files](/uc-doc/system/configuration_files) located under the
<span data-role="file">/etc/wazo-websocketd</span> directory. After modifying the configuration
files, you need to restart `wazo-websocketd` with `systemctl restart wazo-websocketd`.

Expand All @@ -195,7 +195,7 @@ either:
service
- use a trusted certificate

See the [Certificates for HTTPS](https://wazo-platform.org/uc-doc/system/https_certificate) section
See the [Certificates for HTTPS](/uc-doc/system/https_certificate) section
for more information on certificate configuration.

### Authentication
Expand Down Expand Up @@ -224,7 +224,7 @@ No authorization check is done at subscription time. Checks are only done when a
by the server. This mean a client can subscribe to an event "foo", but will never receive any of
these events if it does not have the matching ACL.

See the [Events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#bus-events) section for more
See the [Events](/uc-doc/api_sdk/message_bus#bus-events) section for more
information on the required ACL of events which are available by default on Wazo.

### Status Code
Expand Down Expand Up @@ -265,7 +265,7 @@ is a dictionary with an "event_name" key (mandatory). Example:

You can subscribe to any event. The special event name `*` can be used to match all events.

See the [Events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#bus-events) section for more
See the [Events](/uc-doc/api_sdk/message_bus#bus-events) section for more
information on the events which are available by default on Wazo.

The "start" message ask the server to start sending messages from the bus to the client. Example:
Expand Down
2 changes: 1 addition & 1 deletion src/component/install_uc/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import ReactMarkdown from 'react-markdown';
import Layout from '../Layout';

const Page = ({ pageContext: { installUCDoc }}) => (
<Layout section="install" pageTitle="Getting started: Unified Communication" breadcrumbs={[{ link: '/uc-doc/installation/install-system', label: 'Install', active: true }]}>
<Layout section="install" pageTitle="Getting started: Unified Communication" breadcrumbs={[{ link: '/uc-doc/installation', label: 'Install', active: true }]}>
<section id="install" className="about section">
<div className="container">
<ReactMarkdown children={installUCDoc} />
Expand Down
20 changes: 10 additions & 10 deletions website/docs/api/wazo-websocketd/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ To use the service, you need to:
encrypted WebSocket connection.
2. authenticate to it by providing a wazo-auth token that has the `websocketd` ACL. If you don't
know how to obtain a wazo-auth token from your Wazo, consult the
[documentation on wazo-auth](https://wazo-platform.org/uc-doc/system/wazo-auth/introduction).
[documentation on wazo-auth](/uc-doc/system/wazo-auth).

For example, if you want to use the service located at `example.org` with the token `some-token-id`,
you would use the URL `wss://example.org/api/websocketd/?token=some-token-id&version=2`.

The [SSL/TLS certificate](https://wazo-platform.org/uc-doc/system/https_certificate) that is used by
The [SSL/TLS certificate](/uc-doc/system/https_certificate) that is used by
the WebSocket server is the same as the one used by the Wazo web interface and the REST APIs. By
default, this is a self-signed certificate, and web browsers will prevent connections from being
successfully established for security reasons. On most web browsers, this can be circumvented by
first visiting the `https://<wazo-ip>/api/websocketd/` URL and adding a security exception. Other solutions to
this problem are described in the
[connection section](https://wazo-platform.org/uc-doc/system/https_certificate).
[connection section](/uc-doc/system/https_certificate).

After a successful connection and authentication to the service, the server will send the following
message:
Expand All @@ -36,16 +36,16 @@ message:

This indicates that the server is ready to accept more commands from the client. Had an error
happened, the server would have closed the connection, possibly with one of the
[service specific WebSocket close code](https://wazo-platform.org/uc-doc/api_sdk/websocket#ws-status-code).
[service specific WebSocket close code](/uc-doc/api_sdk/websocket#ws-status-code).

The message you see is part of the small
[JSON-based protocol](https://wazo-platform.org/uc-doc/api_sdk/websocket#ws-protocol) that is used
[JSON-based protocol](/uc-doc/api_sdk/websocket#ws-protocol) that is used
for the client/server interaction.

To receive events on your WebSocket connection, you need to tell the server which type of events you
are interested in, and then tell it to start sending you these events. For example, if you are
interested in the
["endpoint_status_update" events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#endpoint-status-update),
["endpoint_status_update" events](/uc-doc/api_sdk/message_bus#endpoint-status-update),
you send the following command:

```json
Expand Down Expand Up @@ -196,7 +196,7 @@ receives will be logged to the console.
## Reference

The WebSocket service is provided by `wazo-websocketd`, and its behaviour can be configured via its
[configuration files](https://wazo-platform.org/uc-doc/system/configuration_files) located under the
[configuration files](/uc-doc/system/configuration_files) located under the
<span data-role="file">/etc/wazo-websocketd</span> directory. After modifying the configuration
files, you need to restart `wazo-websocketd` with `systemctl restart wazo-websocketd`.

Expand All @@ -215,7 +215,7 @@ either:
service
- use a trusted certificate

See the [Certificates for HTTPS](https://wazo-platform.org/uc-doc/system/https_certificate) section
See the [Certificates for HTTPS](/uc-doc/system/https_certificate) section
for more information on certificate configuration.

### Authentication
Expand Down Expand Up @@ -244,7 +244,7 @@ No authorization check is done at subscription time. Checks are only done when a
by the server. This mean a client can subscribe to an event "foo", but will never receive any of
these events if it does not have the matching ACL.

See the [Events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#bus-events) section for more
See the [Events](/uc-doc/api_sdk/message_bus#bus-events) section for more
information on the required ACL of events which are available by default on Wazo.

### Status Code
Expand Down Expand Up @@ -289,7 +289,7 @@ is a dictionary with an "event_name" key (mandatory). Example:

You can subscribe to any event. The special event name `*` can be used to match all events.

See the [Events](https://wazo-platform.org/uc-doc/api_sdk/message_bus#bus-events) section for more
See the [Events](/uc-doc/api_sdk/message_bus#bus-events) section for more
information on the events which are available by default on Wazo.

The "start" message ask the server to start sending messages from the bus to the client. Example:
Expand Down
12 changes: 6 additions & 6 deletions website/uc-doc/administration/contact_directories/phonebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ As a summary, provisioning a new phonebook directory would follow these general
4. Updating the directory profile with the new phonebook source

Steps 3 and 4 should follow
[the general guidelines provided in the general section](/uc-doc/administration/contact_directories/general#configuring-a-new-directory-source),
[the general guidelines provided in the general section](/uc-doc/administration/contact_directories#configuring-a-new-directory-source),
similarly to any contact directory source.

### Creating phonebooks
Expand Down Expand Up @@ -142,20 +142,20 @@ contacts with fields "number", "mobile", "extension", "number_other", "firstname
"email". The actual fields of the contacts depends only what is provided when
[creating or importing contacts](#initializing-phonebooks-with-contacts).

See [general documentation](/uc-doc/administration/contact_directories/general) for more details on
the meaning of the fields.
See [general documentation](/uc-doc/administration/contact_directories) for more details on the
meaning of the fields.

Once such a phonebook source entity is created for the new phonebook, this source must be exposed to
users through a profile resource. See the
[general documentation for more details on the required API flow](/uc-doc/administration/contact_directories/general).
[general documentation for more details on the required API flow](/uc-doc/administration/contact_directories).

## Maintaining phonebooks

### Updating phonebooks

Phonebooks details can be modified using the `/phonebooks` API. Phonebook sources configuration can
be modified using the `/phonebooks/sources` API (see [above](#exposing-a-phonebook-source) and
[general documentation on source configuration](/uc-doc/administration/contact_directories/general)).
[general documentation on source configuration](/uc-doc/administration/contact_directories)).

```bash
curl -i -XPUT -H "Wazo-Tenant: $tenant_uuid" -H "X-Auth-Token: $auth_token" https://localhost/api/dird/backends/phonebook/sources/6818c114-beed-432c-81dd-16b2998823d4 -d'\
Expand Down Expand Up @@ -281,6 +281,6 @@ yielding such a response:

### See also

- [General contact directory documentation](/uc-doc/administration/contact_directories/general)
- [General contact directory documentation](/uc-doc/administration/contact_directories)
- [Phonebook administration API reference](/documentation/api/contact.html#tag/phonebook)
- [Phonebook source API reference](/documentation/api/contact.html#tag/configuration/operation/create_phonebook_source)
2 changes: 1 addition & 1 deletion website/uc-doc/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ All configurations are done via the [`wazo-confd` REST API](/documentation/api/c
{ text: 'SCCP', href: '/uc-doc/administration/sccp' },
{ text: 'Schedules', href: '/uc-doc/administration/schedules' },
{ text: 'Sound Files', href: '/uc-doc/administration/sound_files' },
{ text: 'Users', href: '/uc-doc/administration/users' },
{ text: 'Users', href: '/uc-doc/administration/users/users' },
{ text: 'Voicemails', href: '/uc-doc/administration/voicemails' },
{ text: 'SIP Templates', href: '/uc-doc/administration/sip_templates' },
{ text: 'Call Policy', href: '/uc-doc/administration/call_policy' },
Expand Down
2 changes: 1 addition & 1 deletion website/uc-doc/api_sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ import CardList from '@site/src/components/Card/CardList';
{ text: 'REST API', href: '/uc-doc/api_sdk/rest_api' },
{ text: 'Subroutine', href: '/uc-doc/api_sdk/subroutine' },
{ text: 'Websocket', href: '/uc-doc/api_sdk/websocket' },
{ text: 'Mobile', href: '/uc-doc/api_sdk/mobile' },
{ text: 'Mobile', href: '/uc-doc/api_sdk/mobile_push_notification' },
]}
/>
8 changes: 4 additions & 4 deletions website/uc-doc/api_sdk/rest_api/acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Permissions (ACLs)
---

The tokens delivered by [wazo-auth](/uc-doc/system/wazo-auth/introduction/) have a list of
permissions associated (ACL), that determine which REST resources are authorized for this token.
Each REST resource has an associated required ACL. When you try to access to a REST resource, this
resource requests wazo-auth with your token and the required ACL to validate the access.
The tokens delivered by [wazo-auth](/uc-doc/system/wazo-auth) have a list of permissions associated
(ACL), that determine which REST resources are authorized for this token. Each REST resource has an
associated required ACL. When you try to access to a REST resource, this resource requests wazo-auth
with your token and the required ACL to validate the access.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion website/uc-doc/system/wazo-dird/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Configuration

There are three sources of configuration for wazo-dird:

- the [command line options](/uc-doc/system/wazo-dird/introduction#wazo-dird-usage)
- the [command line options](/uc-doc/system/wazo-dird#wazo-dird-usage)
- the main configuration file
- configuration done using the API

Expand Down
2 changes: 1 addition & 1 deletion website/uc-doc/system/wazo-webhookd/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ service providers APIs (e.g. FCM, APNS).
Note: those subscriptions can not be created manually through the REST API.

For more details on configuring and using push notifications, see
[the push notification page](/uc-doc/api_sdk/mobile/push_notification).
[the push notification page](/uc-doc/api_sdk/mobile_push_notification).

```mermaid
flowchart TB
Expand Down
2 changes: 1 addition & 1 deletion website/uc-doc/upgrade/archives/upgrade_from_wazo_18_03.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ the big gap of versions, there are some corner cases that are not handled automa
- Check there is no custom certificate configured in `/etc/xivo/custom/custom-certificate.yml`.

- If there is a custom certificate configured, follow
[this procedure](https://wazo-platform.org/uc-doc/system/https_certificate#revert-previous-custom-https-certificate-configuration)
[this procedure](/uc-doc/system/https_certificate#revert-previous-custom-https-certificate-configuration)
to remove the custom certificate configuration.

- Check that `wazo-auth-cli` is working properly (a backup/restore may have
Expand Down
4 changes: 2 additions & 2 deletions website/uc-doc/upgrade/archives/upgrade_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ for more information.
### 20.16 {#20-16}

- The `i386` (32 bits) architecture is now deprecated and will be removed in 21.01 from our debian
repository and CI. See [Migrate from i386 to amd64](/uc-doc/upgrade/migrate_i386_to_amd64) for
more information.
repository and CI. See
[Migrate from i386 to amd64](/uc-doc/upgrade/archives/migrate_i386_to_amd64) for more information.
- wazo-auth ACL template feature has been removed. There are no more rendering template that will be
done for ACL. Endpoints and fields have been deprecated. See
[wazo-auth changelog 20.16](https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md#2016)
Expand Down
8 changes: 4 additions & 4 deletions website/uc-doc/upgrade/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ There are 2 options you can pass to wazo-upgrade:
### Upgrading from Wazo 18.03 only

When upgrading from Wazo 18.03, you should follow the specific procedure for
[Upgrading from Wazo 18.03](/uc-doc/upgrade/upgrade_from_wazo_18_03).
[Upgrading from Wazo 18.03](/uc-doc/upgrade/archives/upgrade_from_wazo_18_03).

## Upgrading a cluster {#upgrading-a-cluster}

Here are the steps for upgrading a cluster, i.e. two Wazo with
[high availability](/uc-doc/high_availability/introduction):
[high availability](/uc-doc/high_availability):

1. On the master : deactivate the database replication by commenting the cron in
`/etc/cron.d/xivo-ha-master`
Expand Down Expand Up @@ -83,11 +83,11 @@ Here are the steps for upgrading a cluster, i.e. two Wazo with
## Upgrading to a specific version of Wazo

See our recommendation on
[how to upgrade to a specific version of Wazo](/uc-doc/upgrade/upgrade_specific_version/introduction)
[how to upgrade to a specific version of Wazo](/uc-doc/upgrade/upgrade_specific_version)

## Upgrading from i386 (32 bits) to amd64 (64 bits)

- [Migrate from i386 to amd64](/uc-doc/upgrade/migrate_i386_to_amd64)
- [Migrate from i386 to amd64](/uc-doc/upgrade/archives/migrate_i386_to_amd64)

## Unsupported versions

Expand Down
2 changes: 1 addition & 1 deletion website/uc-doc/upgrade/upgrade_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -750,4 +750,4 @@ for more information.
## Archives
See our [old upgrade notes](/uc-doc/upgrade/old_upgrade_notes)
See our [old upgrade notes](/uc-doc/upgrade/archives/upgrade_notes)
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Other changes from Python 2 to 3 include:
- Removing the `object` inheritance. It is implicit in Python 3.

To see how a provisioning plugin is developed and some examples, you can read the
[guide on developing a plugin](https://wazo-platform.org/uc-doc/contributors/provisioning/developing_plugins).
[guide on developing a plugin](/uc-doc/contributors/provisioning/developing_plugins).

## Replace the plugin used by the affected devices by a newer version

Expand Down

0 comments on commit 2c43c7a

Please sign in to comment.