# Redirects support

With ScyllaDB Sphinx Theme, you can define 301 redirects when moving or deleting a document.

By doing so, you will avoid broken links in other sites pointing to your documentation.

## Redirects file

The `redirects.yaml` file is inside `docs/_utils`.

## File structure

The redirects file has this structure:

```none
# old_path: new_path

# redirection to internal link
/previous_path/page_a.html:/new_path/page_a.html

# redirection to external link
/previous_path/page_b:https://docs.scylladb.com/
```

#### NOTE
Do not add trailing paths `/` to define old paths.

## Create a redirection

To create a redirection:

1. Create a file `redirects.yaml` in `docs/_utils` if it does not exist.
2. Add a new entry to the YAML file, assigning the old path in the left site operator and the new path on the right side.
   > For example, to redirect to another internal page:
   > ```none
   > /previous_path/page_a.html:/new_path/page_a.html
   > ```

   > Or, to redirect to an external URL:
   > ```none
   > /previous_path/page_b.html:https://docs.scylladb.com/
   > ```