initial draft of the security audit blog post

[wmorgan]

No description provided.

[travisbeckham]

This looks good with one comment on the frontmatter.

Also, when creating blog posts, it's best if you run Hugo locally so all of the images will be generated and checked in to the repo.

[wmorgan]

Also, when creating blog posts, it's best if you run Hugo locally so all of the images will be generated and checked in to the repo.

@travisbeckham To confirm, I should check in the resources/_gen/image directory?

[travisbeckham]

@travisbeckham To confirm, I should check in the resources/_gen/image directory?

@wmorgan Yes, this is correct. Here's a bit of background on why it works this way...

The resources/_gen/images directory is included in source control because this is where Hugo caches processed images. Each time Hugo is built, it resizes blog images to reasonable sizes, creates thumbnails, then saves them in this directory. If we don't include this directory in source control, Hugo would have to regenerate all of the blog images every time the site is published, resulting is slow build times.

The reason why I implemented this process is because we had blog post cover images that were several megabytes in size that were also being used as thumbnail images.

This process does create some irritation though...

Unfortunately, if we don't run hugo locally when creating a new blog post, the images will get created at build time and not be added to source control. This means the next PR where the images are generated locally will include them, which is not ideal. I also realized that this requirement is not documented in the readme, so if we keep this process, I will get make note of it.

To add another irritation to this, Hugo has now changed the naming structure of generated images a couple times. This means that we currently have to be all running version v0.131.0 - v0.141.0, otherwise we'll encounter a renaming mess.

If it is cumbersome having Hugo process the blog images, we can certainly reevaluate this. We'd just need to manually ensure all blog images are created within certain guidelines.

[wmorgan]

Current plan is to publish this on Tuesday 2/18