Skip to content

Commit

Permalink
docs: add redirect for common urls
Browse files Browse the repository at this point in the history
  • Loading branch information
psanders committed Feb 28, 2024
1 parent e0adf85 commit 2b07b61
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# How to contribute

To learn how to contribute to this project, please visit our [documentation](https://routr.io/docs/2.0.0/contributing) site.
To learn how to contribute to this project, please visit our [documentation](https://routr.io/docs/contributing) site.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Routr is a lightweight sip proxy, location server, and registrar that provides a
* [Getting started with the CTL](#getting-started-with-the-ctl)
* [First steps with the NodeSDK](#first-steps-with-the-nodesdk)
* [Custom Processors and Middleware](#building-custom-processors-and-middleware)
* [Documentation](https://routr.io)
* [Documentation](https://routr.io/docs)
* [Bugs and feedback](#bugs-and-feedback)
* [Sponsors](#sponsors)
* [Contributing](#contributing)
Expand Down Expand Up @@ -100,7 +100,7 @@ Routr's main features are:
- [ ] Support for STIR/SHAKEN
- [ ] Web Application

To learn more, read the [documentation](https://routr.io) :books:
To learn more, read the [documentation](https://routr.io/docs) :books:

## The official handbook

Expand Down Expand Up @@ -358,7 +358,7 @@ In addition to the previous example, you can check the following modules:
- [Processor Template](https://github.com/fonoster/nodejs-processor/tree/main)
- [Connect Processor](https://github.com/fonoster/routr/tree/main/mods/connect)

For more information about building Processors and Middleware, please refer to the [documentation.](https://routr.io)
For more information about building Processors and Middleware, please refer to the [documentation.](https://routr.io/docs)

## Bugs and feedback

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Depending on the project’s roadmap and priorities, you might also be asked to:

## Development Environment Setup

See our [Development environment setup](https://routr.io/docs/2.0.0/development/introduction) guide to get started locally or using Gitpod.
See our [Development environment setup](https://routr.io/docs/development/introduction) guide to get started locally or using Gitpod.

## Sign your Commits

Expand Down
26 changes: 26 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,32 @@ const config = {
]
],

plugins: [
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
{
to: "/docs/2.0.0/overview/introduction",
from: ["/docs/overview/introduction", "/docs"]
},
{
to: "/docs/2.0.0/contributing",
from: ["/docs/contributing"]
},
{
to: "/docs/2.0.0/community",
from: ["/docs/community"]
},
{
to: "/docs/2.0.0/development/introduction",
from: ["/docs/development/introduction"]
}
]
}
]
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
},
"dependencies": {
"@docusaurus/core": "^3.1.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/plugin-google-gtag": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@mdx-js/react": "^3.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Our vision for a Next-generation SIP Server can be summarized as follows:
* Offer the tooling and APIs for easy extensibility
* Great documentation

If you want to support the initiative, please [join the discussion](https://routr.io/docs/2.0.0/community).
If you want to support the initiative, please [join the discussion](https://routr.io/docs/community).
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Build and Deploy to a DigitalOcean droplet
[![do-btn-blue](https://user-images.githubusercontent.com/51996/58146107-50512580-7c1a-11e9-8ec9-e032ba387c2a.png)](https://github.com/fonoster/routr/tree/master/.digitalocean/README.md)

## Docker
[Deploy with docker compose](https://routr.io/docs/guides/running-with-docker-or-compose/)
[Deploy with docker compose](../guides/running-with-docker-or-compose.md)

[![Docker logo](https://d207aa93qlcgug.cloudfront.net/1.95.5.qa/img/nav/docker-logo-loggedout.png)](https://hub.docker.com/r/fonoster/routr/)

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-1.x.x/introduction/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ The following selection of resources is particularly useful to get started with

## Tutorials

- [Instructions and example a basic setup of Routr](https://routr.io/docs/guides/basic-setup/)
- [Instructions and example a basic setup of Routr](../guides/basic-setup.md)
10 changes: 5 additions & 5 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
<ul class="links">
<li>
<a
href="/docs/2.0.0/overview/introduction"
href="/docs"
target="_blank"
class="focus-outline"
>
Expand All @@ -90,7 +90,7 @@
</li>
<li>
<a
href="/docs/2.0.0/community"
href="/docs/community"
target="_blank"
class="focus-outline"
>
Expand Down Expand Up @@ -230,7 +230,7 @@ <h1 class="h1 title">
integrators.
</p>
<div class="btn-wrap">
<a href="/docs/2.0.0/overview/introduction" class="btn btn-primary">Documentation</a>
<a href="/docs" class="btn btn-primary">Documentation</a>
<a href="https://discord.gg/4QWgSz4hTC" class="btn-arrow">
Join the community
<div class="icon">
Expand All @@ -257,7 +257,7 @@ <h1 class="h1 title">
communication service providers, and integrators.
</p>
<div class="btn-wrap">
<a href="/docs/2.0.0/overview/introduction" class="btn btn-primary">Documentation</a>
<a href="/docs" class="btn btn-primary">Documentation</a>
<a href="https://discord.gg/4QWgSz4hTC" class="btn-arrow">
Join the community
<div class="icon">
Expand Down Expand Up @@ -708,7 +708,7 @@ <h2 class="h2 title">
<p class="accent footer-title">useful links</p>
<ul class="footer-links">
<li>
<a href="/docs/2.0.0/overview/introduction" class="btn-link">Documentation</a>
<a href="/docs" class="btn-link">Documentation</a>
</li>
<li>
<a href="https://github.com/fonoster/routr/issues" class="btn-link">Bug Tracker</a>
Expand Down

0 comments on commit 2b07b61

Please sign in to comment.