-
Notifications
You must be signed in to change notification settings - Fork 71
[BLOG] pyOS SciPy workshop post #427
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
Conversation
pre-commit.ci autofix |
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.
Ok this is looking great!
@kierisi i used your google doc and turned it into a markdown file in our code workshop repo. i provided a link in my comments here.
we don't need install python anymore because hatch installs python.
We also want them to clone / download the sample repo so we can link to that and the demo package repository.
Finally i am suggesting moving up the agenda to ABOVE the instructions and turning it into a table. i can add styles to make the table prettier if you have ideas for that too. this is super close however! thank you
` workshop at SciPy 2024. Read on to learn more!" | ||
author: "Jesse Mostipak" | ||
permalink: /blog/pyos-workshop-scipy-2024.html | ||
header: |
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.
@kierisi to ensure we can find and reuse banners - let's start to store ALL banners in this directory here: https://github.com/pyOpenSci/pyopensci.github.io/tree/main/images/headers
images really bloat a github repo and ours will get big over time. the more we can reuse easily, the better. the blog/month image idea works for blog posts if the images are always unique. but banners should be reusable so we want to ensure we have a folder of them in one place that is not year /month specific.
id say the same for blog posts that have graphics that we reuse elsewhere - we would want categorical folders rather than date/month (i learned this the hard way on the last website i built after a few years the git repo was 1gb!). so organizing now is great. let's move this to the headers folder!
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.
fixed
header: | ||
overlay_image: images/blog/2024/june/scipy-2024-workshop.png | ||
overlay_filter: rgba(20, 13, 36, 0.8) | ||
categories: |
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.
let's add an "events" category here. then i can make a page that only lists events as cards similar to the blog post listing... but we can customize the cards to have little calendar icons or something and then have a upcoming events at the top listing with quick overviews.
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.
fixed
* An environment manager | ||
* Hatch | ||
|
||
### Install Python using `conda` and the `conda-forge` channel |
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.
can you please remove the install python section? i think that was in that issue that i linked in the asana task maybe but it was in my very first comment. hatch will install python for them! yay! so we can remove it.
i took your google doc and added to our github repo here:
https://github.com/pyOpenSci/code-to-module-workshop/tree/main so you can essentially reuse the info in that markdown file here (it's almost the same but i removed the python piece.
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 copied and pasted your content from https://github.com/pyOpenSci/code-to-module-workshop/tree/main, starting at the Hatch & Python section, and going all the way through to, and including, the Useful Commands. let me know if you want that changed.
|
||
* **What:** A hands-on workshop, titled: [Create Your First Python Package: Make Your Python Code Easier to Share and Use](https://cfp.scipy.org/2024/talk/QT9GBY/) | ||
* **Where:** [SciPy 2024](https://www.scipy2024.scipy.org/), Room 316 | ||
* **When:** Tuesday, July 9th, 2024, from 13:30--17:30 Pacific |
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.
Let's add the repository link for the workshop here:
- https://github.com/pyOpenSci/code-to-module-workshop/
- and the demo python package - https://github.com/pyOpenSci/pyosPackage
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.
fixed
* Our [example Python package repo, `pyosPackage`](https://github.com/pyOpenSci/pyosPackage), that goes along with pyOpenSci tutorials. | ||
* [Workshop information on the SciPy 2024 website](https://cfp.scipy.org/2024/talk/QT9GBY/). | ||
|
||
## Workshop agenda |
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.
Let's structure this page as follows
- the what when where at the top like you have!
- the workshop agenda
- setup instructions last.
then, can you please see if making the agenda a table looks ok? ideally a table is nice because we can separate out each hour and overview specific events during that hour (and provide links).
i can style the table to look more nice if it doesn't look nice using our default theme. see if that works / looks more skimmable?
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.
What might look nice is to have
| hour 1 | description here |
| Takeaways of hour 1 |
so in other words a coliumn for time and on the right a column for description. and then between each "section" of the workshop a 2 column spanning row that have the takeaways in a block of text?
you may have to use html for this to work i am not sure. the goal is to make the agenda more skimmable and look different from the setup instructions.
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. built the tables in HTML.
|
||
**45-60 minutes:** wrap up, answer any questions, and provide feedback on the session. | ||
|
||
## <i class="fa-solid fa-link"></i> Connect with pyOpenSci |
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.
Yay! this is nice!
also just a note that i know it's awkward to have instructions in several places. i'm still trying to figure out what the structure of these workshops needs to be. the tutorials are great but each workshop might have some slight customization. In the future, we might be able to just link to the install hatch / config hatch page (a pr for that page is open to be updated). we are just figuring this all out together given we don't even have an events page yet on the website. |
pre-commit.ci autofix |
we should be able to close this in favor of #442 |
@lwasser I've added a first pass at the events template (currently formatted as a blog post), using the upcoming SciPy workshop for information. I just plugged in the (not yet reviewed!) installation instructions, so those will need to be updated once the page is live over on the conference website.
let me know if there are any additional sections you'd like to see added to this, and how you'd like the page formatted!