From 617a652914267be646b3f6adf43d146786e749fe Mon Sep 17 00:00:00 2001 From: melissag-ensemble Date: Fri, 5 Jun 2026 07:51:23 -0700 Subject: [PATCH 1/2] fix: static / JSON linking examples in FAQ --- src/pages/faq/index.md | 14 +++++++++++--- src/pages/localdev/index.md | 2 +- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/pages/faq/index.md b/src/pages/faq/index.md index cf31ba3..195c12a 100644 --- a/src/pages/faq/index.md +++ b/src/pages/faq/index.md @@ -21,10 +21,18 @@ To host and link PDF files (or other files like `ZIP` or `.d.ts`), use a URL and `[ZIP](./assets/process.zip)` \
`[PDF for download](./assets/example.pdf)` \
-`JSON` files in `src/pages` must be in AEM EDS format or deployments will fail. JSON files that aren't in AEM EDS format (such as Redocly API spec files) must be placed in the `static` folder and can be linked using a relative path: \
+## How do I link JSON files? + +`JSON` files in `src/pages` must be in AEM EDS format or deployments will fail. JSON files that aren't in AEM EDS format (such as Redocly API spec files) must be placed in the `static` folder. Files in `static/` are not deployed to EDS, so relative paths (e.g. `../../static/`) will return 404. + +**In a `RedoclyAPIBlock`**: Use `src="/{pathPrefix}/{filename}"` — include pathPrefix, exclude the `static` segment: \
+ +`` + +**As a plain download link**: Use a `raw.githubusercontent.com` URL instead: \
+ +`[Download schema](https://raw.githubusercontent.com/AdobeDocs/your-repo/main/static/your-file.json)` -`[example JSON file](../../static/petstore.json) -` ## Where can I upload videos? To use videos in blocks that accept video attributes, you need to provide a URL or if uploaded under `src/pages` they can use a relative path. Here are your options for uploading and hosting videos: diff --git a/src/pages/localdev/index.md b/src/pages/localdev/index.md index 7496f34..0a1875b 100644 --- a/src/pages/localdev/index.md +++ b/src/pages/localdev/index.md @@ -67,6 +67,6 @@ https://main--adp-devsite-stage--adobedocs.aem.page/devsite/local-dev-part-2.mp4 ## Best Practices -* **Content Location:** Place content in `/src/pages/`, except for Redocly API JSON files, which must reside in `/static/` or outside the `/src/pages/`. +* **Content Location:** Place content in `/src/pages/`, except for Redocly API JSON files, which must reside in `/static/` or outside the `/src/pages/`. See [How do I link JSON files?](../faq/index.md#how-do-i-link-json-files) * **The deployed stage environment (developer-stage.adobe.com) is the Source of Truth:** Local development provides a fast feedback loop while drafting content, but it may not perfectly replicate the final environment. Always use the stage environment for validation before publishing. * **Ongoing Refinements:** We are continuously improving the local development experience. If you notice any discrepancies between local and stage, please report them to the DevSite team. \ No newline at end of file From 83d413db150d4b86db4641f412bfd3eeb5826f86 Mon Sep 17 00:00:00 2001 From: melissag-ensemble Date: Fri, 5 Jun 2026 10:58:37 -0700 Subject: [PATCH 2/2] fix: static / JSON linking examples in FAQ --- src/pages/faq/index.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/pages/faq/index.md b/src/pages/faq/index.md index 195c12a..6356f04 100644 --- a/src/pages/faq/index.md +++ b/src/pages/faq/index.md @@ -23,15 +23,13 @@ To host and link PDF files (or other files like `ZIP` or `.d.ts`), use a URL and ## How do I link JSON files? -`JSON` files in `src/pages` must be in AEM EDS format or deployments will fail. JSON files that aren't in AEM EDS format (such as Redocly API spec files) must be placed in the `static` folder. Files in `static/` are not deployed to EDS, so relative paths (e.g. `../../static/`) will return 404. +`JSON` files in `src/pages` must be in AEM EDS format or deployments will fail. JSON files that aren't in AEM EDS format (such as Redocly API spec files) must be placed in the `static` folder and can be linked using a relative path: \
-**In a `RedoclyAPIBlock`**: Use `src="/{pathPrefix}/{filename}"` — include pathPrefix, exclude the `static` segment: \
+`[example JSON file](../../../static/petstore.json)` -`` - -**As a plain download link**: Use a `raw.githubusercontent.com` URL instead: \
+**In a `RedoclyAPIBlock`**: Relative paths don't work — use `src="/{pathPrefix}/{filename}"` (include pathPrefix, exclude the `static` segment): \
-`[Download schema](https://raw.githubusercontent.com/AdobeDocs/your-repo/main/static/your-file.json)` +`` ## Where can I upload videos?