a-a-ron
commented
2 years ago Hey, @camihmerhar! First off, amazing job putting together your first module. I reviewed the content and have some feedback on some content I think we need to add. Great job with the structure and the layout.
I'll address your slack questions first.
Answers to slack questions
I tried finding a skills exercise to go along with the module, but I couldn’t find one that fit the 101 level I was trying to achieve with the module. What are your thoughts on me creating an exercise for this module? Or another option is to preface in the Intro to work alongside the module?
We don't have a hands-on exercises to use at the moment. For now, we'll publish without the exercise.
Did I add the images correctly?
Yes, but we may need to be more descriptive with the alt text or it may be flagged by MS Learn when we try to publish it. For example, the alt text in this image syntax :::image type="content" source="../media/example_board.png" alt-text="An Example of a Board."::: could be more descriptive. Maybe something like, "An example of a project board with 4 columns labeled; no status, todo, in-progress, done".
As a person who uses projects frequently, am I missing anything that you find extremely helpful for a new user of projects?
Yes, I think we are missing a few sections. I'll provide more context below.
Should I include more automation content?
I would like to see some content on using the API and Actions. I don't want this to be extensive but maybe a sub section for each with about a paragraph or two talking about automating your projects using both of those options.
What am I missing from a structural perspective?
Structurally it is looking great. Files in the right place, syntax looks good, knowledge check questions added. Nice job!!
Content I think we need to add
Section to introduce projects and how it's different from projects (classic)
I think this section is important and will help remove confusion on what we are referring to when we say "projects". A lot of GitHub users are familiar with projects (classic) so making sure we make this distinction clear is important. Let's add a section to the beginning of unit 2 that mentions the differences between the two and help set the stage that this module is about projects and not projects (classic). Maybe a table of feature differences/similarities comparing the two would be nice. The rest of the module contents will go over those features and how Projects is better suited for managing your work on GitHub.
Unit on insights
I think this is a big enough feature that we need to add a new unit for talking about the insights tab. Here are subsections I think we need to add:
- What are insights and how can they be useful
- Current available charts / historical charts
- Creating and customizing charts
Here is the docs page for insights
Unit on managing your project
I think we need a unit about managing your project. I don't want this to follow the docs with step-by-step instructions for doing each task, so maybe we can do that for some but then just explain how you can do that for others. Here are the topics I think we can add for this unit:
- Project visibility
- Project access
- Closing / deleting projects
- Adding a project to a repo
- Adding a project to a team
camihmerhar
Module title: Manage your work on GitHub with Projects
Resolves issue https://github.com/githubpartners/microsoft-learn/issues/38
Helpful resources
Module Outline
Module prerequisites
Action items for @camihmerhar