Developing a new What The Hack is a great way to get your content out to the world. Chances are if you've done workshops or PoCs in the past, you already have the material on which to base a What The Hack.
The What The Hack "challenge" format is perfect for team-based, hands-on learning experiences.
What The Hack is all about being "for the people, by the people". This repo was originally created to share real-world hackathons that Microsoft employees have hosted with their customers. Here are our core principles:
- Anyone can contribute a hack.
- Anyone can use the content to host their own event.
- Anyone can modify the content as needed.
- Submitting a pull request for modified/improved content is encouraged.
- The content can always be shared with attendees (Only do this after the event is over!)
When you design a WTH, these are the things you should consider:
- Hack Description (aka "The One Pager")
- Challenge Design
- Student Resources
- Presentation Lectures (optional)
- Coach's Guide
- Coach Solutions
If you create things in this order, you will be able to flush out a new hack rapidly.
HINT: The Coach's guide and Coach Solutions is the most detail oriented & time consuming item to produce. Shhh... don't say we told you this, but hack authors have been known to write the Coach's Guide as a post-mortem from their first run of the hack.
Why should someone take the time to deliver or participate in your hack? This is the main question you need to answer in order to define your hack. Every WTH needs to have an executive summary (aka "one pager") that quickly describes your hack to those who will host or attend your hack. Think of this as your marketing pitch.
HINT: The "Hack Description" can serve a dual purpose. If you take the time to write it first, it can be the outline or specification for your hack before you develop the actual content.
The "Hack Description" shall be the README.md that lives in the root of your hack's top level folder.
The "Hack Description" must include the following:
Give your hack name. Keep it short, but consider giving it a "fun" name that is more than just the name of the technologies that the hack will cover.
This is your chance to sell the casual reader on why they should consider your hack. In a paragraph or two, consider answering the following questions:
- What technologies or solutions will it cover?
- Why are these technologies or solutions important or relevant to the industry?
- What real world scenarios can these technologies or solutions be applied to?
This is where you describe the outcomes a hack attendee should have. Provide a short list of key learnings you expect someone to come away with when they complete this hack.
Every WTH is made up of a collection of technical challenges. For the one pager, you should list out your challenges by name, with no more than a single sentence description for each unless the challenge title is descriptive enough on its own.
For most this page will act as a "Table of Contents" for your hack. We recommend that you create links for each challenge to its respective challenge page.
Provide a list of technical prerequisites for your hack here. List out assumed knowledge attendees should have to be successful with the hack. For example, if the hack is an "Introduction to Kubernetes", the attendee should have a basic understanding of containers. However, if it is an "Advanced Kubernetes" hack, then the attendee should know the basics of Kubernetes and not ask you what a "pod" or "deployment" is.
Provide a list of tools/software that the attendee needs to install on their machine to complete the hack.
We have compiled a list of common tool pre-requisites needed for most of the Azure related hacks here:
You can provide a link to it in your hack's prerequisites section in addition to any unique prerequisites for your hack.
While optional, it is a good idea to provide a catalog of the files you are providing with your hack.
Finally, give yourself and your fellow hack authors some credit. List the names and optionally contact info for all of the authors that have contributed to this hack.
To help you get started, we have provided a sample template for a Hack Description / "one pager" here:
Please copy this template into your hack's root folder, rename it to "README.md", and customize it for your hack.
Challenges are at the heart of the WTH format. Designing challenges is what a hack author should spend the majority of their time focusing on.
There are different approaches to designing a hackathon. If you are familiar with the Marvel Comic Universe movies, you know that they follow one of two patterns:
- "Origin Story" - A movie focused on the back story of a SINGLE superhero that lets the audience get to know that character in depth (perhaps with a sidekick character or two included).
- "Avengers Story" - A movie with an ensemble cast of superhero characters working together to solve a mega problem, with each character getting varying amounts of screen time.
You can use the same patterns when designing a What The Hack.
- Singleton Hack - A hack designed to give in-depth hands-on experience with a specific technology and maybe a "sidekick technology" or two included.
- Solution Hack - A hack designed to give experience solving a real-world scenario that involves using multiple technolgies together for the solution.
Once you have decided what type of hack you want to create, you should follow these guidelines when designing the challenges:
- Include a “Challenge 0” that helps attendees install all of the prerequisites that are required on their computer, environment or Azure account.
- Challenge descriptions should be shorter than this section on how to design challenges. Keep it to a couple of sentences or bullet points stating the goal(s) and perhaps a hint at the skill(s) needed.
- Think through what skills/experience you want attendees to walk away with by completing each challenge
- Challenges should be cumulative, building upon each other and they should:
- Establish Confidence – Start small and simple (think "Hello World")
- Build Competence – By having successively more complex challenges.
- Each challenge should provide educational value.
- For example, if an attendee completes only 3 out of 7 challenges, he/she still walks away feeling satisfied that they will have still learned something valuable.
- Take into consideration that a challenge might have more than one way to solve it and that's OK.
- Provide verifiable success criteria for each challenge that lets the coaches and attendees know they have completed it.
- Provide relevant links to learning resources that should lead the attendees toward the knowledge they need to complete the challenge.
- Provide hints for items that could potentially be time consuming to figure out but are of low learning value or relevance to the actual goal of the challenge. For example: A command line parameter that is not obvious but would take hours to debug if it were missed.
- Do NOT provide a list of step-by-step instructions. These are challenges designed to make the attendees learn by solving problems, not blindly following instructions.
To help you get started, we have provided a sample markdown template for a hack Challenge here:
Please copy this template into your hack's ../Student folder, rename it to "ChallengeXX.md", where "XX" is the challenge number, and customize it for each challenge.
NOTE: In each challenge's markdown file, you should create navigation links to/from the previous & next challenges. Please use relative links (eg. "/ChallengeXX.md") instead of absolute links (eg. "https://github.com/Microsoft/WhatTheHack/000-YourAwesomeHack/Student/ChallengeXX.md")
It is common to provide attendees with resources in order to complete the hack's challenges. One example is to provide the code for an application that the hack's challenges are based on. Another example might be to provide sample code files, artifacts, or templates that provide guidance for completing the hack's challenges.
If your hack provides attendees with code or resources, they should be included with your hack's contents in the ../Student/Resources folder.
During a WTH event, it is recommended that you have attendees download any provided resources as a zip file instead of having them clone the entire WTH repo onto their computer.
This has the benefit of not having to direct the attendees to the WTH repo during your hack. Remember, attendees can always find the WTH repo. However, remind your attendees that they are cheating themselves out of an education if they go foraging around in the WTH repo for the answers.
One recommended way to enable attendees to easily download hack resources is using DownGit. DownGit is a clever utility that lets you create a download link to any GitHub public directory or file.
You can view the DownGit project on GitHub here: https://github.com/MinhasKamal/DownGit
And you can use DownGit from its website here: https://minhaskamal.github.io/DownGit/#/home
To enable attendees to download hack resources using DownGit:
- As mentioned above, publish your resources in the WTH repo under the
..Student/Resourcesfolder of your hack - Create a DownGit link to the "Resources" folder (or whatever sub-folder you want your attendees to download)
- Use the DownGit link you created in your Challenge text to provide the link to the attendees.
Our recommended method of providing resource files to attendees is for the WTH event host to pre-load them into the Microsoft Teams team for the WTH event.
To pre-load resources into the event team, the host should:
- Use DownGit to download the Zip file of resources from the WTH repo.
- Upload the zip file (or its contents) to the Files tab of the General channel for the WTH event Teams site.
- Direct users to download the resource files from Files tab in Microsot Teams.
You may be wondering why there is a section called "Presentation Lectures" when the whole point of What The Hack is to be hands-on and NOT a "death by Power Point" snoozefest?!
When you host a What The Hack event, there is always a kick off meeting where the attendees are welcomed and then introduced to the logistics of the hack. The best way to do that is with a short PowerPoint delivered a few slides at a time.
We have provided an Event Kickoff presentation template that you can customize for your hack and use to cover attendee logistics for a WTH event here:
After the kickoff meeting, its up to the hack authors if they want to provide any presentation lectures. Some hack challenges are easy to jump right into. Others are more complex and are better preceded by a brief introduction presentation.
It is OK and encouraged to offer a collection of "mini" presentation lectures if necessary for your hack's challenges. If you do provide a presentation lecture, consider these guidelines for each challenge:
- Try to limit the lectures to 5-10 minutes per challenge.
- Provide a brief overview of the challenge scenario & success criteria
- Provide a brief overview of concepts needed to complete the challenge
- Provide "reference" slides that you might not present, but will have on hand if attendees need additional guidance
- Provide a slide with the challenge description that can be displayed when attendees are working on that challenge
We have more guidance on how and when to deliver mini presentation lectures for your challenges during your event in the How To Host a What The Hack guide.
Please publish any presentations in your hack's ../Coach folder.
Every WTH should come with a Coach's guide. The simple way to think of the Coach's guide is that should be the document with all of "the answers". The reality is, doing so would turn it into a giant step-by-step document loaded with detailed commands, screenshots, and other resources that are certain to be obsolete the minute you publish it. No one wants to maintain a document like that.
Instead of treating the Coach's guide like a step-by-step document, treat it as the "owner's manual" you would want to provide to future coaches so they can host and deliver your WTH to others.
The Coach's guide should include the following:
- List of high-level solution steps to each challenge
- List of known blockers (things attendees will get hung up on) and recommended hints for solving them. For example:
- Resources that will take a long time to deploy in Azure: Go get a coffee.
- If installing the Azure CLI on Windows, install it in the Windows Subsystem for Linux instead of just Windows itself
- Permission issues to be aware of, etc
- List of key concepts that should be explained to/understood by attendees before a given challenge (perhaps with a presentation lecture)
- List of reference links/articles/documentation that can be shared when attendees get stuck
- Estimated time it would take an attendee to complete each challenge. This will help coaches track progress against expectation. It should NOT to be shared with attendees.
- Suggested time a coach should wait before helping out if a team is not progressing past known blockers
The Coach's guide should be updated during & post event with key learnings, such as all the gotchas, snags, and other unexpected blockers that your attendees hit.
This is where you put "the answers". There are usually multiple ways to solve a WTH Challenge. The solutions you provide here should be example solutions that represent one way to solve the challenges. The solution resources might include a full working application, configuration files, populated templates, or other resources that can be used to demonstrate how to solve the challenges.
Examples of Coach Solutions are:
- Prerequisites for the Azure environment if needed.
- Example: A VM image with Visual Studio or ML tools pre-installed.
- Example: An ARM template and/or script that builds out an environment that saves time on solving a challenge
- Scripts/templates/etc for some challenges that can be shared with attendees if they get really stuck
- Example: If challenges 1 through 3 build something (i.e. an ARM template) that is needed for challenge 4, you could “give” a stuck team the template so they could skip to challenge 4.
If your hack provides Coach Solutions with code, templates, etc, it is recommended that you publish those resources as part of your hack's contents in the ../Coach/Solutions folder.
NOTE: This content is not intended for hack attendees to see before or during a hack event. The content IS available publicly and thus an attendee can and WILL find it if they are determined enough. It is important to stress to the attendees that they should not cheat themselves out of an education by looking at the solutions.
Okay, ready to get started creating your own What The Hack?
First we create a fork of the main WTH repo and then clone it to disk and create a branch to work in. The instructions below assume you have the git command line on your machine. If you're more comfortable in a GUI git client, you can use that too (we recommend SourceTree).
- Create a fork of the WTH repo
- Navigate to the WTH git repo at: https://aka.ms/wth
- Click the Fork button at the top right of the page and then choose the account you want to create the fork in.
- Clone your new fork to your local machine
git clone https://github.com/myname/WhatTheHack.gitcd WhatTheHack
- Create a new branch for your work. It is a best practice to never work directly on the master branch
git branch MyWorkgit checkout MyWork
- Add a new top level folder to the WTH repo using the next available number in sequence
mkdir 067-IoTCentury
- Within your new folder, create the following directory structure:
../Coach/Solutions
../Student/Resources
Now that you've created the directory structure above, here is what each of them will contain:
../- Hack Description (README.md)
../Coach- The Coach's Guide, Lecture presentations, and any supporting files.
/Solutions- Solution code for the coach only. These are the answers and should not be shared with students.
../Student- The Challenge markdown files
/Resources- The code and supporting files the students will need throughout the hack.