Skip to content
This repository has been archived by the owner on Feb 25, 2025. It is now read-only.

Move images to flutter/assets-for-api-docs #53917

Merged
merged 3 commits into from
Jul 15, 2024

Conversation

jtmcdole
Copy link
Contributor

27MB of images should not be in the source tree.

Caveat: If you use VSCode's markdown preview, it does not support images outside the workspace. One solution to this would be to submodule the assets back into the assets folder - however that would break github rendering of images.

Fixes flutter/flutter#151691

@jtmcdole
Copy link
Contributor Author

You can see that this works in github by previewing the actual files: https://github.com/flutter/engine/blob/dcf9bd36cb051df0250a601a74464df40419db69/impeller/README.md

@jtmcdole jtmcdole requested a review from chinmaygarde July 15, 2024 21:54
@chinmaygarde
Copy link
Member

Local tools like Obsidian break if you don't use the RAW URL. I think GitHub may be doing the conversions automagically. But, it works if I change the asset URL to use https://raw.githubusercontent.com/flutter/assets-for-api-docs/5da33067f5cfc7f177d9c460d618397aad9082ca/assets/engine/impeller/android_profiling/image.avif

Before:
Screenshot 2024-07-15 at 3 04 18 PM

After:

Screenshot 2024-07-15 at 3 04 30 PM

@chinmaygarde
Copy link
Member

Does viewing on GitHub break if you directly reference the images from raw.githubusercontent.com?

@jtmcdole
Copy link
Contributor Author

will try it out

@jtmcdole
Copy link
Contributor Author

This looks fine: https://github.com/flutter/engine/blob/3bf53f017dffb6b549806b7c0d550e3055962ca6/impeller/docs/android_cpu_profile.md

jtmcdole added 3 commits July 15, 2024 15:41
27MB of images should not be in the source tree.

Caveat: If you use VSCode's markdown preview, it does not support images
outside the workspace. One solution to this would be to submodule the
assets back into the assets folder.

Fixes flutter/flutter#151691
@jtmcdole jtmcdole added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 15, 2024
@auto-submit auto-submit bot merged commit 3dd4d7d into flutter:main Jul 15, 2024
27 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 16, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 16, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 16, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Jul 16, 2024
…151802)

flutter/engine@f1363fb...235e67f

2024-07-16 [email protected] Roll Skia from d4acfbe0b001 to c91cad775529 (1 revision) (flutter/engine#53924)
2024-07-16 [email protected] Align `tools/android_sdk/packages.txt` with what is uploaded to CIPD (flutter/engine#53921)
2024-07-15 [email protected] Roll Skia from 6347d8255f83 to d4acfbe0b001 (3 revisions) (flutter/engine#53919)
2024-07-15 [email protected] Move images to flutter/assets-for-api-docs (flutter/engine#53917)
2024-07-15 [email protected] Roll Skia from b63d0290b826 to 6347d8255f83 (5 revisions) (flutter/engine#53916)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
TytaniumDev pushed a commit to TytaniumDev/flutter that referenced this pull request Aug 7, 2024
…lutter#151802)

flutter/engine@f1363fb...235e67f

2024-07-16 [email protected] Roll Skia from d4acfbe0b001 to c91cad775529 (1 revision) (flutter/engine#53924)
2024-07-16 [email protected] Align `tools/android_sdk/packages.txt` with what is uploaded to CIPD (flutter/engine#53921)
2024-07-15 [email protected] Roll Skia from 6347d8255f83 to d4acfbe0b001 (3 revisions) (flutter/engine#53919)
2024-07-15 [email protected] Move images to flutter/assets-for-api-docs (flutter/engine#53917)
2024-07-15 [email protected] Roll Skia from b63d0290b826 to 6347d8255f83 (5 revisions) (flutter/engine#53916)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@jtmcdole jtmcdole deleted the moveImages branch September 25, 2024 16:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App e: impeller
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move engine's doc images to flutter/assets-for-api-docs
2 participants