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

CC on bssw-tutorials.md #1677

Merged
merged 12 commits into from May 25, 2023
Merged

CC on bssw-tutorials.md #1677

merged 12 commits into from May 25, 2023

Conversation

rinkug
Copy link
Member

@rinkug rinkug commented May 10, 2023

Author: @haikudeb
EB Member: @markcmiller86

Resolves #1501

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.

@rinkug rinkug added the content: curated For curated content label May 10, 2023
@pagrubel
Copy link
Member

@rinkug The tutorials are geared toward's better practices for scientific software development on HPC. I'm not sure the focus is correct.

@rinkug
Copy link
Member Author

rinkug commented May 11, 2023

@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

@markcmiller86 markcmiller86 self-requested a review May 11, 2023 17:43
@markcmiller86 markcmiller86 self-assigned this May 11, 2023
CuratedContent/bssw-tutorials.md Outdated Show resolved Hide resolved
CuratedContent/bssw-tutorials.md Outdated Show resolved Hide resolved
CuratedContent/bssw-tutorials.md Outdated Show resolved Hide resolved
CuratedContent/bssw-tutorials.md Outdated Show resolved Hide resolved
CuratedContent/bssw-tutorials.md Outdated Show resolved Hide resolved
CuratedContent/bssw-tutorials.md Show resolved Hide resolved
@haikudeb
Copy link
Contributor

haikudeb commented May 12, 2023 via email

@bernhold
Copy link
Member

I had the same thought about “author” on this. I wanted to put myself down as “pointer” .

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 [IDEAS Productivity project](mailto:IDEASProductivity@gmail.com) because that's what the page shows (at the bottom). Alternatively, you could use the bssw-tutorial email address which is give several places as our preferred contact about the tutorials. Mark suggests me, et al. because he happens to know some behind the scenes information about this activity. But that's our public face.

@rinkug
Copy link
Member Author

rinkug commented May 12, 2023

@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

haikudeb and others added 2 commits May 22, 2023 06:25
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>
@haikudeb
Copy link
Contributor

@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

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??

@rinkug
Copy link
Member Author

rinkug commented May 22, 2023

@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.

@rinkug
Copy link
Member Author

rinkug commented May 22, 2023

@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

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??

You can go to the "Files changed" tab above and click on "Edit file" from the dropdown box...

@markcmiller86
Copy link
Member

markcmiller86 commented May 25, 2023

To me, its more or a website style of resource

@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`
@markcmiller86 markcmiller86 added the preview Merge PR to the 'preview' branch to allow display on preview.bssw.io label May 25, 2023
@markcmiller86 markcmiller86 added this to Item review in Content Development May 25, 2023
Content Development automation moved this from Item review to Ready to publish May 25, 2023
@markcmiller86
Copy link
Member

@betterscientificsoftware/bssw-maint this is ready for final steps in publication

@rinkug rinkug merged commit 3f783dd into master May 25, 2023
@rinkug rinkug deleted the rinkug-patch-1 branch May 25, 2023 20:55
Content Development automation moved this from Ready to publish to Done May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content: curated For curated content 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.

BSSw tutorials
5 participants