Skip to content

fix: static / JSON linking examples in FAQ #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
melissag-ensemble merged 2 commits into from
Jun 5, 2026
Merged

fix: static / JSON linking examples in FAQ #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
617a652
fix: static / JSON linking examples in FAQ
melissag-ensemble Jun 5, 2026
83d413d
fix: static / JSON linking examples in FAQ
melissag-ensemble Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/pages/faq/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,16 @@ To host and link PDF files (or other files like `ZIP` or `.d.ts`), use a URL and
`[ZIP](./assets/process.zip)` \<br/\>
`[PDF for download](./assets/example.pdf)` \<br/\>

`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: \<br/\>
## 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 and can be linked using a relative path: \<br/\>

`[example JSON file](../../../static/petstore.json)`

**In a `RedoclyAPIBlock`**: Relative paths don't work — use `src="/{pathPrefix}/{filename}"` (include pathPrefix, exclude the `static` segment): \<br/\>

`<RedoclyAPIBlock src="/your-pathPrefix/petstore.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:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/localdev/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading