How to Publish the Weekly Cybersecurity Debrief
- NOTES:
- Uses “John Smith” as an example name; replace with your name where needed.
- Uses “June 11, 2022” as the date of the debrief; replace with the date for your post where needed.
- Git yourself set up…in git.
- Clone the blog repo locally: https://github.com/himaxwell/himaxwell.github.io
- If you already have the repo locally, make sure you’re up-to-date:
git checkout master && git pull
- Create a new branch for your post:
git checkout -b jsmith/2022-06-11-security-debrief
- Create the file for your post.
- Things to note:
- Jekyll publishes the post on the date in the post’s name; the file
_posts/3022-01-01-my-post.md
won’t publish until January 1, 3022. - Thus, even though the debrief covers say the week of June 05 (Sunday) - 11 (Saturday) 2022, if we want the post published on Friday, June 10, we will need to name the post accordingly.
- Jekyll publishes the post on the date in the post’s name; the file
- Create a new file under
_posts
, being sure to use the day you’d like the post to publish as the first part of the post’s name. For a post that’s for the week of June 05-11, 2022 that we want published on Friday, June 10, 2022, we would create the file:
_posts/2022-06-10-cybersecurity-debrief-2022-06-11.md
.
- Things to note:
- Every day of the week, spend 15-20 minutes updating the post with content.
- NOTE: A few things to note re. writing your post:
- Jekyll does not automatically parse links for you when compiling your pst. This is a bit surprising if you’re used to links to straight URLs being automatically parsed for you.
- Thus, if you want to link to Google.com and have the link be clickable by your readers, you need to do:
[https://google.com](https://google.com)
- You can put any text you want in the square brackets and it will be rendered as the text that the user sees.
- Thus, if you want to link to Google.com and have the link be clickable by your readers, you need to do:
- There are a few ways to preview how your published post will look:
- The for this repo README mentions using the “_drafts” folder for writing/previewing your post. However, since your post is in the “_posts” folder, Jekyll should show your post no matter what if you run the Jekyll preview command in the REDME.
- Alternately, many code editors like Atom have a built-in markdown preview function, or you can probably add such functionality via a plugin.
- Jekyll does not automatically parse links for you when compiling your pst. This is a bit surprising if you’re used to links to straight URLs being automatically parsed for you.
- Update the “Major News Stories” section with the week’s biggest cybersecurity stories. Some good outlets to keep an eye on:
- Listen to the daily “Internet Stormcast” from SANS: https://isc.sans.edu/podcast.html
- Listen to the week’s “Security Now” episode: https://twit.tv/shows/security-now
- Keep an eye on Hacker News: https://news.ycombinator.com
- Update the “A few interesting deep-dive reads from the week” sub-section with any stories that are of interest but not necessarily headline-worthy.
- Update the “Other Software with Critical Patches Available” section with any major/well-known software that had an update during the week. Some ones to watch include:
- Zoom
- Browsers (Google Chrome, Mozilla Firefox, etc.)
- Any of the major operating systems (Windows, Mac, and Linux)
- Update the “Learning” section with 3-4 paragraphs on a cybersecurity topic of your choice.
- Please make sure this section is well-researched and has citations where needed/appropriate.
- NOTE: A few things to note re. writing your post:
- Publish the post on the Friday of the week being covered.
- Create a PR for your branch ->
master
in Github.- IMPORTANT: Be sure that the base for your PR is
master
in thehimaxwell/himaxwell.github.io
repo.- Because our repo was forked off of
barryclark/jekyll-now
, Github will automatically think you want to merge there! - You don’t! You want to merge to
master
in thehimaxwell/himaxwell.github.io
repo.
- Because our repo was forked off of
- IMPORTANT: Be sure that the base for your PR is
- Merge your PR with a commit message like:
Add June 11, 2022 Cybersecurity Debrief #<PR Number Here>
- Since these posts happen on a weekly basis, they’ve been approved for merging without PR review.
- Please do help us put our best foot forward by running a spell check on your post in Pages or something, just to catch any obvious spelling/grammar errors.
- Also, feel free to request review in the #guild-eng-security Slack channel if you would like others to look over anything specific.
- Since these posts happen on a weekly basis, they’ve been approved for merging without PR review.
- The merge will kick off a Github action to rebuild and publish the site with your new post.
- Check the status of the build/publish action here: https://github.com/himaxwell/himaxwell.github.io/actions
- Once the action completes, check the blog to make sure your post was published and looks great: https://engineering.himaxwell.com
- Post a message with the URL to your published post in the #guild-eng-security Slack channel.
- Create a PR for your branch ->