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

Add SSE article for ZFP #1961

Merged
merged 14 commits into from
Apr 26, 2024
Merged

Add SSE article for ZFP #1961

merged 14 commits into from
Apr 26, 2024

Conversation

markcmiller86
Copy link
Member

@markcmiller86 markcmiller86 commented Jan 3, 2024

This is the promised article about software sustainability engineering on ZFP. @lindstro reviewed and approved earlier today though I will leave open the possibility that a few small changes may still be needed before publication on bssw.io.

Be sure to select main as the base branch above as the target for this PR.

Provide a general summary of your changes in the title above.

Fill in the below Description section with minimal text describing the changes/new contributions in this PR and replace <...> as appropriate.

Any checklist items that do not apply can be striken out by adding ~~ to the beginning and end of the checklist item as * ~~[] <checklist-item>~~.
Also, remove the strikeout markers ~~ for the wikize_refs.py checklist items if using formal citations for bssw.io contributions.

Description

EB Member: @rinkug

PR checklist for files displayed on bssw.io site

  • [Author] @mention the BSSw.io editorial board member @<eb-member-id> in Description above assigned to shepherd your PR.
  • [ ] [Author] Add the <issue-id> in the Description above for the associated GitHub Issue.
  • [ ] [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py).
  • [Author] Inspect the content in the *.md file(s) as rendered in GitHub for this PR.
  • [EB Mem] Assign this PR to the EB member <eb-member-id>.
  • [EB Mem] Assign this PR to the author of the PR <pr-author-id>.
  • [EB Mem] Add one or more Reviewers.
  • [EB Mem] Add label content: <content-type> for the type of contribution.
  • [EB Mem] Add to Project Content Development (see Content Development).
  • [EB Mem] Add meta-data to the *.md file(s) (set Publish: yes).
  • [EB Mem] Add label preview (so PR branch will be merged to 'preview' branch and watch for possible merge failures).
  • [EB Mem] Rebuild preview site and confirm new content is there, renders correctly and is returned in searches.
  • [Author] Make any final changes to the PR based on feedback.
  • [ ] [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py).
  • [EB Mem] Rebuild preview site and re-confirm content looks correct.
  • [EB Mem] Ensure at least one reviewer signs off on the final changes.
  • [EB Mem] Move the PR to "Ready to Publish" in Content Development.
  • [EB Mem] Leave comment and @mention @betterscientificsoftware/bssw-maint (BSSw Maint) asking to carry out final publication steps.
  • [BSSw Maint] Verify that all needed files are present in the PR (article, images, updates to Site/Homepage.md carousel and/or Site/Announcements/Announcements.md as appropriate).
  • [BSSw Maint] Merge PR. (Should automatically move to "Done" in Content Development.)
  • [BSSw Maint] Verify new contribution shows up on bssw.io as expected.

NOTE:

  • Checklist items prefixed with [Author] are expected to be performed by the author of the PR or can be performed by the author.
  • Checklist items prefixed with [EB Mem] must be performed by a BSSw.io Editorial Board (EB) Member.
  • Checklist items prefixed with [BSSw Maint] must be performed by someone in the @betterscientificsoftware/bssw-maint team (hint: type @, b, s, s, w, -, m to auto-complete to @betterscientificsoftware/bssw-maint).

@markcmiller86 markcmiller86 added the preview Merge PR to the 'preview' branch to allow display on preview.bssw.io label Jan 3, 2024
@markcmiller86 markcmiller86 added the content: article-deprecated A label for article content. This was deprecated in Feb 2024 after we established blog tracks. label Jan 3, 2024
Copy link
Member

@bartlettroscoe bartlettroscoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read the article is it reads well. I think this is a good addition to BSSw.io. It would make a good featured blog article.

@markcmiller86
Copy link
Member Author

@bartlettroscoe thanks for the positive feedback 🎉 . That said, I am sheepish about merging myself because prior to ECP end, I would defer to final decision from @rinkug or maybe @bernhold or @curfman. Should I be wearinig a new thinking cap now?

@bartlettroscoe
Copy link
Member

That said, I am sheepish about merging myself because prior to ECP end, I would defer to final decision from @rinkug or maybe @bernhold or @curfman.

@markcmiller86, that is a good question. But until we define the updated process, we should not assume that a positive review by a BSSw.io editorial member is sufficient for merging an article. I think we should follow the checklist process above.

@markcmiller86
Copy link
Member Author

@betterscientificsoftware/bssw-maint this is ready for publication

@rinkug
Copy link
Member

rinkug commented Jan 9, 2024

@markcmiller86 : Thanks so much for this nice article. Minor edits - The deck text should probably change and maybe the intro could be smoother. Since there are two authors, the "I" can sound ambiguous? I can help with it pending David's feedback. @bernhold: This is an short article, kind of interview style. Can you take a look and let me know what needs to change.

@markcmiller86 markcmiller86 added the external contribution Issue or PR from outside of the BSSw editorial team label Jan 29, 2024
@bernhold bernhold added content: blog For blog content and removed content: article-deprecated A label for article content. This was deprecated in Feb 2024 after we established blog tracks. labels Feb 10, 2024
@bernhold bernhold added preview Merge PR to the 'preview' branch to allow display on preview.bssw.io and removed preview Merge PR to the 'preview' branch to allow display on preview.bssw.io labels Feb 23, 2024
markcmiller86 and others added 3 commits March 25, 2024 09:57
We don't need every occurrence of zfp to link to the website.  That becomes distracting.
@bernhold
Copy link
Member

Hi @markcmiller86, I'm editing this for publication later this week. I've taken the liberty of restructuring it to be more in the format of an interview. All I really did was to intersperse your questions into appropriate places in Peter's answers. And I moved one of Peter's paragraphs from one section (question) to another where it made more sense. Can you please give this version a quick scan and confirm that I haven't messed things up (too much)? Thanks

@markcmiller86
Copy link
Member Author

@bernhold LGTM. Thanks

Copy link

@lindstro lindstro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. I have only a couple of minor corrections.

Articles/Blog/2024-01-zfp-sse.md Outdated Show resolved Hide resolved
Articles/Blog/2024-01-zfp-sse.md Outdated Show resolved Hide resolved
@bernhold bernhold merged commit 1bc92e6 into main Apr 26, 2024
2 checks passed
@bernhold bernhold deleted the mcm86-02jan24-zfp-sse branch April 26, 2024 17:52
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.

6 participants