From 1ce3a6f1df9dc6b04a7971c3a00b27c29c1753f3 Mon Sep 17 00:00:00 2001 From: Diane Batres Date: Tue, 5 May 2026 14:16:13 -0400 Subject: [PATCH 1/5] fix best practices for relative paths --- .../blocks/columns/columns-with-video.md | 8 ++-- .../with-background-image-and-video.md | 4 +- src/pages/faq/index.md | 12 ++++-- .../dev-docs/best-practices/index.md | 39 +++++++++++++++++-- 4 files changed, 49 insertions(+), 14 deletions(-) diff --git a/src/pages/blocks/columns/columns-with-video.md b/src/pages/blocks/columns/columns-with-video.md index 27ae297..4b3a934 100644 --- a/src/pages/blocks/columns/columns-with-video.md +++ b/src/pages/blocks/columns/columns-with-video.md @@ -10,7 +10,7 @@ description: Learn how to use the Columns block with videos. ```markdown -[Video alt description](https://raw.githubusercontent.com/AdobeDocs/dev-docs-reference/main/src/pages/assets/example-video.mp4) +[Video alt description](../../assets/example-video.mp4) ### Feature One @@ -18,7 +18,7 @@ Description of the first feature. [Learn more](https://example.com) -[Video alt description](https://raw.githubusercontent.com/AdobeDocs/dev-docs-reference/main/src/pages/assets/example-video.mp4) +[Video alt description](../../assets/example-video.mp4) ### Feature Two @@ -31,7 +31,7 @@ Description of the second feature. -[Video alt description](https://raw.githubusercontent.com/AdobeDocs/dev-docs-reference/main/src/pages/assets/example-video.mp4) +[Video alt description](../../assets/example-video.mp4) ### Feature One @@ -39,7 +39,7 @@ Description of the first feature. [Learn more](https://example.com) -[Video alt description](https://raw.githubusercontent.com/AdobeDocs/dev-docs-reference/main/src/pages/assets/example-video.mp4) +[Video alt description](../../assets/example-video.mp4) ### Feature Two diff --git a/src/pages/blocks/superhero/halfwidth/with-background-image-and-video.md b/src/pages/blocks/superhero/halfwidth/with-background-image-and-video.md index 151cae8..717e91b 100644 --- a/src/pages/blocks/superhero/halfwidth/with-background-image-and-video.md +++ b/src/pages/blocks/superhero/halfwidth/with-background-image-and-video.md @@ -12,7 +12,7 @@ Superhero half width variant with background image and video ![Gradient background](../../../assets/vertical-gradient.png) -[video_url](https://example.com/demo-video.mp4) +[video_url](../../../assets/example-video.mp4) # Page Heading @@ -26,7 +26,7 @@ This is a sample description text for the superhero block. ![Gradient background](../../../assets/vertical-gradient.png) -[video_url](https://raw.githubusercontent.com/AdobeDocs/dev-docs-reference/refs/heads/main/src/pages/assets/example-videp.mp4) +[video_url](../../../assets/example-video.mp4) # Page Heading diff --git a/src/pages/faq/index.md b/src/pages/faq/index.md index 6ecfbfb..1805fe2 100644 --- a/src/pages/faq/index.md +++ b/src/pages/faq/index.md @@ -8,14 +8,18 @@ description: A guide with FAQ about the ADP Developer Site ## How do I link PDF or ZIP files for download or viewing? 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`: -`[ZIP](./assets/process.zip)` -`[PDF for download](./assets/example.pdf)` +`[ZIP](./assets/process.zip)` \
+`[PDF for download](./assets/example.pdf)` \
+`JSON` files not used for Redocly Blocks can be linked from `static` as well but those files must be in the `static` folder otherwise deployments will fail. `JSON` files that are linked can use a relative path like ZIP and PDF files: \
+ +`[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. Here are your options for uploading and hosting 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: -**GitHub**: Commit your video to your GitHub repository and copy the raw GitHub URL. +**GitHub**: Commit your video to your GitHub repository and link to it using a relative path. [See Superhero with video](../blocks/superhero/halfwidth/with-background-image-and-video.md) **Google Drive** (with 2-minute limit): Upload your video to Google Drive, open it, use the AEM Sidekick extension to publish, then copy the URL. Videos uploaded to Google Drive have a 2-minute limit. diff --git a/src/pages/getting-started/dev-docs/best-practices/index.md b/src/pages/getting-started/dev-docs/best-practices/index.md index 5f666ff..1673356 100644 --- a/src/pages/getting-started/dev-docs/best-practices/index.md +++ b/src/pages/getting-started/dev-docs/best-practices/index.md @@ -39,6 +39,20 @@ description: Best practices and troubleshooting tips for migrating your document - Relative links should include file name and extension (ex: `index.md` or other `.md` file) - except for anchor links that are in the current page (e.g. `[description](#anchor)`) - note: anchor links don't work in local development - deploy to stage to test + - **Reference-style links for `.md` files**: + - You can list targets once at the bottom of the file and reference them by label in the body. This keeps long paths out of inline text. + - Example: + +``` +To configure credentials for your integration, see [Authentication][2]. + +[//]: # (Links) +[1]: /docs/overview/index.md +[2]: /reference/authentication/index.md +[3]: /guides/release-notes/index.md + +``` + - To open link as external, use the query string `?aio_external` in your URL: - Example: [https://github.com/AdobeDocs/adp-devsite-github-actions-test/blob/main/src/pages/test/test-hr-0.md?plain=1#L13](https://github.com/AdobeDocs/adp-devsite-github-actions-test/blob/main/src/pages/test/test-hr-0.md?plain=1#L13) - This will have to open the external link manually. @@ -55,10 +69,27 @@ description: Best practices and troubleshooting tips for migrating your document - In Gatsby, invalid URLs that have unnecessary trailing slashes will work. However, in EDS they won't work - `redirects.json` will redirect Gatsby bookmarks (from invalid form to correct form). It's best to do this for a limited period of time, around 4-6 weeks. -- **Links to other file types than .md and .json needs to use raw github links for now**: - - example: [https://github.com/AdobeDocs/adp-devsite-github-actions-test/blob/ced7a472d45d7d911f391f79706a3e00b7bad46a/src/pages/test/mp4.md?plain=1#L1](https://github.com/AdobeDocs/adp-devsite-github-actions-test/blob/ced7a472d45d7d911f391f79706a3e00b7bad46a/src/pages/test/mp4.md?plain=1#L1) - - mp4 file: `https://raw.githubusercontent.com/AdobeDocs/adp-devsite-github-actions-test/refs/heads/main/src/pages/assets/example-video.mp4` - - We have a ticket open to fix this +- **Links to other file types than .md and .json can use relative paths**: + - `[ZIP](./assets/process.zip)` \
+`[PDF for download](./assets/example.pdf)` \
+ - In blocks, like Columns or Superhero, images and videos can also be in a relative path: +```markdown + + +![Gradient background](../../../assets/vertical-gradient.png) + +[video_url](../../../assets/example-video.mp4) + +# Page Heading + +This is a sample description text for the superhero block. + +* [Get Started](https://example.com/getting-started) +* [View Examples](https://example.com/examples) +``` +- **GitHub URLs for files that end in `.md`**: + - Use `%2E` in place of the period before `md` in the path so the URL resolves + - Example: `[README on GitHub](https://github.com/AdobeDocs/dev-docs-reference/blob/main/README%2Emd)` — use `%2E` instead of `.` before `md` in the path segment (not `...README.md`). We have a [ticket](https://jira.corp.adobe.com/browse/DEVSITE-2375) logged to fix this so you don't need to use this workaround - **Fix dead links**: - `$npm run lint --dead-links-only`: lists dead links. Run to prevent 404s. Check your `package.json` file for more linting scripts - More information: [Linting Guide](../../../deploy/lint.md) From 9c506d8bada08d391efb58530e943e42d8f06c36 Mon Sep 17 00:00:00 2001 From: Diane Batres Date: Tue, 5 May 2026 14:17:51 -0400 Subject: [PATCH 2/5] remove example json --- src/pages/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/pages/index.md b/src/pages/index.md index 8490917..c0e165c 100644 --- a/src/pages/index.md +++ b/src/pages/index.md @@ -65,6 +65,4 @@ EDS recently launched a new feature where content can live in GitHub repos. **Next Gen Architecture:** -![NextGenArchitecture](assets/next-gen-architecture.png) - -[example JSON file](../../static/petstore.json) \ No newline at end of file +![NextGenArchitecture](assets/next-gen-architecture.png) \ No newline at end of file From 82cafc45bb93ef5808c247759564c8a97a3c1a3a Mon Sep 17 00:00:00 2001 From: Diane Batres Date: Tue, 5 May 2026 14:19:14 -0400 Subject: [PATCH 3/5] fix merge error --- src/pages/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pages/index.md b/src/pages/index.md index c0e165c..8490917 100644 --- a/src/pages/index.md +++ b/src/pages/index.md @@ -65,4 +65,6 @@ EDS recently launched a new feature where content can live in GitHub repos. **Next Gen Architecture:** -![NextGenArchitecture](assets/next-gen-architecture.png) \ No newline at end of file +![NextGenArchitecture](assets/next-gen-architecture.png) + +[example JSON file](../../static/petstore.json) \ No newline at end of file From aaa26f314c3dc2a62d24c3e46bc4d885ae1bbaf7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 5 May 2026 18:20:37 +0000 Subject: [PATCH 4/5] Generate contributors --- src/pages/contributors.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/contributors.json b/src/pages/contributors.json index 775c4ea..501125c 100644 --- a/src/pages/contributors.json +++ b/src/pages/contributors.json @@ -1 +1 @@ -{"total":84,"offset":0,"limit":84,"data":[{"page":"/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/57922?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/bestpractices/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"12/3/2025"},{"page":"/blocks/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/accordion/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/announcement/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/30/2025"},{"page":"/blocks/breadcrumb/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/cards/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/code/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/code/code-basic","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-highlighted-line","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/code/code-in-list","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-in-table","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-overload","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/code/code-with-try-playground","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/codeblock/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/codeblock/code-block-with-picklist","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/codeblock/code-block-without-picklist","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/columns/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"3/26/2026"},{"page":"/blocks/columns/columns-with-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/columns/columns-with-reverse","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/columns/columns-with-video","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/contributors/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/18/2026"},{"page":"/blocks/credential/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/credential/api-key","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/credential/oauth","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/details/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/blocks/discoverblock/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/edition/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/8/2026"},{"page":"/blocks/embed/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/footer/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/fragment/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/iframe/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/15/2026"},{"page":"/blocks/image/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/inline-alert/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"4/2/2026"},{"page":"/blocks/inline-code/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/links/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/29/2026"},{"page":"/blocks/list/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/nextprev/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"12/3/2025"},{"page":"/blocks/onthispage/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/page-actions/","avatars":[],"lastUpdated":"2/11/2026"},{"page":"/blocks/product-card/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-configs","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"4/14/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-default","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-layout","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-sidebar","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-sidebar-no-search","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-y-scroll-offset","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-overflow","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/resources/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/sidenav/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/blocks/site-metadata/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/site-wide-banner/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/5/2025"},{"page":"/blocks/superhero/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centered/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centered/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centeredxl/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centeredxl/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/with-background-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/with-background-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/with-background-image-and-video","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/tab/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/30/2025"},{"page":"/blocks/table/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/27/2026"},{"page":"/blocks/topnav/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/12/2026"},{"page":"/config","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"3/30/2026"},{"page":"/deploy/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"12/12/2025"},{"page":"/deploy/lint","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/11/2026"},{"page":"/eds-release/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/faq/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"3/10/2026"},{"page":"/getting-started/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/analytics/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/best-practices/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/onboarding/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-docs/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-docs/best-practices/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"3/12/2026"},{"page":"/getting-started/features/create-credentials/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/features/private-sites/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/features/redocly/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/search/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/localdev/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"2/9/2026"}],":type":"sheet"} \ No newline at end of file +{"total":84,"offset":0,"limit":84,"data":[{"page":"/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/57922?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/bestpractices/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"12/3/2025"},{"page":"/blocks/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/accordion/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/announcement/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/30/2025"},{"page":"/blocks/breadcrumb/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/cards/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/code/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/code/code-basic","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-highlighted-line","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/code/code-in-list","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-in-table","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/code/code-overload","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/code/code-with-try-playground","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/codeblock/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/codeblock/code-block-with-picklist","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/codeblock/code-block-without-picklist","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/columns/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"3/26/2026"},{"page":"/blocks/columns/columns-with-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/columns/columns-with-reverse","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/columns/columns-with-video","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"5/5/2026"},{"page":"/blocks/contributors/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/18/2026"},{"page":"/blocks/credential/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/credential/api-key","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/credential/oauth","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/2/2026"},{"page":"/blocks/details/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/blocks/discoverblock/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/6/2026"},{"page":"/blocks/edition/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/8/2026"},{"page":"/blocks/embed/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/footer/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/fragment/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/6/2026"},{"page":"/blocks/iframe/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/15/2026"},{"page":"/blocks/image/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/inline-alert/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"4/2/2026"},{"page":"/blocks/inline-code/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/links/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"1/29/2026"},{"page":"/blocks/list/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/nextprev/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"12/3/2025"},{"page":"/blocks/onthispage/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/page-actions/","avatars":[],"lastUpdated":"2/11/2026"},{"page":"/blocks/product-card/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-configs","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"4/14/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-default","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-layout","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-sidebar","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-sidebar-no-search","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-api-block-no-y-scroll-offset","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/redoclyapiblock/redocly-overflow","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/resources/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"11/27/2025"},{"page":"/blocks/sidenav/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/blocks/site-metadata/","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/30/2026"},{"page":"/blocks/site-wide-banner/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/5/2025"},{"page":"/blocks/superhero/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centered/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centered/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centeredxl/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/centeredxl/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/with-background-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/default/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/with-background-image","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/superhero/halfwidth/with-background-image-and-video","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"5/5/2026"},{"page":"/blocks/superhero/halfwidth/with-icon","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/4/2026"},{"page":"/blocks/tab/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"12/30/2025"},{"page":"/blocks/table/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"3/27/2026"},{"page":"/blocks/topnav/","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/113968869?v=4"],"lastUpdated":"3/12/2026"},{"page":"/config","avatars":["https://avatars.githubusercontent.com/u/113968869?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"3/30/2026"},{"page":"/deploy/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"12/12/2025"},{"page":"/deploy/lint","avatars":["https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/11/2026"},{"page":"/eds-release/","avatars":["https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4"],"lastUpdated":"3/12/2026"},{"page":"/faq/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4","https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"5/5/2026"},{"page":"/getting-started/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/analytics/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/best-practices/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-biz/onboarding/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-docs/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/dev-docs/best-practices/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4","https://avatars.githubusercontent.com/u/14320591?v=4","https://avatars.githubusercontent.com/u/120194874?v=4"],"lastUpdated":"5/5/2026"},{"page":"/getting-started/features/create-credentials/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/features/private-sites/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/features/redocly/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/getting-started/search/","avatars":["https://avatars.githubusercontent.com/u/41382203?v=4"],"lastUpdated":"2/12/2026"},{"page":"/localdev/","avatars":["https://avatars.githubusercontent.com/u/57922?v=4"],"lastUpdated":"2/9/2026"}],":type":"sheet"} \ No newline at end of file From 2672108a7ae611037117a4ba5c5672bd6a13733f Mon Sep 17 00:00:00 2001 From: Diane Batres Date: Tue, 5 May 2026 15:13:42 -0400 Subject: [PATCH 5/5] Update src/pages/faq/index.md Co-authored-by: melissag-ensemble <120194874+melissag-ensemble@users.noreply.github.com> --- src/pages/faq/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/faq/index.md b/src/pages/faq/index.md index 1805fe2..3b29306 100644 --- a/src/pages/faq/index.md +++ b/src/pages/faq/index.md @@ -11,7 +11,7 @@ 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 not used for Redocly Blocks can be linked from `static` as well but those files must be in the `static` folder otherwise deployments will fail. `JSON` files that are linked can use a relative path like ZIP and PDF 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: \
`[example JSON file](../../static/petstore.json) `