Skip to content

Commit 38daebf

Browse files
authored
Update remove-doc.md (#5311)
* Update remove-doc.md * Update docs/contributing/remove-doc.md * Update docs/contributing/remove-doc.md
1 parent aa82b0c commit 38daebf

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/contributing/remove-doc.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
id: remove-doc
3-
title: Remove a Doc
4-
description: Learn how to properly remove a Sumo Logic doc.
3+
title: Move or Remove a Doc
4+
description: Learn how to properly move or remove a Sumo Logic doc.
55
---
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

9-
When you delete a doc, its URL is also deleted. Visiting the old URL will return a `404 - Page Not Found` error, which negatively impacts customer experience and can damage our SEO.
9+
When you move a doc or remove it altogether, that deletes its URL. Visiting the old URL will return a `404 - Page Not Found` error, which negatively impacts customer experience and can damage our SEO.
1010

1111
To prevent this, create a 301 redirect. Follow these steps to ensure a smooth transition and maintain the health of our docs site.
1212

@@ -31,11 +31,12 @@ As an example, let's say there are two docs called **Nginx App** and **Nginx (Le
3131
Ensure any internal links pointing to the deleted doc are updated to the new URL.
3232

3333
1. In your GitHub authoring tool, run a search for the URL you're removing. For example, if the legacy URL appears in other documents, replace all instances with the new URL.<br/><img src={useBaseUrl('img/contributing/old-url.png')} alt="Screenshot of a 'Find All' search for the URL to be removed" />
34-
1. Check with a Sumo Logic subject matter expert to confirm that you can replace all with the new URL.
35-
36-
:::warning
37-
Never do a "Find All > Replace All", as this can break unrelated items like image paths. Replace each URL on a one-by-one basis.
38-
:::
34+
:::warning
35+
Never do a Find All > Replace All, as this can break unrelated items like image paths. Replace each URL on a one-by-one basis.
36+
:::
37+
1. If applicable:
38+
* Remove from its parent index.md hub page.
39+
* Remove from [Product List](/docs/integrations/product-list/).
3940

4041
## Step 3: Delete the doc file
4142

0 commit comments

Comments
 (0)