website icon indicating copy to clipboard operation
website copied to clipboard

contributing docs: document gallery shortcode

Open dholbach opened this issue 2 years ago • 5 comments

In https://github.com/fluxcd/website/pull/956 we added the gallery shortcode - it'd be a good idea to document it in contributor docs.

dholbach avatar May 25 '22 13:05 dholbach

Hey @dholbach, can you please elaborate it more, I would like to work on this.

theVJagrawal avatar Sep 08 '22 04:09 theVJagrawal

Usage of the gallery shortcode is in https://github.com/fluxcd/website/pull/956/files#diff-ecfb308058142b2d07fc1d26094e767cbed6fef5c569a807c0f137d471440dd9R251

It's upstream documentation is at https://github.com/mfg92/hugo-shortcode-gallery

And it'd be great to mention and explain its usage in https://github.com/fluxcd/website/blob/main/content/en/contributing/docs/writing-docs.md

dholbach avatar Sep 12 '22 09:09 dholbach

@dholbach I want to work on this issue, please assign it to me.

VinayakRaoDikshit avatar Apr 02 '23 12:04 VinayakRaoDikshit

#1477 improved the situation - thanks for the PR. It might be good to add an example in addition to that, e.g.

{{< gallery match="wego*.png" sortOrder="desc" rowHeight="150" margins="5"
            thumbnailResizeOptions="600x600 q90 Lanczos"
            previewType="color" embedPreview=true >}}

and explain that this only works for page bundles.

dholbach avatar Apr 24 '23 09:04 dholbach

Alright, working on it now.

FavourDaniel avatar Apr 24 '23 15:04 FavourDaniel