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
CC on bssw-tutorials.md #1677
CC on bssw-tutorials.md #1677
Conversation
@rinkug The tutorials are geared toward's better practices for scientific software development on HPC. I'm not sure the focus is correct. |
@haikudeb : Great start to the article. The article now needs more expansion as the tutorial main page has lots of rich content..... If you stating examples of recordings and slides, pls indicate that these are examples. If someone else helps edit the article significantly please consider adding them as co-author to the article |
I had the same thought about “author” on this. I wanted to put myself down as “pointer” .
… On May 11, 2023, at 4:48 PM, markcmiller86 ***@***.***> wrote:
@markcmiller86 requested changes on this pull request.
In CuratedContent/bssw-tutorials.md <#1677 (comment)>:
> @@ -0,0 +1,26 @@
+### Better Scientific Software (BSSw) Tutorial
+<!-- deck text start -->
+
+Keeping skills up to date and focused helps keep work at its best. The BSSw Tutorial page presents a vertical sampler of upcoming and past tutorials on improving scientific software.
+
+#### Contributed by [Deborah Stevens](https://github.com/haikudeb)
+#### Publication date: May 08, 2023
+
+Resource information | Details
+:--- | :---
+Article title | [The Better Scientific Software (BSSw) Tutorial](https://bssw-tutorial.github.io)
+Authors | [Deborah Stevens](https://github.com/haikudeb)
Here, we reference the author(s) of there resource we are referring to and not the author of this CC. I think listing just David here is appropriate because he has spearheaded so much of the activity on the tutorial(s) and the website hosting them.
⬇️ Suggested change
-Authors | [Deborah Stevens](https://github.com/haikudeb)
+Authors | [David Bernholdt](https://github.com/bernhold) et al. 2016-
In CuratedContent/bssw-tutorials.md <#1677 (comment)>:
> +:--- | :---
+Article title | [The Better Scientific Software (BSSw) Tutorial](https://bssw-tutorial.github.io)
+Authors | [Deborah Stevens](https://github.com/haikudeb)
+Focus | Software Engineering Tutorials
+Website | https://bssw-tutorial.github.io
+
+
+The website https://bssw-tutorial.github.io contains the information and learning materials needed for best practices in high performance computing.
+
+Whether a refresher or new insight on high performance computing is needed, this complete collection of all BSSw tutorial presentations (2016-present) exists for your perusal. [Full recordings](https://www.youtube.com/playlist?list=PLuWzStas9iWExOVGGLCUl-N38mxQXSl87) are available as are [presentation slides through FigShare] (https://figshare.com/articles/presentation/Better_Scientific_Software_tutorial_Improving_Scientific_Software_2022_/19416767). Also access to the tutorial-related Hands On Code Repository is a quick click to GitHub : https://github.com/bssw-tutorial/hello-numerical-world-2021-11-15-sc
+
+The Better Software Scientific Tutorial page is an excellent reference in many ways. Reviewing the best practices for high performance computing via the
+
+<!---
+Publish: yes
+Topics: Better Skills Better Planning Better Collaboration--Conferences and Workshops
The way the Topics: metadata works is you go look at sub-topics in various of the files here <https://github.com/betterscientificsoftware/bssw.io/tree/master/Site/Topics> and then copy, verbatim, sub-topic headings that are relevant to the content. In this case, the tutorial covers a lot of ground and so a lot of topics apply...
⬇️ Suggested change
-Topics: Better Skills Better Planning Better Collaboration--Conferences and Workshops
+Topics: Software Engineering, Online Learning, In-Person Learning, Software Process Improvement, Development Tools, Refactoring, Licensing, Testing
In CuratedContent/bssw-tutorials.md <#1677 (comment)>:
> +#### Contributed by [Deborah Stevens](https://github.com/haikudeb)
+#### Publication date: May 08, 2023
+
+Resource information | Details
+:--- | :---
+Article title | [The Better Scientific Software (BSSw) Tutorial](https://bssw-tutorial.github.io)
+Authors | [Deborah Stevens](https://github.com/haikudeb)
+Focus | Software Engineering Tutorials
+Website | https://bssw-tutorial.github.io
+
+
+The website https://bssw-tutorial.github.io contains the information and learning materials needed for best practices in high performance computing.
+
+Whether a refresher or new insight on high performance computing is needed, this complete collection of all BSSw tutorial presentations (2016-present) exists for your perusal. [Full recordings](https://www.youtube.com/playlist?list=PLuWzStas9iWExOVGGLCUl-N38mxQXSl87) are available as are [presentation slides through FigShare] (https://figshare.com/articles/presentation/Better_Scientific_Software_tutorial_Improving_Scientific_Software_2022_/19416767). Also access to the tutorial-related Hands On Code Repository is a quick click to GitHub : https://github.com/bssw-tutorial/hello-numerical-world-2021-11-15-sc
+
+The Better Software Scientific Tutorial page is an excellent reference in many ways. Reviewing the best practices for high performance computing via the
Did you have a chance to finish your thought here? It looks like the sentence got truncated.
In CuratedContent/bssw-tutorials.md <#1677 (comment)>:
> +<!-- deck text start -->
+
+Keeping skills up to date and focused helps keep work at its best. The BSSw Tutorial page presents a vertical sampler of upcoming and past tutorials on improving scientific software.
+
+#### Contributed by [Deborah Stevens](https://github.com/haikudeb)
+#### Publication date: May 08, 2023
+
+Resource information | Details
+:--- | :---
+Article title | [The Better Scientific Software (BSSw) Tutorial](https://bssw-tutorial.github.io)
+Authors | [Deborah Stevens](https://github.com/haikudeb)
+Focus | Software Engineering Tutorials
+Website | https://bssw-tutorial.github.io
+
+
+The website https://bssw-tutorial.github.io contains the information and learning materials needed for best practices in high performance computing.
⬇️ Suggested change
-The website https://bssw-tutorial.github.io contains the information and learning materials needed for best practices in high performance computing.
+The website https://bssw-tutorial.github.io contains information and training resources for learning about best practices in high performance computing.
In CuratedContent/bssw-tutorials.md <#1677 (comment)>:
> +Keeping skills up to date and focused helps keep work at its best. The BSSw Tutorial page presents a vertical sampler of upcoming and past tutorials on improving scientific software.
+
+#### Contributed by [Deborah Stevens](https://github.com/haikudeb)
+#### Publication date: May 08, 2023
+
+Resource information | Details
+:--- | :---
+Article title | [The Better Scientific Software (BSSw) Tutorial](https://bssw-tutorial.github.io)
+Authors | [Deborah Stevens](https://github.com/haikudeb)
+Focus | Software Engineering Tutorials
+Website | https://bssw-tutorial.github.io
+
+
+The website https://bssw-tutorial.github.io contains the information and learning materials needed for best practices in high performance computing.
+
+Whether a refresher or new insight on high performance computing is needed, this complete collection of all BSSw tutorial presentations (2016-present) exists for your perusal. [Full recordings](https://www.youtube.com/playlist?list=PLuWzStas9iWExOVGGLCUl-N38mxQXSl87) are available as are [presentation slides through FigShare] (https://figshare.com/articles/presentation/Better_Scientific_Software_tutorial_Improving_Scientific_Software_2022_/19416767). Also access to the tutorial-related Hands On Code Repository is a quick click to GitHub : https://github.com/bssw-tutorial/hello-numerical-world-2021-11-15-sc
I recommend splitting into a sentence per line. I also added a disclaimer about overlapping content too.
⬇️ Suggested change
-Whether a refresher or new insight on high performance computing is needed, this complete collection of all BSSw tutorial presentations (2016-present) exists for your perusal. [Full recordings](https://www.youtube.com/playlist?list=PLuWzStas9iWExOVGGLCUl-N38mxQXSl87) are available as are [presentation slides through FigShare] (https://figshare.com/articles/presentation/Better_Scientific_Software_tutorial_Improving_Scientific_Software_2022_/19416767). Also access to the tutorial-related Hands On Code Repository is a quick click to GitHub : https://github.com/bssw-tutorial/hello-numerical-world-2021-11-15-sc
+Whether a refresher or new insight on high performance computing is needed, this complete collection of all BSSw tutorial presentations (2016-present) exists for your perusal.
+There is some overlap of content between the various tutorials presented due to focus of venue where a given presentation was hosted.
+For each tutorial, available resources variously include the slide deck, the video recording and in some cases, the repository of hands-on code accompanying the tutorial lessons such as the [Hellow Numerical World](https://github.com/bssw-tutorial/hello-numerical-world-2021-11-15-sc) repository.
On CuratedContent/bssw-tutorials.md <#1677 (comment)>:
@haikudeb <https://github.com/haikudeb> this is a great start 💪🏻
In the comments below, you will see some suggested changes along with a nearby button to "commit suggestion". If you accept the suggestion, just hitting that button will merge my proposed changes into yours.
It looks like you didn't complete the last sentence and so I added a remark about that too. As you go through your response to my review here, once you feel you have resolved an issue I raised, you are welcome to also hit the Resolved button indicating you addressed it.
Thanks for doing this.
—
Reply to this email directly, view it on GitHub <#1677 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AO5AZBJHPUBQUHGCPV27TS3XFVGB3ANCNFSM6AAAAAAX5A5NLI>.
You are receiving this because you were mentioned.
|
Deb, you're the contributor of the article. There's a separate place for that. The table is about the resource. That's the easy way to think about it. As to content of the author field for this particular resource, I'd suggest |
@haikudeb and @markcmiller86 - please consider checking which curated content "resource type" this article really fits into and then select the right table format. To me, its more or a website style of resource (which has a different table than what has been used for this article) but it may different to you: https://betterscientificsoftware.github.io/bssw.io/bssw_styling_curated.html |
resolve overlapping content Co-authored-by: Mark (he/his) C. Miller <miller86@llnl.gov>
wording Co-authored-by: Mark (he/his) C. Miller <miller86@llnl.gov>
Rinku and others: Where do I do the editing on this? Is it now into the master branch within bssw ? or do I edit in the haikudeb repo? I'm puzzled as to where it is now (with a partial PR) in the GitHub space?? |
@haikudeb : I found the below text which I had drafted some time ago for a presentation I gave on ideas project. You can take this text or parts of it for your cc, if you wish. The website https://bssw-tutorial.github.io/ serves as a comprehensive repository of tutorials presented by the IDEAS Productivity team at various online and physical conferences, workshops, and events. It houses a wealth of educational material for each event, including slides, handouts, resource lists, hands-on exercises, and contact information. The website goes beyond providing just the tutorial content; it also offers links to recordings for tutorial talks, allowing users to access the presentations and discussions even if they couldn't attend the event in person. Moreover, the website features a list of past tutorials, giving visitors the opportunity to explore a wide range of topics covered in the past. Additionally, users can find information about upcoming tutorials, making it a valuable resource for planning future learning opportunities. With its extensive collection of materials and comprehensive support, the website serves as a hub for those seeking to enhance their software skills in the domain of computational science and engineering. |
You can go to the "Files changed" tab above and click on "Edit file" from the dropdown box... |
@rinkug , there is a tutorial/webinar/podcast/courses style of resource and so I will re-style it as such. |
@rinkug with this commit, I think this is ready to merge up the chain and then onto `master`
@betterscientificsoftware/bssw-maint this is ready for final steps in publication |
Author: @haikudeb
EB Member: @markcmiller86
Resolves #1501
PR checklist for files displayed on bssw.io site
@mention
the BSSw.io editorial board member@<eb-member-id>
in Description above assigned to shepherd your PR.<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])*.md
file(s) as rendered in GitHub for this PR.<eb-member-id>
.<pr-author-id>
.content: <content-type>
for the type of contribution.Content Development
(see [Content Development]).*.md
file(s) (setPublish: yes
).preview
(so PR branch will be merged to 'preview' branch and watch for possible merge failures).[ ] [Author] Ensurewikize_refs.py -i <base>.md
is run and commit (if using [wikize_refs.py]).@betterscientificsoftware/bssw-maint
(BSSw Maint) asking to carry out final publication steps.