Create 'Anatomy of a Good GitHub Issue' Page

[daniellen00]

Overview

Members of Hack for LA often create new GitHub Issues in project repos. Many new and current members need instructions for doing this in a standardized format. Create page for website.

Dependency

Guide template (no issue started yet)

Action Items

• UX Writing
  • Review existing guide and other resources
  • Organize the wording and define elements that should be on page
  • Sign off
• UI Mockup
  • Design mockup
  • Coordinate with VRMS team about requirement for stats
  • Sign off
  • check dependency status. If dependency not cleared, put in icebox
• Development - Implement mockup:
  • Create guide based on template (see dependency)
  • Add to guide collection
  • Link from Toolkit homepage

Resources/Instructions

Github's Markdown Guide
Example of a Good Issue
Google Doc Draft
GitHub's About Labels
GitHub Assignees
GitHub's Milestones

Resume

UX Writing:

• Evaluated existing materials, identified and located missing information, created new presentation recommendations to standardize GitHub Issues and improve GitHub onboarding experience.
• Communicate to funders, potential volunteers, and other interested stakeholders the specific value delivered by Hack for LA membership to workforce development goals.

UI Mockup:

• Design GitHub Issue guide to improve member GitHub experience, streamline new member onboarding, and expand website assets.
• Communicate to funders, potential volunteers, and other interested stakeholders the specific value delivered by Hack for LA membership to workforce development goals.

Developers:

• Add to collection in Jekyll / GitHub Pages to organize and deliver guide content to website
• Use Liquid and Vanilla JS to create new website content
• Integrate data from API to display real-time statistics of GitHub membership at initial onboarding to increase awareness of HfLA membership value

[daniellen00]

Figma link: https://www.figma.com/file/0RRPy1Ph7HafI3qOITg0Mr/Hack-for-LA-Website?node-id=745%3A999

[daniellen00]

@ExperimentsInHonesty for review of ux writing and Figma layout (plus Development Action Items phrasing in this Issue)

[ExperimentsInHonesty]

@daniellen00
I think we need to say something about the menu (for formatting vs using markdown)
Maybe right at the top where you have the link to markdown we could put a screenshot of the menu and let them know they have the option to write markdown or use the formatting menu

Also rounded corners

@harishlingam mentioned looking at the hack nights page or getting started for overall formatting. Look at font weights and sizing

team agrees with pink background.

[ExperimentsInHonesty]

[ExperimentsInHonesty]

@daniellen00 Great job with the options.

@yuikomajima and the team did a little iteration on one of the pages for the top nav. She is going to finish the top image, and this is all ready to go to development.

[ExperimentsInHonesty]

Please see mockups here: https://www.figma.com/file/0RRPy1Ph7HafI3qOITg0Mr/Hack-for-LA-Website?node-id=695%3A3802

[ye-susan]

1. Progress: ~80% done with Github Issues Page (but not 'template-izing' it yet)
2. Blocks: Need to figure out how to make this page into a working template
3. Availability: Open
4. ETA: 6/30 for html page, TBD for template