New Module: Projects (Memex)

[a-a-ron]

We need to create a dedicated module for Projects.

Timeline: TBD

Projects (also known as Memex, Issues vNext, Projects V2, Projects Beta) is a tool for project management built directly into GitHub using React.

Note: the name "Projects" is also shared by another product of the same name, which the Memex project has now replaced, and is now called "Projects (classic)."

Resources

• Memex repository
• Public documentation
• Memex marketing page
• Product blog post

[camihmerhar]

Howdy @a-a-ron!

Here's an outline of how I envision the module with links to where I plan to pull the content from. Let me know your thoughts!

Introduction

• About Projects - GitHub Docs
• GitHub Issues - Project planning for developers
• Pre-requisites
  • A GitHub Account
  • Access to a GitHub organization

    How to build an organization project

• Creating an organization project
• Setting your project description and readme
• Adding items to your project
• Adding issues to your project
• Adding drafted issues to your project
• Configure build In Automation

  Organizing your project

• Adding an iteration field
• Creating a field to track priority
• Adding a board layout

  Exercise

  Creating a personal project

• Creating a project
• Setting project description and readme
• Add 4 issues
• Add iteration field
• Add a field to track priority
• Create a board layout

  Knowledge Check

  Summary

[rmallorybpc]

@camihmerhar Intro suggestions

• [x] I'd change, Luckily GitHub with Projects, to something like, Luckily using GitHub with Projects, , GitHub with Projects (Projects), or, GitHub and Projects. The way I'm reading the current sentence is that the name of the product is GitHub with Projects.
• [ ] I'd add the third content unit (when to use) to the learning objectives.
• [x] The creating an organization section could be a good spot for an image. Or really any of the section with step lists.

[rmallorybpc]

@camihmerhar Unit 2-how-to-create-a-project.md suggestions

• [x] Creating an organization project "4." needs a period at the end.
• [x] The interaction UI should be bold, example below: First, in the top right corner of GitHub.com, click your profile photo, then click Your organizations.
• [x] Also, the UI should be the same upper or lower case as the UI. 2. In the menu, click settings. Settings may be lower case in the UI, so this may be a simple double check. This is one that stood out to me without looking at the UI, so I could be off in this specific case.
• [x] The sections, Adding, and, Searching, some periods are needed in the numbered lists.
• [x] In the transition statement: I think they want us to stay away from the use of "we". This could be something to double check with Aaron.

[rmallorybpc]

@camihmerhar edited following our conversation. Removed italized since we only found bold formatting requirements. 3-how-{product}-works.md suggestions

• [x] Add periods to the numbered lists where there are no periods. Across unit.
• [x] A UI image could be good to add to one of the bullet lists under, How to create a field to track and group by priority.
• [x] Think about splitting this sentence into more than one. To do this, select the issue or pull request you want to classify, this in the field row titled Priority, in the drop down field select the priority you want to choose for this particular issue or pull request.
• [x] Apply bold to the clickable text. Example: 2. Then click, New Field. Across unit.
• [x] Think about adding some more context to the beginning of each section, before getting right into the bullet lists. Also, a good entry if you want to find some more images.
  • This is a good blog entry for some more context information.
  • Another one for context.
• [x] Add a transition sentence to the knowledge check.

[rmallorybpc]

The knowledge check questions look good and the summary is good.

[camihmerhar]

Thanks for the feedback @rmallorybpc! I might be misremembering, but I definitely saw in the Author Pack, like you mentioned, we should be italicizing field names. But now I can't find -- did they just update it and I assume we should follow the new guidelines to just bold UI elements?

[rmallorybpc]

@camihmerhar yeah, I was referencing the markdown styling information. @a-a-ron thoughts? Resolved.

[rmallorybpc]

@camihmerhar here are some suggestions for the new content.

4-how-to-manage-your-project.md suggestions

• [x] could use an image to break up the text, if one is available
• [x] Under, In this portion of the unit we will go over the following, change visbility to visibility
• [x] Is a table going to be added after, "Differences of access between a organization level project vs personal/user-level project table:"?
• [x] Comma or something between the sentence and the section title, "To change permissions see the above section Who has access and who can manage access to your project?"
  • [ ] Also, there is a possibility of adding a link to the section, on the title. However, the link has the current branch, so maybe something that can be added near the end with the live link?
• [x] Under, Adding a Project to a repository, same as above with separation between the sentence and the section title.
• [x] Add a transition sentence to the next unit.

5-insights-and-automation-with-projects.md

• [x] Under, How to configure built-in automation, change Poject to Project
• [ ] Under, How to configure built-in automation, is "Todo" code? If yes, then add the code formatting.
• [x] Under, How to configure built-in automation, change Workflos to Workflows
• [x] Under, How to configure built-in automation, change Archieved to Archived The section, Automation with Projects with GitHub Actions and GraphQL API, is currently pending.

6-projects-versus-projects-classic.md I really like the opening to this unit.

• [x] Just a thought. The last section is, A deep dive into Project enhancements. The section is bulleted and seems like the deep dive would include additional text. Could the section title be, Comprehensive lists of Project enhancements, or something similar.