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

Update image size customization docs #96

Merged
merged 2 commits into from
Feb 20, 2023

Conversation

forkata
Copy link
Contributor

@forkata forkata commented Feb 14, 2023

Summary

We found that the documentation on customizing image sizes for products and
variants was outdated and suggested users introduce a decorator. This was
fixed previously in the Legacy guides and we have ported the updated documentation
to the new version here.

Fixes #94

Checklist

  • I have followed the Diátaxis framework in my PR.
  • I have verified that the preview environment works correctly.

@forkata forkata force-pushed the fix/update-image-processing-guides branch from 43324f1 to 6d5bb3c Compare February 15, 2023 00:48
@waiting-for-dev
Copy link
Contributor

Looking great, @forkata!

@forkata
Copy link
Contributor Author

forkata commented Feb 15, 2023

Thanks @waiting-for-dev! One thing I don't know is why the build preview is not working? Any ideas on this? I was hoping to preview the rendered version and copy this change to the 3.2/3.3 version of the docs as well.

@waiting-for-dev
Copy link
Contributor

I think the build needs to be manually done by an admin on Cloudfare (cc @kennyadsl).

For now, you can locally preview your changes following the README instructions. Let me know if you need any help.

Notice there's also a script to backport to older versions easily. Again, let me know if you need support.

@forkata forkata force-pushed the fix/update-image-processing-guides branch from 6d5bb3c to 6a96127 Compare February 16, 2023 08:26
@forkata
Copy link
Contributor Author

forkata commented Feb 16, 2023

Thanks for the help @waiting-for-dev, the local preview worked great! I made a few formatting
and text changes.

I also added an example for how to reference the new image style if using the started frontend, let me know if that makes sense!

The back-port script was a breeze to use as well, thanks for pointing me to that! I think this should be ready for some reviews.

@forkata forkata marked this pull request as ready for review February 16, 2023 08:29
@forkata forkata force-pushed the fix/update-image-processing-guides branch from 6a96127 to b9d8ed5 Compare February 16, 2023 08:39
Copy link
Contributor

@waiting-for-dev waiting-for-dev left a comment

Choose a reason for hiding this comment

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

That's awesome, @forkata 😍

forkata and others added 2 commits February 16, 2023 00:41
We found that the documentation on customizing image sizes for products and
variants was outdated and suggested users introduce a decorator. This was
fixed previously in the Legacy guides and we have ported the updated documentation
to the new version here.

Fixes solidusio#94

Co-authored-by: Cameron Day <cameron@super.gd>
This change to the docs applies to all versions of Solidus since version 3.1 when the preferences for customizing image
sizes were added solidusio/solidus#4062.

Co-authored-by: Cameron Day <cameron@super.gd>
@forkata forkata force-pushed the fix/update-image-processing-guides branch from b9d8ed5 to b828762 Compare February 16, 2023 08:43
@kennyadsl
Copy link
Member

kennyadsl commented Feb 16, 2023

Thanks @forkata and @camerond594! Trying to understand if there's a way with Cloudflare to build previews coming from forks. Will keep you posted.

@kennyadsl
Copy link
Member

kennyadsl commented Feb 16, 2023

From a Cloudflare Discord thread:

Screenshot 2023-02-16 at 10 28 43@2x

So, I guess we need to migrate to other solutions that allow PRs from forked repositories if we want to show previews for external contributions, and I guess we want. 😬

@kennyadsl kennyadsl merged commit 4e58982 into solidusio:main Feb 20, 2023
@forkata forkata deleted the fix/update-image-processing-guides branch February 21, 2023 18:41
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.

Guides have outdated information about overriding product/taxon image sizes
3 participants