Friction and problems in contributing a new docs notebook

[drbenvincent]

Hi. I'm working on a PR which (amongst other things) will add a new notebook. I'm coming up against friction.

I'm following the instructions in https://github.com/pymc-labs/pymc-marketing/blob/main/docs/source/gallery/README.md

I have added a new entry to gallery.md. I have made a corresponding .png file to use as the thumbnail. But I can't push the gallery thumbnail because it's in the .gitignore:

pymc-marketing/.gitignore

Line 147 in 4c4f251

docs/source/gallery/images/

I can get the docs to build locally just fine. However, it is showing some auto generated thumbnail and seems to be ignoring the one I provide it.

So it's unclear what's going on here. In short:

• Should the gallery images folder not be git ignored?
• Custom gallery image files seem not to be used?
• The instructions are unclear from a contributor perspective

If it's useful, the PR in question is: https://github.com/pymc-labs/pymc-marketing/pull/1673/files

[juanitorduz]

Thanks for reporting this! Currently we generate the gallery automatically https://github.com/pymc-labs/pymc-marketing/blob/main/Makefile#L40 and we do not support custom images. This is a TODO. This is why we ignore this folder, as it won't be used anyway.

Feel free to suggest a desired solution @drbenvincent and we can work on it together :)