Merge pull request #282 from napalm-automation/master

Master

docs/hackathons/hackathon2016/agenda.rst

@@ -0,0 +1,26 @@
+Agenda
+______
+
+.. important::
+    All dates and times are in UTC
+
+Friday 16th of Sept
+^^^^^^^^^^^^^^^^^^^
+
+* **6.00 pm - 7.00 pm** - Kick off. Short introduction about napalm and the hackathon.
+* **7.00 pm - 8.00 pm** - Propose tasks, create teams...
+* **7.00 pm - 11.59 pm** - Hacking.
+
+Saturday 17th of Sept
+^^^^^^^^^^^^^^^^^^^^^
+
+* **12.00 am - 11.59 pm** - More hacking
+
+Sunday 18th of Sept
+^^^^^^^^^^^^^^^^^^^
+
+* **12.00 am - 6.00 pm** - More hacking and PR merges
+* **6.00 pm - 8.00 pm** - Presentations
+
+.. note::
+    There is a chance that some participants have no prior experience with GitHub, python, napalm or even collaborating on big software projects. So we will have random sessions that will be recorded and published to explain some ideas like how to fork a project and submit a PR or what does pylama do or how do I test my code works, etc... This will be improvised and will depend on the types of questions people ask to the :doc:`mentors <mentors>`.

docs/hackathons/hackathon2016/index.rst

@@ -0,0 +1,45 @@
+Hackathon 2016
+==============
+
+Welcome to the very first ``NAPALM`` hackathon ever. What you are about to see is a bunch of people doing the unthinkable; ``writing code to manage the network``!!!
+
+.. important::
+    I love the smell of ``automation`` in the morning.
+
+Introduction
+------------
+
+During a weekend we will gather online to hack around napalm, fix existing issues, clean the codebase or just do whatever we want.
+
+.. _hackathon2016-useful-information:
+
+Quick Information
+-----------------
+
++-----------------+-----------------------------------------------+
+| **Date**        | 17, 18 and 19th of September                  |
++-----------------+-----------------------------------------------+
+| **Location**    | :doc:`Here for more information <locations>`  |
++-----------------+-----------------------------------------------+
+| **Slack**       | ``#napalm-hackathon-2016`` in networkToCode_  |
++-----------------+-----------------------------------------------+
+| **Live Feed**   | Google Hangouts_                              |
++-----------------+-----------------------------------------------+
+| **Recordings**  | Youtube_                                      |
++-----------------+-----------------------------------------------+
+
+Information
+-----------
+
+.. toctree::
+   :maxdepth: 2
+
+   agenda
+   locations
+   participating
+   mentors
+   volunteering
+
+.. _networkToCode: https://networktocode.herokuapp.com/
+.. _Hangouts: https://hangouts.google.com/hangouts/_/dravetech.com/napalm-hackathon-2016
+.. _youtube: https://www.youtube.com/playlist?list=PLTUN_ROR5c9jUUHk0Du0Yy6a6lf9PaUet

docs/hackathons/hackathon2016/locations.rst

@@ -0,0 +1,20 @@
+Location
+________
+
+The hackathon will be held online. We will use slack as the main communications channel, github to coordinate the work and hangouts for live presentations, which will be posted online on a youtbe channel within the hour.
+
+Check this :ref:`link <hackathon2016-useful-information>` for more information regarding the slack channel, hangouts, youtube, etc..
+
+IRL Gatherings
+^^^^^^^^^^^^^^
+
+Apparently there is something called real life and people like to gather in groups, shocking, isn't it? We will gather in some locations just for the sake of feeling the warmth of other human beings and probably have beer after a long day of hacking. This is completely optional and unofficial, although, if you want to host a physical meetup I will be happy to announce it here.
+
+Known gatherings
+^^^^^^^^^^^^^^^^
+
+* London, exact location TBD
+
+
+
+.. _index:

docs/hackathons/hackathon2016/mentors.rst

@@ -0,0 +1,16 @@
+Mentors
+_______
+
+.. important::
+    All levels of expertise are welcome so if you are new to github, python, napalm or even to networking, don't let that be on the way. We have some :doc:`mentors <mentors>` to help you and plenty of tasks to get you started with python, github, and various other tools for testing code, making it look pretty, etc. So if you are looking for some free training this might be a good way to get it ;)
+
+
+The community in networkToCode is pretty much great so if you have any problem just post it on the slack channel. Feel free to also ping any of the mentors if you didn't get any satisfactory answer.
+
+Mentors' slack handles are:
+
+ * ``dbarroso``
+ * ``mirceaulinic``
+ * ``ggabriele``
+
+.. _networkToCode: https://networktocode.herokuapp.com/

docs/hackathons/hackathon2016/participating.rst

@@ -0,0 +1,21 @@
+Participating
+_____________
+
+
+Before the event
+^^^^^^^^^^^^^^^^
+
+Feel free to navigate all the repos on the `napalm automation <https://github.com/napalm-automation>`_ organization and find issues you might want to work on.
+
+  #. If you find any feel free to comment on the issue to let the organizers know.
+  #. If you don't and you know what you would like to work on, please, create an issue with the description of what you want to achieve.
+  #. If you want to participate and you don't know what to do, feel free to ask on the slack channel. It is already available so go there and ask.
+
+During the event
+^^^^^^^^^^^^^^^^
+
+  #. Make sure you are on slack. We will use that as our main communications channel. We will make all the announcements there and we will notify you there if we plan to make some announcement on the hangout.
+  #. If you can't attend the live videos don't sweat. They will be published on YouTube as soon as they are done so you don't miss anything.
+  #. If you are in New Zealand and think you live on a strange timezone and, thus, you can't participate, you are wrong. GitHub is great for asynchronous communications and I am sure there will always be someone around on slack to help you through any problem you might encounter, to help someone yourself or simply to wind up for a second and just talk about any random topic you want.
+
+.. napalm-automation: https://github.com/napalm-automation

docs/hackathons/hackathon2016/volunteering.rst

@@ -0,0 +1,4 @@
+Volunteering
+____________
+
+Do you want to help out? Please, do it. We need mentors. If you know how to work with git, python, napalm, how to record a google hangout, you want to organize a physical gathering or just correct my spleling, please, ping ``dbarroso`` on slack.

docs/hackathons/index.rst

@@ -0,0 +1,7 @@
+Hackathons
+==========
+
+.. toctree::
+   :maxdepth: 1
+
+   hackathon2016/index

docs/index.rst

@@ -58,3 +58,4 @@ Documentation
    support/index
    cli
    base
+   hackathons/index