search

fonttools / fontbakery

🧁 A font quality assurance tool for everyone
https://fontbakery.readthedocs.io
Apache License 2.0
534 stars 99 forks source link

[com.google.fonts/check/article/images] should pass if there is not an `article/images` dir #4703

Closed vv-monsalve closed 1 month ago

vv-monsalve commented 1 month ago

Observed behavior

⚠️ WARN There are 3 image files in the article directory and they should be moved to an article/images subdirectory:

The above Warn was reported on this CI run. However, in this comment on the issue proposal for a new check, Nathan Williams said the images subdirectory is not required.

Expected behavior

The check should pass if there is no images subdirectory under the article one (not reporting a Warn).

Resources and steps needed to reproduce

See CI run linked above

felipesanches commented 1 month ago

It is just a WARN... for the sake of moving the repo towards some more homogeneous structure.

I'd say there's some benefit for tooling and for user-friendliness to have a more regular directory structure.

felipesanches commented 1 month ago

It is just a WARN... for the sake of moving the repo towards some more homogeneous structure.

* How many outliers do we actually have?

* How hard would it be to reorganize the entire repo at once, moving all images to their respective `images` sub-dirs and afterwards making it mandatory?

I'd say there's some benefit for tooling and for user-friendliness to have a more regular directory structure.

@nathan-williams, I'd be glad to hear your thoughts here as well. What do you think?

vv-monsalve commented 1 month ago
  • How many outliers do we actually have?

We are not currently using an "images" folder, so having it would be kind of the outlier

How hard would it be to reorganize the entire repo at once

It would require changing the paths in multiple HTML article files, which would be time-consuming on something that is not a strong requirement or need.

@emmamarichal, @m4rc1e, @yanone wdyt?

emmamarichal commented 1 month ago

@vv-monsalve I agree. I've never seen a sub-dir called "images". What would that include, having another sub-folder for GIFS? videos? I think we'd be complicating the process and it would actually require too many changes for something that I think works very well.

felipesanches commented 1 month ago

ok, no worries. I'll make the proposed change, then.