Skip image checks to match other repositories that use the asset server for images #9309
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stop erroring when images are not included in page bundles. Assets should instead be stored in https://grafana.com/docs/writers-toolkit/write/image-guidelines/#where-to-store-media-assets. Signed-off-by: Jack Baldry <[email protected]>
pracucci
approved these changes
Sep 17, 2024
tacole02
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
Stop erroring when images are not included in page bundles. The image rules are documented in https://grafana.com/docs/writers-toolkit/review/doc-validator/errata/#image-does-not-exist. They insist that all images are stored in the repository in a page bundle and are only referenced by the containing page.
Assets should instead be stored in https://grafana.com/docs/writers-toolkit/write/image-guidelines/#where-to-store-media-assets to avoid bloating this repository and the website repository with binary files.
@tacole02 We'll probably want to migrate images as they are updated unless you want to do them all together?
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.