docs-redirects

Create and manage URL redirects in Elastic documentation via redirects.yml.

71|10|Updated Aug 20, 2025
One-click install
npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-redirects
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-redirects
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/authoring/docs-redirects
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-redirects

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and management of redirects in Elastic documentation, ensuring that users are seamlessly guided to the correct pages when content is moved, renamed, or deleted.

Core Features & Use Cases

  • Create and manage redirects: Define rules in redirects.yml for page movements, renames, or deletions.
  • Handle anchor remapping: Specify how URL anchors should be redirected or stripped.
  • Support cross-repository redirects: Link to content in other Elastic documentation repositories.
  • Update internal links: Assist in finding and updating broken links within the documentation.
  • Use Case: When a documentation page like old-path/page.md is moved to new/path/page.md, this skill ensures that any traffic or links pointing to the old URL are automatically redirected to the new one, preventing broken links and user frustration.

Quick Start

Use the docs-redirects skill to create a redirect for the page 'old-path/page.md' to 'new/path/page.md'.

Frequently Asked Questions about docs-redirects

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create URL redirects when moving documentation pages?

To create URL redirects for moved documentation pages, you define rules in the `redirects.yml` file mapping the old paths to the new destinations. This ensures traffic pointing to old URLs is automatically redirected, preventing broken links.

What is the best way to handle anchor remapping in documentation redirects?

Anchor remapping in documentation redirects is handled by specifying rules in `redirects.yml` that dictate how URL anchors should be redirected or stripped. This ensures specific sections within moved pages remain accessible.

Can I manage cross-repository redirects for documentation content?

Yes, you can manage cross-repository redirects for documentation content. The system supports linking to content across single or multiple Elastic documentation repositories to maintain content discoverability and link integrity.

How do I update internal links after renaming or deleting a documentation page?

You update internal links after renaming or deleting a page by using the skill to assist in finding broken references within the documentation. It updates `redirects.yml` and internal references to maintain link integrity.

Why do I need YAML for documentation link maintenance?

You need YAML for documentation link maintenance because `redirects.yml` serves as the central configuration file where redirect rules for page movements, renames, and deletions are defined. It automates traffic routing to correct pages.