ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
ScyllaDB Docs ScyllaDB Sphinx Theme Configuration Redirects support

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:

# 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:

    /previous_path/page_a.html:/new_path/page_a.html
    

    Or, to redirect to an external URL:

    /previous_path/page_b.html:https://docs.scylladb.com/
    
PREVIOUS
Markdown support
NEXT
Search support
ScyllaDB Sphinx Theme
  • 1.4
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.3 to 1.4
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page

On this page

  • Redirects support
    • Redirects file
    • File structure
    • Create a redirection
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1