Possible Blog Article: Announcing "One Good Tutorial" (BSSw Fellowship resource)

[pkgw]

Template

By making a submission here, you agree to BSSw.io content licensing terms.

You are welcome to submit an idea for a blog article or a completed article.

Please ensure your submission uses one sentence per line.

After your submission is received, it will be reviewed by the BSSw.io editorial staff and we will be in touch with you.

Submission

I'd like to contribute an article to the BSSw blog announcing the initial publication of the resource that I'm developing as part of my BSSw Fellowship: a resource for scientific software documentation called One Good Tutorial, available at onegoodtutorial.org. It's at "beta-testing" quality and ready for people in the community to check out.

I've already published a post on my personal blog about the project, but one on the BSSw blog will get it out to a (much) larger audience. The content will be a bit more formal and assume that the reader has no prior knowledge of the resource I'm describing. Publicizing on the BSSw blog is one of the deliverables on my BSSw Fellowship project plan.

[bernhold]

Hi @pkgw , thanks for reaching out. Of course we'd be happy to have a blog article about your BSSwF work. I'll work with you on it.

You can get started at any time. While we publish using Markdown, we'll accept draft blog articles in whatever format is most convenient for you. If you want to go straight to Markdown, it may be convenient to start with an existing blog article as a sort of template. If you see one with a structure you particularly like, I can point you to the source file. Otherwise, we can just choose something recent.

[pkgw]

Thanks. I'll prepare a post and plan to submit it as a pull request, unless there's a different workflow I should use?

[bernhold]

That will be fine. There are plenty of posts in the https://github.com/betterscientificsoftware/bssw.io/tree/main/Articles/Blog which you can use as templates. I encourage you to pick one of the relatively recent posts -- one that begins with YYYY-MM.