Init hueniversity wiki discussion

gistfile1.txt

// Initiate Discussion

Greetings hueniversity community!

The goal of this document is to:

1. motivate the community to develop a great wiki!
2. show others how to contribute to the wiki.
3. start discussion to solidify a plan for the wiki.

According to Eran, hueniversity is an experiment that works by moving the learning from the assignment instructions to community interaction. "If you do not interact, you will not learn and you will fall behind. We are all teachers here!"
The wiki is a place we can interact, share, and teach. Hopefully, many more people will contribute.
Imagine if everyone contributed part of their knowledge from each assignment to the wiki.
The result would be an amazing resource.

What is our wiki about?
Please contribute your thoughts :-)
See: Issue: Wiki Discussion
See: Wiki Style Guide

Below are some suggestions.

Two types of content:

1. Guides to the assignments.
   
2. FAQ and Important Issues.
   
   

1. Guides

1. A Guide for Each Assignment
   
2. Naming a Guide
   
   Assignment number then sub-number then assignment-name format.
   
   For example, if we use this format the menu would look like the below which would allow readers
   to easily navigate.
   
   

4. Assignment
4.1 sub-title
4.2 sub-title 
4.3 ......
.....

1. Structure -- Components of a Guide
2. Introduction
   
   Give an overview of the assignment's main learning objectives
3. Git setup
   
   Explain to the reader how to find the correct project state in the
   
   git repo. What commit should they checkout?
   
4. Body
   
   A step by step explanation of how to complete the assignment.
   
   Assignment3 is an example of how to do this in step by step fashion.
   
5. Closure
   
   Review the objects of the assignment.
   
   Make suggestions to other resources for further study.
   
   (make your suggestions)
   
   
   

2 FAQ and Important Issues

Note: Based on discussion with @AdriVanHoudt there will not be a separate FAQ section.
Most likely this will be moved into the assignment. So far, we all feel the
focus of the wiki is going to be the assignments and nothing else.

1. Naming
   99 then sub-number then issue-name format.
   Use 99 here so it will keep the issues at the bottom of our menu navigation
   If you use 100, the FAQ will move to the top.
   This will keep the menu navigation readable.

99 FAQ
99.1 Why use a Makfile
99.2 Modules and Singleton
99.3 Your important issue explanation. 
99.4 ......
.....

1. Write Solutions not Questions.
   
   The wiki is an area for writing solutions. Let's do our best to keep questions
   
   in the PR posts.
   
2. If you see the same question being asked a lot. Or, you discover an important
   
   issue that needs to be explained then write a solution here.
   
   

Closing

hueniversity is a unique learning experience. Eran has developed one
of the best frameworks in web programming (hapijs). Now, he is spending time
teaching in a distributed classroom. You are part of that classroom. Don't waste
this opportunity, work hard, ask questions, and contribute.


The best way to learn a subject is to study it like you are
going to teach it. If you make the effort to write something on the wiki to teach others,
I guarantee you will really learn the subject.