This document describes how to change the title of a document and how to create, edit, and delete redirects. Procedures are the same for both standard docs ("basic pages") and release notes.
Changing titles or updating redirects can create issues with finding content. If you need to change a title or a redirect, create a GitHub issue or, if you're a New Relic employee, contact the Docs hero via the #documentation Slack channel.
A document's URL is based on its filename and filepath in the GitHub repository.
For example, this is the filename and path for Rename or redirect a document:
The URL is:
If you rename a document's filename or change its path by moving it to a new directory, make sure to add a redirect to its old filepath.
To change the document's location in the left navigation, update the navigation configuration file.
To change a document title, change the title being used in the
title field in the frontmatter at the top of the doc.
If you want to update the title in the left navigation, edit the
yml file for the section that you're in. For example, the Style guide docs use
Wherever possible, do not change the
[#anchor_ids] of an H2 or collapser. There is no way to redirect from a deleted anchor to its new value. Even if the anchor
id is outdated, this does not affect the majority of users who pay no attention to URLs.
If you change the URL of a doc, make sure you add the old URL to the
redirects frontmatter section at the top of the doc.