Skip to content

Commit 87aaa2a

Browse files
Merge pull request #62 from AdobeDocs/link-404-faq
add FAQ entry for 404 link errors
2 parents ac6650a + 1c8f99e commit 87aaa2a

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/pages/faq/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ description: A guide with FAQ about the ADP Developer Site
55

66
# ADP Developer Site Best Practices
77

8+
## Why is my link returning a 404?
9+
10+
A few common causes:
11+
12+
- **Trailing slash** — pages served from `index.md` files require a trailing slash. The no-slash version won't redirect unless a redirect is explicitly configured. See [Paths and Links](https://developer.adobe.com/dev-docs-reference/getting-started/dev-docs/best-practices/#paths-and-links).
13+
- **Path characters** — paths use hyphens, not underscores or periods. See [File and Directory Naming](https://developer.adobe.com/dev-docs-reference/getting-started/dev-docs/best-practices/#file-and-directory-naming).
14+
- **Expired redirects** — after migrating from Gatsby, we add temporary redirects to cover old bookmarks. Those are removed after ~4–6 weeks. New pages never get them, so there's no fallback. See [Paths and Links](https://developer.adobe.com/dev-docs-reference/getting-started/dev-docs/best-practices/#paths-and-links).
15+
16+
To detect 404s in your repo, run the link checker commands in your [`package.json`](https://github.com/AdobeDocs/dev-docs-template/blob/d67b86f4dca4f30ecb9825fe7dd08b392475ad4b/package.json#L27-L28).
17+
818
## How do I link PDF or ZIP files for download or viewing?
919
To host and link PDF files (or other files like `ZIP` or `.d.ts`), use a URL and use relative path to file within `src/pages`:
1020

0 commit comments

Comments
 (0)