Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft Blog Post #2040

Merged
merged 18 commits into from
Jun 26, 2024
Merged

Draft Blog Post #2040

merged 18 commits into from
Jun 26, 2024

Conversation

whart222
Copy link
Contributor

Hello BSSw Team,

One of the deliverables for my BSSw Fellowship is a blog post on the bssw.io site. This is a draft of that blog post that is ready for editorial review.

Note that further details regarding this deep dive are included in two separate blog posts that I published recently.

--Bill

@github-actions github-actions bot added the external contribution Issue or PR from outside of the BSSw editorial team label Mar 22, 2024
@bernhold
Copy link
Member

Thanks @whart222, I'll put this in our publication queue and I'll let you know when I start working on it.

@bernhold bernhold self-assigned this Mar 22, 2024
@bernhold bernhold added the content: blog For blog content label Mar 22, 2024
@bernhold bernhold requested a review from gonsie March 22, 2024 17:42
@bernhold bernhold added the preview Merge PR to the 'preview' branch to allow display on preview.bssw.io label May 22, 2024
The preview site is behaving very strangely for this article.  The hero is repeated after the first paragraph (before the figure that's intended to be there).  Removing the figure to see if that corrects the hero duplication.
Lack of a leading - on the hero image reference.
@bernhold
Copy link
Member

Hi @whart222 , as you've probably noticed, I've made an initial edit pass through your blog article. I made some changes to your text for clarity. I think there are also several ways this article could be improved.

  1. I think most in our community do not know what SBOM is or why they should care. I think it would be a good idea if the article provided some additional background/motivational information.
  2. Because Fortran is still an important programming language in our community, it would be nice if you could find something to say about SBOMs for Fortran codes. Maybe the the answer is that no one seems to be working on this, but if that's so, maybe you can at least say that rather than leaving out Fortran entirely? Although maybe the cmake-sbom tool, or some evolution of it, could potentially be used with Fortran codes too?

I've planted some text in the article to try to provide the seeds of addressing my points above (look for the bold text), but I'd appreciate it if you could respond in your own way.

Also, I have some concerns about the image you proposed for the hero. First of all, it is not a great match for our guidelines for hero images, but I think it is potentially useful to help readers understand what goes into an SBOM. So I've moved it into the body. But also, the image comes from a company's website. Normally, we use only images that we host in our own repository, and I'm checking whether there are any technical concerns about referring to another site. (Besides the obvious possibility that they'll move or remove the image on us, without notice.) But also, do you have permission from the company to use it? Legally, maybe it is okay if we reference it instead of taking a copy and hosting it ourselves, but I'm not sure we would want to go there. I think our designers could create an equivalent diagram without too much trouble, but I'm not sure we have time to do it.

I'm hoping that you will be able to address these matters quickly and easily. Our target for publication is Tuesday 28 May, and with the Monday holiday, I know that's not a lot of time. Let me know if you think it will be a problem.

Thanks!

@whart222
Copy link
Contributor Author

Hi, Dave. I'm not sure what to recommend w.r.t. the image. I'm comfortable using a different image, but I don't know that there is a canonical "free" image to use here.

@bernhold
Copy link
Member

Let me see if our designers could quickly do something for us. It would like better anyway -- color and style more consistent with our preferences.

The C++ SBOM post concerned methods that have broader application, so I noted that here.
Some of the packages referenced really are specific to C/C++.  But the CMake capabilities that are highlighted are more generic.
I took a stab at reworking the bolded text.
@whart222
Copy link
Contributor Author

I took a stab at revising the text you bolded. I left the second sentence bolded, as it captures a key motivation for members of the scientific software community.

Let me know if you have other questions or concerns.

@bernhold
Copy link
Member

Hi @whart222, I was wondering what your status is? Do you feel that you've addressed all of my comments/requests?

I think we'll need to delay publication a bit regardless. We still need an editorial pass, which probably can't happen today, and our designers are working on a replacement for the SBOM graphic, which I haven't received yet.

@bernhold
Copy link
Member

bernhold commented Jun 6, 2024

@whart222 please confirm that you're done with the changes you wanted to make. I know you've been hands-off for a while now, but a direct confirmation would be helpful. Thanks

@whart222
Copy link
Contributor Author

whart222 commented Jun 6, 2024

Yes, I think so. Do you have any questions or concerns about my edits?

@bernhold
Copy link
Member

bernhold commented Jun 6, 2024

Thanks. It will be a couple of days before I can take a careful look at it, but initially, they look good.

Updating pub date and qualifying vcpkg as best package manager for SBOMs, since I know Spack and probably conan are working on SBOM support.
@bernhold bernhold merged commit df6ad12 into betterscientificsoftware:main Jun 26, 2024
2 checks passed
@bernhold
Copy link
Member

Accidentally merged prematurely. Reverted by #2114 and recreated in #2115.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content: blog For blog content external contribution Issue or PR from outside of the BSSw editorial team preview Merge PR to the 'preview' branch to allow display on preview.bssw.io
Projects
Development

Successfully merging this pull request may close these issues.

2 participants