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

BSSwF blog post - visually communicating design #2032

Merged
merged 15 commits into from May 15, 2024

Conversation

rafmudaf
Copy link
Contributor

@rafmudaf rafmudaf commented Mar 7, 2024

This pull request adds a blog post that is part of my 2023 BSSw Fellowship on visually communicating elements of software design. I'd like to start the review process, but there are at least a few things left to do:

  • Add captions and numbers to figures
  • Refine the layout of the images on the page

Note that some of the content linked in the blog post has not yet been finished, so this pull request should not be merged yet.

@github-actions github-actions bot added the external contribution Issue or PR from outside of the BSSw editorial team label Mar 7, 2024
@bernhold bernhold self-assigned this Mar 7, 2024
@bernhold bernhold added the content: blog For blog content label Mar 7, 2024
@bernhold bernhold marked this pull request as draft March 7, 2024 02:24
@bernhold
Copy link
Member

bernhold commented Mar 7, 2024

Resolves #2031

@gonsie gonsie self-assigned this Mar 20, 2024
@bernhold bernhold requested a review from gonsie March 22, 2024 21:37
@bernhold bernhold added this to In progress in Content Development Mar 22, 2024
@bernhold bernhold moved this from In progress to Item review in Content Development Mar 30, 2024
@bernhold
Copy link
Member

bernhold commented May 2, 2024

Hi @rafmudaf , @gonsie mentioned that you wanted to make some edits to your blog post. I plan to start work preparing your article for posting next week (the week of 6 May). It would be most helpful if you could make your changes before then and let me know that it is ready from your perspective. Thanks

@rafmudaf
Copy link
Contributor Author

rafmudaf commented May 2, 2024

Hi @bernhold I've made the changes I discussed with @gonsie.

I think there might be some work to do to improve the readability and layout of the images. Is it straightforward to build the website locally? I watched the BSSw io Tutorial video hoping to get some insight into building the docs site, but I think I've included the topics in that video in my process already.

@bernhold
Copy link
Member

bernhold commented May 3, 2024

Hi @rafmudaf , unfortunately, there is no capability to build the site locally. I can work with you on the images. We do have a preview site that you'll be able to see how they look, but only the BSSw.io editorial team can rebuild it. So there will be a bit of back and forth. I'll try to get a preview up for you this weekend and email you when that's ready (we try not to expose the info in public to avoid attracting troublemakers).

@rafmudaf
Copy link
Contributor Author

rafmudaf commented May 3, 2024

That sounds good, @bernhold. I'll look out for the email, and I'll try to have the images refined for next week.

@bernhold bernhold added the preview Merge PR to the 'preview' branch to allow display on preview.bssw.io label May 4, 2024
@rafmudaf
Copy link
Contributor Author

rafmudaf commented May 10, 2024

@bernhold I have a bit more work to do on this post. I saw that you listed the publish date as May 14. Is that my deadline for changes?

Specifically, I'd like to improve Figure 3 a bit and also improve the overall flow of the article. Since it was much longer initially, I removed whole sections and now it's somewhat choppy when you read it straight through. I made some improvements today, but I'd like to continue to iterate on it.

@bernhold
Copy link
Member

@rafmudaf thats a target, but I definitely want to publish it this week. Please keep me informed.

@rafmudaf
Copy link
Contributor Author

@davidbernholdt I've removed some of the text in that third image, so I think it will ultimately look bigger and a bit more readable.


Through the BSSw Fellowship, I've had the opportunity to gather and formalize ideas on documentation and communication on software design.
I presented at the NLIT S3C conference in April 2024 ([slides](https://rafmudaf.github.io/communicating-design/_downloads/67486fd27e6ced8dd8672408a18de874/nlit_s3c.pdf))
and will present an [HPC Best Practices webinar](https://ideas-productivity.org/resources/series/hpc-best-practices-webinars/) in June 2024.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bernhold should this link be replaced with the one for the webinar?
https://ideas-productivity.org/events/hpcbp-084-communicatingdesign

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, please do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@bernhold
Copy link
Member

I've rebuilt the preview for you.

@rafmudaf
Copy link
Contributor Author

@bernhold In my view, this is ready for any final reviews.

@rafmudaf rafmudaf marked this pull request as ready for review May 14, 2024 22:24
@bernhold bernhold merged commit 62f84f9 into betterscientificsoftware:main May 15, 2024
2 checks passed
Content Development automation moved this from Item review to Ready for digest May 15, 2024
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
Content Development
  
Ready for digest
Development

Successfully merging this pull request may close these issues.

None yet

4 participants