Skip to content
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.

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

docs: image and file cdn adapter docs #38744

Merged
merged 3 commits into from
Jun 28, 2024
Merged

Conversation

pieh
Copy link
Contributor

@pieh pieh commented Dec 6, 2023

Description

Supporting docs for feature from #38685

Documentation

Tests

Related Issues

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Dec 6, 2023
@@ -146,6 +146,7 @@ The `config` hook has to return an object with the following keys:
- `pathPrefix` (Optional): If `false`, Gatsby will fail the build if user tries to use pathPrefix
- `trailingSlash` (Optional): Provide an array of supported [`trailingSlash`](/docs/reference/config-files/gatsby-config/#trailingslash) options, e.g. `['always']`
- `pluginsToDisable` (Optional): Provide an array of plugin names that should be disabled when adapter is used. Purpose of this is to disable any potential plugins that serve similar role as adapter that would cause conflicts when both plugin and adapter is used at the same time.
- `imageCDNUrlGeneratorModulePath` (Optional): Specifies the absolute path to a CommonJS module that exports a function to generate CDN URLs for images. This function, matching the `ImageCdnUrlGeneratorFn` type signature, takes `ImageCdnSourceImage` and `ImageCdnTransformArgs` as arguments to create optimized CDN URLs for image assets. It is particularly useful for adapting image paths to different CDN providers to optimize image delivery.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add fileCDNUrlGeneratorModulePath and specify gatsby version it first will be available in (likely gatsby@5.13.0)

@pieh pieh added type: documentation An issue or pull request for improving or updating Gatsby's documentation topic: adapters Related to Gatsby Adapters and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Dec 6, 2023
@pieh pieh marked this pull request as ready for review December 20, 2023 09:36
@serhalp
Copy link

serhalp commented Jun 25, 2024

@pieh is this mergeable?

@serhalp serhalp force-pushed the docs/adapters-image-file-cdn branch from 21a01e0 to 2e979e2 Compare June 28, 2024 13:05
@serhalp serhalp enabled auto-merge (squash) June 28, 2024 13:05
@serhalp serhalp force-pushed the docs/adapters-image-file-cdn branch from 2e979e2 to f753610 Compare June 28, 2024 13:09
@serhalp serhalp disabled auto-merge June 28, 2024 13:49
@serhalp serhalp merged commit 519e88d into master Jun 28, 2024
7 checks passed
@serhalp serhalp deleted the docs/adapters-image-file-cdn branch June 28, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted topic: adapters Related to Gatsby Adapters type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants