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

Convert images to AVIF during API docs generation #2556

Merged
merged 5 commits into from
Jan 9, 2025
Merged

Conversation

frankharkins
Copy link
Member

@frankharkins frankharkins commented Jan 9, 2025

Includes a feature flag as requested. This requires the user have ImageMagick installed.

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

Thank you! Could you please document in the README prerequisites section that you need to install imagemagick and link to its install guide?

scripts/js/lib/api/processHtml.ts Outdated Show resolved Hide resolved
scripts/js/lib/api/processHtml.ts Show resolved Hide resolved
scripts/js/lib/api/saveImages.ts Show resolved Hide resolved
scripts/js/lib/api/saveImages.ts Outdated Show resolved Hide resolved
scripts/js/lib/api/saveImages.ts Show resolved Hide resolved
@Eric-Arellano Eric-Arellano changed the title Convert images to AVIF during docs sync Convert images to AVIF during API docs generation Jan 9, 2025
@frankharkins
Copy link
Member Author

Could you please document in the README prerequisites section that you need to install imagemagick and link to its install guide?

Soft push back on this: Most users will have it installed already, and if they don't they'll immediately see the message explaining that they need it. It's also likely to become outdated if we ever change how the pipeline works.

Co-authored-by: Eric Arellano <[email protected]>
@Eric-Arellano
Copy link
Collaborator

Soft push back on this: Most users will have it installed already, and if they don't they'll immediately see the message explaining that they need it. It's also likely to become outdated if we ever change how the pipeline works.

  1. We will need it when you contribute to guides if you add new images, not only API docs. Fwiw, I'm fine with saying "You'll need imagemick if adding new images"
  2. Why would most people have it installed already? I had to install it and it's not default on at least macOS

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

My README suggestion isn't blocking. Thanks for adding the install to the console log!

@frankharkins
Copy link
Member Author

I had to install it and it's not default on at least macOS

My mistake; I didn't need to install it so I assumed it came pre-installed with OSX, it must have been a dependency of something else.

@frankharkins frankharkins enabled auto-merge January 9, 2025 15:30
@frankharkins frankharkins added this pull request to the merge queue Jan 9, 2025
Merged via the queue into main with commit a26edc2 Jan 9, 2025
3 checks passed
@frankharkins frankharkins deleted the FH/avif-api branch January 9, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants