Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions src/pages/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,22 @@ Actions → Build Auto-Generated Files → Run workflow

This is a known limitation tracked in [DEVSITE-2395](https://jira.corp.adobe.com/browse/DEVSITE-2395).

## I deployed from a new branch but my changes aren't showing on Stage

Deployments are incremental by default: the workflow finds the **last successful deploy on the same branch** and uploads only the files that changed since then. A brand-new branch has no previous successful deploy to compare against, so change detection falls back to diffing only the latest commit — anything committed earlier on the branch isn't detected and never gets deployed.

Re-run the workflow with **Force deploy all files** checked. This skips change detection and uploads every file in `src/pages/`, so the whole branch renders. This is the expected step when testing a new branch.

Actions → Staging → Run workflow → check **Force deploy all files** → Run workflow

See [Full Deployment (deployAll: true)](../deploy/index.md#full-deployment-deployall-true).

## Why do I see "Invalid license key: host not allowed" on a `RedoclyAPIBlock`?

The block only renders on hostnames in the Redocly license's allowed-domains list, and the page you're viewing isn't one of them (`main--...aem.page` preview URLs are a common case). View the page on an allowed host instead — for example, `https://developer-stage.adobe.com/...` — or on your local dev server (`http://localhost:3000/...`).

See [Redocly API Block](../getting-started/features/redocly/index.md#where-the-block-renders) for the full list of allowed domains.

## Why are the `Build Contributors` or `Build Site Metadata` checks failing with a push rejection?

The deploy workflow auto-generates `contributors.json` and `adp-site-metadata.json` and pushes them to main using the `adp-devsite-app` bot. If your repo has branch protection rules, the bot needs to be added as a bypass actor.
Expand Down
13 changes: 12 additions & 1 deletion src/pages/getting-started/features/redocly/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,18 @@ Generate and display interactive API reference documentation directly on the Ado

The Redocly API Block enables product teams to generate and display interactive API reference documentation directly on the Adobe Developer Website without relying on iframes or external hosting. By using the `<RedoclyAPIBlock>` component with a URL pointing to an OpenAPI YAML file, teams can host their own API specifications and have them rendered seamlessly by Redocly within the site's native experience. This approach provides a more integrated developer experience, allowing API documentation to maintain consistent styling with the Developer Website while leveraging Redocly's robust API documentation features. The component requires an on-premise license key (managed by the dev-site team) to be added to the repository's deploy.yml file, with all public repos in the AdobeDocs organization having automatic access to this development environment secret.

The component offers customization options including adjustable right panel width (defaults to 500px) and typography controls for font family and size, ensuring flexibility to match specific product needs. While local development testing is limited due to how Redocly API works—requiring teams to temporarily deploy to stage for testing—the component supports best practices like using Redocly's `x-summary` specification extension for long API response descriptions to prevent text truncation and layout issues. Teams can also implement full-width pages using custom layouts, providing maximum flexibility for presenting complex API documentation. This solution streamlines the process of publishing professional, interactive API references while maintaining the cohesive Adobe Developer Website experience.
The component offers customization options including adjustable right panel width (defaults to 500px) and typography controls for font family and size, ensuring flexibility to match specific product needs. The component supports best practices like using Redocly's `x-summary` specification extension for long API response descriptions to prevent text truncation and layout issues. Teams can also implement full-width pages using custom layouts, providing maximum flexibility for presenting complex API documentation. This solution streamlines the process of publishing professional, interactive API references while maintaining the cohesive Adobe Developer Website experience.

## Where the block renders

The block only renders on hostnames in the Redocly license's allowed-domains list:

- `developer.adobe.com`
- `developer-stage.adobe.com`
- `developer-dev.adobe.com`
- `stage--adp-devsite-stage--adobedocs.aem.page`

It will **not** render on `main--...aem.page` preview URLs, which aren't in the allowed domains — you'll see an `Invalid license key: host not allowed` error there. Local development also renders (`http://localhost:3000/...`), since Redocly's element exempts `localhost` from the license check.

## Steps to take to implement Redocly and learn more about Redocly

Expand Down
Loading