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

RRP repo doc updates and cleanup #143

Merged
merged 17 commits into from
Jan 2, 2024
Merged

Conversation

sjspielman
Copy link
Member

Stacked on #134

This PR updates some items I noticed should happen when I was reviewing #134.

There are a couple "bigger" changes I jumped the gun on a little bit, so tagging in @jashapiro to tell me if I went too far without discussing things first! Specifically, we really don't seem to use/need the slides/*url files, so I removed this directory and in the new README I indicate that slide links are available in the schedule directly. In addition, I renamed all the instructor notes to be in their own order of presentation.

For @Jen-OMalley, any feedback on README wording (there are 2 READMEs heres!) let me know!

@jashapiro
Copy link
Member

jashapiro commented Oct 26, 2023

I like the slides folder, so I would keep it (but update any URLs that need updating). I found it handy for going right to the slides when working on them. We should add in the data sharing slides as well, I expect.

@sjspielman
Copy link
Member Author

I like the slides folder, so I would keep it (but update any URLs that need updating). I found it handy for going right to the slides when working on them. We should add in the data sharing as well, I expect then.

Thanks @jashapiro, reversions incoming!

One "motivation" I actually had here was keeping numbering consistent since we added a slide in the middle...and rather than changing all the numbers and maintaining those numbers over time I burned it all down....
Would you feel ok if I restored this directory but didn't number the files in order? They'd be numbered in the README!

@jashapiro
Copy link
Member

Would you feel ok if I restored this directory but didn't number the files in order? They'd be numbered in the README!

Personally, I would keep them numbered. But I don't feel particularly strongly about it.

@sjspielman
Copy link
Member Author

@jashapiro Back to how it all was before after my gratuitous 🎢 but with updated numbers!
@Jen-OMalley, now it's definitely ready for you. In addition to docs to review, there are now also file name changes for slide ordering and a new slide file to insert data sharing.

Copy link
Collaborator

@Jen-OMalley Jen-OMalley left a comment

Choose a reason for hiding this comment

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

All LGTM!

@sjspielman sjspielman changed the base branch from jen-omalley/rrp-external-workshops to main January 2, 2024 14:58
@sjspielman
Copy link
Member Author

sjspielman commented Jan 2, 2024

@Jen-OMalley I went through this and made sure everything is where it should be!

  • Instructor notes numbering matches associated slide numbering
  • All slide links work
  • All READMEs contain the correct content

Give me a 👍 here if you agree that I got everything where it should be, and I'll go ahead and wrap this up at long last 🙃

@Jen-OMalley
Copy link
Collaborator

Thumbs up given!👍🏻 LGTM @sjspielman!

@sjspielman sjspielman merged commit 6646d2a into main Jan 2, 2024
1 check passed
@sjspielman sjspielman deleted the sjspielman/rrp-repo-updates branch January 2, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants