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

Fix - tutorial listing on packaging page - add numbers to tutorial names & fix first tutorial name! #299

Closed
lwasser opened this issue Jun 6, 2024 · 1 comment · Fixed by pyOpenSci/pyopensci.github.io#426
Labels
beginner-friendly help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jun 6, 2024

from @pb-413

Side note: are the tutorials suppose to be more independent (as they appear in the list under "Beginner friendly Python packaging tutorials"), or executed in sequence (which more so matches my experience so far). If sequential is desired, as it seems, consider a numbered list under "Beginner friendly Python packaging tutorials" rather than a collection of seemingly independent tutorials.

they are meant to be completed in order. we could number them easily by adding a number to each tutorial's name (also a beginner friendly task). i'm also noticing the first tutorial has the incorrect name! i'm going to turn this comment into a new issue and mark it help-wanted! another great catch!

_Originally posted by @lwasser in pyOpenSci/pyopensci.github.io#441

@lwasser
Copy link
Member Author

lwasser commented Jun 6, 2024

this page -
https://www.pyopensci.org/python-packaging-science.html#beginner-friendly-python-packaging-tutorials has a list of tutorials that are intended to be completed in order. ALSO the first tutorial's name is incorrect.

Screenshot 2024-06-06 at 5 26 01 PM
  • Task - go here: https:/pyOpenSci/pyopensci.github.io/tree/main/_tutorials and you'll find the set of tutorial stubs that are used to render tutorials on that page
  • Update the names for each tutorial with a number example: 2. What is a python package
  • Fix the name of the first tutorial to match the name of the tutorial it actually links to when you click on the view tutorial link!
  • Add a note that it is intended that users work through these tutorials in order. but you can always pick a specific topic if you wish to jump around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner-friendly help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable
Projects
Development

Successfully merging a pull request may close this issue.

1 participant