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
Conversation
Resolves #2031 |
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 |
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. |
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). |
That sounds good, @bernhold. I'll look out for the email, and I'll try to have the images refined for next week. |
@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. |
@rafmudaf thats a target, but I definitely want to publish it this week. Please keep me informed. |
@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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, please do that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
I've rebuilt the preview for you. |
@bernhold In my view, this is ready for any final reviews. |
minor edits for clarity
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:
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.