|
| 1 | +--- |
| 2 | +title: Rename or redirect a document |
| 3 | +contentType: page |
| 4 | +template: basicDoc |
| 5 | +topics: |
| 6 | + - New Relic only |
| 7 | + - Tech writer style guide |
| 8 | + - Processes and procedures |
| 9 | +redirects: |
| 10 | + - /docs/new-relic-only/style-guide/processes-procedures/renaming-redirecting-document |
| 11 | + - /docs/new-relic-only/advanced-style-guide/processes-procedures/renaming-redirecting-document |
| 12 | + - /docs/new-relic-only/advanced-style-guide/processes-procedures/rename-redirect-document |
| 13 | +watermark: NR ONLY |
| 14 | +--- |
| 15 | + |
| 16 | +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. |
| 17 | + |
| 18 | +<Callout variant="caution"> |
| 19 | + These procedures are intended for Tech Writer use. 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. |
| 20 | +</Callout> |
| 21 | + |
| 22 | +## URL format [#title-url] |
| 23 | + |
| 24 | +Changing a document's title also affects its URL. The URL is the text of the title, where hyphens `-` replace spaces. Drupal automatically removes ["short words"](/admin/config/search/path/settings) (`the`, `a`, `for`, `via`, etc.) from URL paths. |
| 25 | + |
| 26 | +For example, this is the URL for **Rename or redirect a document**: |
| 27 | + |
| 28 | +``` |
| 29 | +docs/new-relic-only/style-guide/processes-procedures/rename-redirect-document |
| 30 | +``` |
| 31 | + |
| 32 | +## Change titles [#titles] |
| 33 | + |
| 34 | +To change a document title, follow this process carefully to ensure you update the URL and create appropriate redirects: |
| 35 | + |
| 36 | +1. Create a new draft of the doc. |
| 37 | +2. In the **Title** field, edit the document title. |
| 38 | +3. In the **URL path settings** tab, select the **Generate automatic URL alias** checkbox. |
| 39 | +4. In the **Publishing options** tab, summarize your change, then save and publish. |
| 40 | + |
| 41 | +Drupal updates the document title and URL, and creates a redirect from the old URL. To verify that the URL change was successful: |
| 42 | + |
| 43 | +1. Create a new draft of the doc. |
| 44 | +2. In the **URL path settings** tab, ensure the URL has changed to the new URL. |
| 45 | +3. In the **URL redirects** tab, ensure there is a redirect for the old URL. |
| 46 | + |
| 47 | +If you change a file name and path back to one that previously existed, you may see **Disabled** links in the **URL redirects** tab. These can be safely deleted. |
| 48 | + |
| 49 | +## Change anchor links [#anchors] |
| 50 | + |
| 51 | +Wherever possible, do not change the `id=""` of an H2, table row, 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. |
| 52 | + |
| 53 | +If you must change an `id`, try to move the existing one to a nearby piece of content. For example, move an old header ID to the first paragraph of the section: |
| 54 | + |
| 55 | +``` |
| 56 | +<h2 id="new-id">New header with new ID</h2> |
| 57 | +
|
| 58 | +<p id="old-id">First paragraph of section</p> |
| 59 | +``` |
| 60 | + |
| 61 | +## Edit redirects [#redirects] |
| 62 | + |
| 63 | +Use the **URL redirects** tab in the selected doc, or use the Drupal [URL redirects list](/admin/config/search/redirect) (**Menu > Configuration > Search and metadata > URL redirects**) to manage redirect locations. |
| 64 | + |
| 65 | +<CollapserGroup> |
| 66 | + <Collapser |
| 67 | + id="create" |
| 68 | + title="Create a redirect to a doc you're editing" |
| 69 | + > |
| 70 | + To create a redirect to an existing doc: |
| 71 | + |
| 72 | + 1. Go to the doc where you want to add a redirect from another doc, and create a new draft. |
| 73 | + 2. In the **URL redirects** tab, select **Add URL redirect to this content**. |
| 74 | + 3. In the **From** field, specify the path for the doc you want to redirect to this one. |
| 75 | + 4. If you want to redirect to a specific anchor tag, place that anchor after the node URL in the **To** field. For example: `node/27016#install-procedures`. |
| 76 | + 5. Select **Save**. |
| 77 | + |
| 78 | + Drupal creates a redirect, then returns to the draft you were editing. |
| 79 | + |
| 80 | + You do not need to edit the **To** field. Drupal automatically pre-populates it with a permalink to the doc you are currently editing. |
| 81 | + </Collapser> |
| 82 | + |
| 83 | + <Collapser |
| 84 | + id="create-arbitrary" |
| 85 | + title="Create a redirect to an arbitrary location" |
| 86 | + > |
| 87 | + You can also create a redirect to an arbitrary location. For example, `docs.newrelic.com/jira` redirects to `newrelic.atlassian.net/secure/CreateIssue.jspa?pid=13600`. |
| 88 | + |
| 89 | + 1. In Drupal, go to the [URL redirects list](/admin/config/search/redirect) (**Menu > Configuration > Search and metadata > URL redirects**) and select **Add redirect**. |
| 90 | + 2. In the **From** field, specify the relative path that you want to redirect to somewhere else. |
| 91 | + 3. In the **To** field, specify the relative internal path or complete external path where you want the redirect to go. |
| 92 | + 4. Select **Save**. |
| 93 | + |
| 94 | + Drupal creates a redirect, then returns to the redirect list. |
| 95 | + </Collapser> |
| 96 | + |
| 97 | + <Collapser |
| 98 | + id="edit" |
| 99 | + title="Edit a redirect" |
| 100 | + > |
| 101 | + To edit an existing redirect: |
| 102 | + |
| 103 | + 1. From the doc containing the redirect you want to edit, create a new draft. |
| 104 | + |
| 105 | + OR |
| 106 | + |
| 107 | + In Drupal, go to the [URL redirects list](/admin/config/search/redirect) (**Menu > Configuration > Search and metadata > URL redirects**), and filter for the redirect you want to edit. |
| 108 | + 2. In the **Operations** column, select **Edit**. |
| 109 | + 3. Edit the fields, then select **Save**. |
| 110 | + |
| 111 | + Drupal updates the redirect, then returns to the previous page. |
| 112 | + </Collapser> |
| 113 | + |
| 114 | + <Collapser |
| 115 | + id="delete" |
| 116 | + title="Delete a redirect" |
| 117 | + > |
| 118 | + To delete an existing redirect: |
| 119 | + |
| 120 | + 1. From the doc containing the redirect you want to delete, create a new draft. |
| 121 | + |
| 122 | + OR |
| 123 | + |
| 124 | + In Drupal, go to the [URL redirects list](/admin/config/search/redirect) (**Menu > Configuration > Search and metadata > URL redirects**), and filter for the redirect you want to delete. |
| 125 | + 2. In the **Operations** column, select **Delete**. |
| 126 | + 3. Select **Confirm**. |
| 127 | + |
| 128 | + Drupal deletes the redirect, then returns to the previous page. |
| 129 | + </Collapser> |
| 130 | +</CollapserGroup> |
0 commit comments