Guide Resources

Welcome!

We are creating guides that will help future HfLA volunteers at Hack for LA and add to valuable shared documentation between all teams.

Trackers

Global Guide Project Board

• Tracker across all Communities of Practice: Search for a guide by using this global project board. The Guides team uses this board to track progress of all the guides

Need to understand a term we have used in our guidance?

• Glossary

Places where you can find Guides to work on

• All the guides are assigned in Communities of Practice. They have GitHub project boards for Guides. See a full list of Community of Practice Guide Project Boards here

Instructions for how to work with Guides

Where to start

1. Getting Started
   • Overview of whole process
   • Part 1: What is a Guide & Picking Your First Guide
2. How to Gather Examples
   • Part 1: Gathering Examples With Github: Wiki, Issues, Project Board, Resources Provided (WIP)
   • Part 1.5: How to Use Github Search
   • Part 2: Gathering Examples With Slack
   • Part 3: Connecting with Other Teams & Moving the Conversation Forward
   • Part 4: Making a Special Issue + Last Check w/ Org Rep
3. How to Find a Guide that is Ready to Write a Template for (WIP)
4. How to Peer Review a Guide (PM/UX CoP presentation)
5. How to Work on an Unfinished Guide (PM CoP presentation)
6. How to suggest a new guide:

• Check the Guide Tracker to make sure no one has started it (it could be on a different community of practice)
• Write an idea for new guides by adding a card in the New Issue Approval column of your Community of Practice Board
• Ideally the guides should be written for novices so that they are useful to all people who read them, including people from other Communities of Practice and people outside Hack for LA.

Once you are ready to write a guide

• How to Format a Guide - WIP
  • Template for Guide Draft - WIP: Use this template when you are writing a guide from scratch. Make sure you store it in your community of practice Google Drive.
• How to Add Screenshots and Graphics in Guides
  • If you want to suggest changes to this guide, please reopen this issue: How to Add Screenshots and Graphics to your Guide

Tools to help you connect with projects

• Active Projects List: This issue is where we store the list of active projects. Make sure that when you survey projects to recheck this issue to make sure you have the most current list.
• How to Find a Project's Slack Channel: Go to HackforLA.org's projects page and look at each project's card, for a link to their Slack channel

Guidance that we have yet to write that would be helpful

• How to use all the links above (for CoP leads) to have your Community of Practice make guides