cerner / cerner.github.io

Cerner Engineering blog
https://engineering.cerner.com
14 stars 28 forks source link

Adding Inspec Delta OSS post #171

Closed cchesser closed 3 years ago

cchesser commented 3 years ago

Adding Inspect Delta OSS announcement for publishing on May 11th.

jrperron88-zz commented 3 years ago

Caught a couple issues. Remove "previous stig" in this line Utilizing inspec_delta, developers will feed the previous STIG, the new STIG, and the profile, into the tool.

Looks like the numbering reverted to 1 instead of 9 on this line. Once all changes are complete, the feature branch is then compared against the dev branch where code owners and applicable tech experts will then plus +1 the changes.

rockhold commented 3 years ago

The opening 'Problem' header renders a bit oddly in the summary of the post. It'll likely come across as a grammar mistake. image

cchesser commented 3 years ago

@rockhold - yeah, that is a byproduct of the Hugo summary capture. I would be fine with removing that heading, since it serves as an intro anyway.

cchesser commented 3 years ago

@jrperron88, I applied your feedback in 0f4ef400819761cd8aae4f2c0f5c5bdefe929b3a.

cchesser commented 3 years ago

The opening 'Problem' header renders a bit oddly in the summary of the post. It'll likely come across as a grammar mistake.

@rockhold , removed the Problem header in fd43b0a.

rockhold commented 3 years ago

I didn't have a chance to review this internally before it was up for PR, but I'll share some high-level thoughts on the organization of the content, in case you'd like to make any changes before this is published.

At a high level, this is the current flow of the content:

Putting myself in the shoes of someone external to Cerner who knows nothing about this project or the purpose of this blog post, it seems like there would be quite a bit of reading before I get to the part that hooks me - the "what's in it for me" piece. Currently, the announcement that we've open-sourced this project and that it can provide benefits to some specific audience is mostly at the end of the blog post.

Thinking back to some of the other announcements for open-source projects we've done, I really like how this one for Carbon Graphs was organized, as it has a nice opening statement to help people understand what the blog post is about: https://engineering.cerner.com/blog/carbon-graphs-open-source-visualization-api/

I also like how this one on Terra that touches on the audience in the 'Who is Terra UI for?' section: https://engineering.cerner.com/blog/terra-ui/

cchesser commented 3 years ago

@rockhold, let me take a stab at making an intro paragraph which help solve that challenge without having too change too much else on the blog. This could help address this announcement, what this will explain, and how this can help you.

cchesser commented 3 years ago

@rockhold / @jrperron88, I have added the following intro paragraph to help more highlight the OSS Project and to categorize the background. b69b3ab

Today, we are excited to announce our newest addition in our open-source family, Inspec Delta! In this blog post, we will explain how this is utilized at Cerner to reduce the time in comparing updated infrastructure security benchmarks. Whether you are new to automating your security compliance or have had to deal with maintaining updates to existing benchmarks, this blog post is for you!

I also made a few tweaks to reference "Inspec Delta" vs. "inspec_delta" that is talking about the project vs. just the command-line reference.

rockhold commented 3 years ago

I like that opening paragraph, @cchesser. I don't seem to be able to preview it at the moment, though, as the latest deployment above is broken. Assuming no other issues, though, that takes care of my comments. +1

cchesser commented 3 years ago

Currently deployment is working if you are wanting to view the preview. @jrperron88 - does the intro paragraph that I added work for you? If so, I will go ahead and get that published.

jrperron88-zz commented 3 years ago

Looks wonderful to me!

cchesser commented 3 years ago

Sounds good, will go ahead and publish.