docs: fix broken links and anchors

fonoster · Feb 28, 2024 · e0adf85 · e0adf85
1 parent 0aeb3d2
commit e0adf85
Show file tree

Hide file tree

Showing 25 changed files with 27 additions and 26 deletions.
diff --git a/docs/docs/connect/command-line/overview.md b/docs/docs/connect/command-line/overview.md
@@ -8,6 +8,6 @@ To install Routr with npm, you will need to run the following command:
 npm install --location=global @routr/ctl
 ```
 
-Most commands follow a CRUD pattern. For example, to manage your Agents you can use create, delete, describe, and get. Also, most commands follow the {substantive} {verb} pattern. For example, "rctl agents get" will return a list of agents.
+Most commands follow a CRUD pattern. For example, to manage your Agents you can use create, delete, describe, and get. Also, most commands follow the \{substantive\} \{verb\} pattern. For example, "rctl agents get" will return a list of agents.
 
 Please see the following sections for more information on each command.
diff --git a/docs/docs/connect/nodesdk/sdk.md b/docs/docs/connect/nodesdk/sdk.md
@@ -1,7 +1,7 @@
 # SDK
 
 <!-- toc -->
-* [Installation](#installation)
+* [Installation](./sdk.md#installation)
 * [APIs](#apis)
 <!-- tocstop -->
 # Installation

diff --git a/docs/docs/connect/quick-start/kubernetes.md b/docs/docs/connect/quick-start/kubernetes.md
@@ -37,4 +37,4 @@ You should see a list of pods and their status. If the status is Running, then y
 
 For more details, please refer to the chart's [README](https:/fonoster/routr/blob/main/ops/charts/connect/README.md).
 
-Please see the [Command-Line Tools](/docs/cli) section for detauls on how to interact with Routr Connect via the CLI.
+Please see the [Command-Line Tools](../command-line/overview.md) section for detauls on how to interact with Routr Connect via the CLI.
diff --git a/docs/docs/development/building-a-processor.md b/docs/docs/development/building-a-processor.md
@@ -1,6 +1,6 @@
 # Building a Processor
 
-Processors are how we extend the signaling functionality of Routr. Processors are where we can add new SIP headers, modify existing ones, add endpoints to the Location Service, etc. Processors are implemented as gRPC services and use the [Alterations API](/docs/overview/concepts#alterations) to modify SIP messages. A Processor is the last stop for a SIP message before it is sent out to the network.
+Processors are how we extend the signaling functionality of Routr. Processors are where we can add new SIP headers, modify existing ones, add endpoints to the Location Service, etc. Processors are implemented as gRPC services and use the [Alterations API](../overview/concepts.md#alterations) to modify SIP messages. A Processor is the last stop for a SIP message before it is sent out to the network.
 
 Here is a non-exhaustive list of things you can do with a Processor:
 

diff --git a/docs/docs/development/components/apiserver.md b/docs/docs/development/components/apiserver.md
@@ -26,7 +26,7 @@ The `pgdata` has the following environment variables available for configuration
 - `ENFORCE_E164` - Enables E164 validation for Numbers. Default to `false`
 - `ENFORCE_E164_WITH_MOBILE_PREFIX` - Enables E164 validation for Numbers with mobile prefixes. Default to `false`
 
-For details about connecting to the `pgdata` to manage the data, see the [CTL](../ctl/README.md) and [SDK](../sdk/README.md) documentation.
+For details about connecting to the `pgdata` to manage the data, see the [CTL](../../connect/command-line/overview.md) and [SDK](../../connect//nodesdk/overview.md) documentation.
 
 **simpledata**
 

diff --git a/docs/docs/development/custom-data-with-the-apiserver.md b/docs/docs/development/custom-data-with-the-apiserver.md
@@ -32,7 +32,7 @@ agents.createAgent(request)
  .catch(console.error); // an error occurred
 ```
 
-For additional examples of how to store custom data, see the [Node SDK](/docs/2.0.0/connect/nodesdk/sdk) and search for "extended."
+For additional examples of how to store custom data, see the [Node SDK](../connect/nodesdk/overview.md) and search for "extended."
 
 ## How to retrieve custom data
 

diff --git a/docs/docs/development/extending-the-ctl.md b/docs/docs/development/extending-the-ctl.md
@@ -60,4 +60,4 @@ rctl plugins install mycommand
 
 To see your new command in action, you run the command with the `--help` flag and follow the instructions.
 
-With this example, you see how straightforward it is to create a new command. You can use the same pattern to create commands for Routr Connect and even utilize the [Node.js SDK](/docs/2.0.0/connect/nodesdk/sdk) to interact with the server.
+With this example, you see how straightforward it is to create a new command. You can use the same pattern to create commands for Routr Connect and even utilize the [Node.js SDK](../connect/nodesdk/overview.md) to interact with the server.
diff --git a/docs/docs/development/introduction.md b/docs/docs/development/introduction.md
@@ -17,7 +17,7 @@ The only requirements to build and run Routr are Java and NodeJS. However, we re
 - [Helm](https://helm.sh/): Helm helps us to deploy Routr in Kubernetes
 - [Kubernetes](https://kubernetes.io/): Kubernetes is the platform where we deploy Routr for large scale deployments
 - [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/): Kubectl is the command-line tool for Kubernetes
-- [sngrep](link): A tool for monitoring SIP traffic (You could use Wireshark as well)
-- [grpcurl](link): A command-line tool for interacting with gRPC servers
+- [sngrep](https:/irontec/sngrep): A tool for monitoring SIP traffic (You could use Wireshark as well)
+- [grpcurl](https:/fullstorydev/grpcurl): A command-line tool for interacting with gRPC servers
 
 If you don't have a Kubernetes cluster, you can use [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or Docker Desktop with Kubernetes enabled.
diff --git a/docs/docs/overview/concepts.md b/docs/docs/overview/concepts.md
@@ -155,7 +155,7 @@ Processors and Middlewares differ in that you execute Middlewares in a chain, ma
 
 ## Processors
 
-Processors are a way to extend the functionality of Routr, and implementors can add custom logic to the system. Processors are implemented as a gRPC service and use the [Alterations API](/docs/overview/concepts#alterations) to modify SIP messages.
+Processors are a way to extend the functionality of Routr, and implementors can add custom logic to the system. Processors are implemented as a gRPC service and use the [Alterations API](#alterations) to modify SIP messages.
 
 The simplest possible Processor is the "Echo Processor," which returns the SIP Message to the EdgePort. The following example shows how to create an Echo Processor using Node.js.
 

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -39,6 +39,7 @@ const config = {
 
  onBrokenLinks: "warn",
  onBrokenMarkdownLinks: "warn",
+ onBrokenAnchors: "ignore",
 
  // Even if you don't use internalization, you can use this field to set useful
  // metadata like html lang. For example, if your site is Chinese, you may want

diff --git a/docs/versioned_docs/version-1.x.x/api/agents/create.md b/docs/versioned_docs/version-1.x.x/api/agents/create.md
@@ -17,7 +17,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing an [Agent](/configuration/agents) resource in `json` format.
+A file containing an [Agent](../../configuration/agents.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/agents/update.md b/docs/versioned_docs/version-1.x.x/api/agents/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing an [Agent](/api/configuration/agents) resource in `json` format.
+A file containing an [Agent](../../configuration/agents.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/config/update.md b/docs/versioned_docs/version-1.x.x/api/config/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing the [servers' configuration](/api/config/general) in `json` format.
+A file containing the [servers' configuration](../../configuration/general.md) in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/domains/create.md b/docs/versioned_docs/version-1.x.x/api/domains/create.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Domain](/docs/configuration/domains) resource in `json` format.
+A file containing a [Domain](../../configuration/domains.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/domains/update.md b/docs/versioned_docs/version-1.x.x/api/domains/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Domain](/docs/configuration/domains) resource in `json` format.
+A file containing a [Domain](../../configuration/domains.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/gateways/create.md b/docs/versioned_docs/version-1.x.x/api/gateways/create.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Gateway](/configuration/gateways) resource in `json` format.
+A file containing a [Gateway](../../configuration/gateways.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/gateways/update.md b/docs/versioned_docs/version-1.x.x/api/gateways/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Gateway](/configuration/gateways) resource in `json` format.
+A file containing a [Gateway](../../configuration/gateways.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/numbers/create.md b/docs/versioned_docs/version-1.x.x/api/numbers/create.md
@@ -17,7 +17,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Number](/configuration/numbers) resource in `json` format.
+A file containing a [Number](../../configuration/numbers.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/numbers/update.md b/docs/versioned_docs/version-1.x.x/api/numbers/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Number](/configuration/numbers) resource in `json` format.
+A file containing a [Number](../../configuration/numbers.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/overview.md b/docs/versioned_docs/version-1.x.x/api/overview.md
@@ -6,7 +6,7 @@ The endpoint for the API is:
 
 ## Authentication
 
-A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/token` endpoint with basic authentication. Use the information from the [User](/configuration/user) resource.
+A JWT token is used to authenticate the server. To obtain the token, use the `/api/{apiversion}/token` endpoint with basic authentication. Use the information from the [User](../configuration/users.md) resource.
 
 > You must append the `token` to all requests as a query parameter.
 

diff --git a/docs/versioned_docs/version-1.x.x/api/peers/create.md b/docs/versioned_docs/version-1.x.x/api/peers/create.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Peer](/configuration/peers) resource in `json` format.
+A file containing a [Peer](../../configuration/peers.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/api/peers/update.md b/docs/versioned_docs/version-1.x.x/api/peers/update.md
@@ -16,7 +16,7 @@ This method does not receive any parameters.
 
 **Request body**
 
-A file containing a [Peer](/configuration/peers) resource in `json` format.
+A file containing a [Peer](../../configuration/peers.md) resource in `json` format.
 
 **Response**
 

diff --git a/docs/versioned_docs/version-1.x.x/guides/basic-setup.md b/docs/versioned_docs/version-1.x.x/guides/basic-setup.md
@@ -12,7 +12,7 @@ This document is a step-by-step guide on VoIP setup at home or the office. For c
  - [Creating the Agents](#creating-the-agents)
 - [Configuring the SIP devices](#configuring-the-sip-devices)
 - [Making calls](#making-calls)
-- [What's Next](whats-next)
+- [What's Next](#whats-next)
 
 ## Requirements
 

diff --git a/docs/versioned_docs/version-1.x.x/introduction/faq.md b/docs/versioned_docs/version-1.x.x/introduction/faq.md
@@ -2,7 +2,7 @@
 
 ### What is Routr?
 
-Routr is an open-source SIP Server and tooling to deploy VoIP networks. See the [overview](/docs/introduction/overview).
+Routr is an open-source SIP Server and tooling to deploy VoIP networks. See the [overview](../introduction/overview.md).
 
 ### What dependencies does Routr have?
 
@@ -11,7 +11,7 @@ you might need to use Redis depending in the complexity of your requirements.
 
 ### How does Routr compare with other SIP servers
 
-See the [comparison page](/docs/introduction/comparison).
+See the [comparison page](../introduction/comparison.md).
 
 ### What language is used to develop Routr?
 

diff --git a/docs/versioned_docs/version-1.x.x/introduction/performance-tests/user-location.md b/docs/versioned_docs/version-1.x.x/introduction/performance-tests/user-location.md
@@ -25,7 +25,7 @@ was deactivated. The network configuration used during the test is depicted in t
 
 ### Software
 
-As load generator (UAC side) it was used [SIPp docker](URL) image.
+As load generator (UAC side) it was used SIPp.
 
 All used SIP-related software was configured to use TCP as the transport protocol for SIP.