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 for Netlify Image CDN implementation #1

Merged
merged 7 commits into from
Feb 9, 2024

Conversation

klavavej
Copy link

@klavavej klavavej commented Feb 7, 2024

This PR adds docs for the Netlify Image CDN implementation proposed in nuxt#1234

Very open to feedback as this is my first OSS contribution and I'm guessing a bit at what info is necessary to include in the Nuxt docs (as opposed to being made available through links to the Netlify docs) by looking at the docs for other providers.

@klavavej klavavej marked this pull request as ready for review February 7, 2024 21:42
Comment on lines 42 to 49
:modifiers="{
h="400"
w="600"
fit="cover"
position="left"
fm="webp"
q="80"
}"
Copy link
Owner

Choose a reason for hiding this comment

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

Only position is a non-standard property. The rest are standard. e.g. see https://image.nuxt.com/usage/nuxt-img#modifiers

@ascorbic
Copy link
Owner

ascorbic commented Feb 8, 2024

It will automatically enabled when deploying to Netlify, so we could add something along the lines of "this provider is automatically enabled when deploying to Netlify, however you can also choose it manually". We should also say soemthing about how if they've manually enabled it, then for local development they will need to use the Netlify CLI to see images.

@klavavej
Copy link
Author

klavavej commented Feb 8, 2024

however you can also choose it manually

Is this applicable for sites that aren't deployed on Netlify? If no, why would someone choose to manually enable the netlify provider instead of relying on automatic enablement?


Update - the more I think about this the less my initial understanding makes sense. I'm now assuming manual enablement is useful for local development more than for sites that aren't deployed on Netlify. lemme know if I'm still misunderstanding

@klavavej
Copy link
Author

klavavej commented Feb 8, 2024

Thanks for the feedback - ready for another review!

@klavavej klavavej requested a review from ascorbic February 8, 2024 17:19
@ascorbic
Copy link
Owner

ascorbic commented Feb 9, 2024

I've made a couple of changes and will now merge this into my PR

@ascorbic ascorbic merged commit ce84424 into ascorbic:netlify-image-cdn Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants