search

RITlug / ritlug.github.io

RITlug website
https://ritlug.com
Creative Commons Zero v1.0 Universal
13 stars 22 forks source link

Gallery prefab #173

Closed ct-martin closed 6 years ago

ct-martin commented 6 years ago

Some code cleanup/organization. D.R.Y. (don't repeat yourself) for image handling.

This will need to be documented, but images should now be included in the YAML front matter & use {% include content-blocks/gallery.html %} to show. Doing this creates a fancy-ish gallery & integrates with SEO. This is best used on project and event pages, but not so much for blog posts. Additionally, things like build status images (like on the Teleirc) page should not be use with this. If a gallery include is not in a page, but the page still has the images section of the front matter, it will integrate with SEO. The block has logic for if there is only one image (so still only need one reference to the image and needs no controls, but can still SEO) as well as a safeguard for if it's accidentally included on a page with no images set (in which case it will simply do nothing).

As two examples of this, the sample event page of Tim's Flock talk & the TigerOS page have been converted to use this block. Tim's page also demonstrates that when there is only one image it effectively acts as a responsive image embed.

ct-martin commented 6 years ago

Another point to mention, the front matter is also used on index pages (such as https://ritlug.com/events) like with SEO (uses first image).

ct-martin commented 6 years ago

And as a (hopefully final) note, the index & SEO functionality already exists on the site, this completes tying the whole system together in a cleaner fashion.

Tjzabel commented 6 years ago

I would highly suggest adding a comment of bullet points on the website runbook issue where you can give an overview of what needs to be documented on the website so you don't forget what you need to actually document.

Tjzabel commented 6 years ago

As far as a review, everything looks good to me. I know absolutely nothing about website development, so I will refer to @jwflory for a review on this (I think he knows a little web dev).

ct-martin commented 6 years ago

@Tjzabel: @jwflory isn't too familiar with the Jekyll aspects of developing the site (yet; I need to write some docs next month). On the contrary, @jrtechs has started learning how Jekyll works.

ct-martin commented 6 years ago

Merging since @jrtechs approved and I want to get some more done tonight