Difference between revisions of "Virtual FSweekend Hackathon 2020"

From FlightGear wiki
Jump to: navigation, search
(Sign up)
(Copy editing; +links: Forum topic, Mailing list thread, and a few more)
Line 1: Line 1:
This is the landing page for the Virtual FSWeekend Hackathon 2020.
+
This is the landing page for the '''Virtual FSWeekend Hackathon 2020'''.
  
Normally in mid-November a group of FlightGear enthusiasts participate in FSWeekend at Lelystad Airport in the Netherlands. Over the years this has been a focal point for both finishing existing development/releases and a catalyst for new ideas in FlightGear, as well as an opportunity for FG enthusiasts to share a beer.  FSWeekend 2020 was cancelled, so to keep the spirit alive, we are planning to hold a Virtual FSWeekend Hackathon on the weekend of 14/15 November.
+
Normally in mid-November a group of FlightGear enthusiasts participate in FSWeekend at Lelystad Airport in the Netherlands. Over the years this has been a focal point for both finishing existing development/releases and a catalyst for new ideas in FlightGear, as well as an opportunity for FlightGear enthusiasts to share a beer.  FSWeekend 2020 was cancelled, so to keep the spirit alive, we are planning to hold a Virtual FSWeekend Hackathon on the weekend of 14/15 November.
  
=Hackathon?=
+
== Hackathon? ==
For those who haven't participated in a hackathon before, the broad idea is to get people from a wide variety of experience and backgrounds together to solve problems over a short period of time - typically 24 or 48 hours. Details vary, but typically at the start of the event, people pitch ideas and groups form organically based on what people are interested in. The groups then work together intensively, often fuelled by pizza and caffeine etc. At the end of the hackathon the groups present their work and there are often prizes for the best hacks.
+
For those who have not participated in a hackathon before, the broad idea is to get people from a wide variety of experience and backgrounds together to solve problems over a short period of time - typically 24 or 48 hours. Details vary, but typically at the start of the event, people pitch ideas and groups form organically based on what people are interested in. The groups then work together intensively, often fueled by pizza and caffeine etc. At the end of the hackathon the groups present their work and there are often prizes for the best hacks.
  
The idea of the virtual FSWeekend hackathon would be to encourage existing and new contributors to collaborate over the course of the weekend to create new and exciting features for FlightGear in the broadest sense. James and I would particularly like to use it as an opportunity to encourage people to get their hands dirty in the core code, so we'll be primarily there to help people rather than hacking ourselves, but anything is possible :)
+
The idea of the virtual FSWeekend hackathon would be to encourage existing and new contributors to collaborate over the course of the weekend to create new and exciting features for FlightGear in the broadest sense. James and I would particularly like to use it as an opportunity to encourage people to get their hands dirty in the core code, so we will be primarily there to help people rather than hacking ourselves, but anything is possible :)
  
No prior development experience is necessary - we will try to run some education sessions ahead of the weekend so people can hit the ground running. Also, don't feel you have to commit to coding the entire weekend to the exclusion of all else. I think participants will still get real value if they can just commit to one day and some late evenings.  
+
No prior development experience is necessary - we will try to run some education sessions ahead of the weekend so people can hit the ground running. Also, do not feel you have to commit to coding the entire weekend to the exclusion of all else. I think participants will still get real value if they can just commit to one day and some late evenings.  
  
=Sign up=
+
== Sign up ==
 
+
To register your participation, please contact Stuart either on the {{forum link|t=38071|text=forum post}}, or via the [https://sourceforge.net/p/flightgear/mailman/message/37125347/ -devel list].   
To register your participation, please contact Stuart either on the forum post, or via the -devel list.   
+
  
 
Confirmed participants (in no particular order):
 
Confirmed participants (in no particular order):
Line 29: Line 28:
 
* Patrick Trottier
 
* Patrick Trottier
  
=Ahead of the Hackathon=
+
== Ahead of the Hackathon ==
 
+
 
There are a couple of key activities ahead of the weekend.
 
There are a couple of key activities ahead of the weekend.
  
==Getting Started==
+
=== Getting started ===
 
So we can hit the ground running, we really want everyone participating to already have:
 
So we can hit the ground running, we really want everyone participating to already have:
* sourceforge credentials
+
* SourceForge credentials
* A working build environment with OSG, plib etc.
+
* A working build environment with [[OpenSceneGraph|OSG]], [[PLIB]] etc.
* A git checkout of simgear/flightgear
+
* A Git checkout of simgear/flightgear
* A git checkout of fgdata
+
* A Git checkout of fgdata
* Some experience with git :)
+
* Some experience with Git :)
  
 
James and Stuart will pull together (and improve) the wiki resources to make this easier.
 
James and Stuart will pull together (and improve) the wiki resources to make this easier.
  
 
Ideally, we would have a couple of weeks upfront to identify articles that would be useful to provide rough guidance, either to update these or rewrite/merge them with other articles.
 
Ideally, we would have a couple of weeks upfront to identify articles that would be useful to provide rough guidance, either to update these or rewrite/merge them with other articles.
Candidate articles are currently being put into a dedicated [[:Category:Hackathon Materials]]
 
  
If we can agree on a set of articles that seem useful (to walk people through the process of patching FlightGear to add self-contained functionality), it might make sense to reach out to the community to help with reviewing/proof-reading and possibly translate such articles. Also, encouraging people to contribute artworks might be a good idea (screen shots, images, diagrams/drawings etc).
+
Candidate articles are currently being put into the dedicated [[:Category:Hackathon Materials|Hackathon Materials]] category.
  
==Logistics==
+
If we can agree on a set of articles that seem useful (to walk people through the process of patching FlightGear to add self-contained functionality), it might make sense to reach out to the community to help with reviewing/proof reading and possibly translate such articles. Also, encouraging people to contribute artworks might be a good idea (screen shots, images, diagrams, drawings etc).
Being completely remote, we need the ability to collaborate in teams as well as video-conference as a group.
+
  
We will try to have some sort of video-conference running permanently for people to drop into, as well as some collaboration tool that can be used both by individual teams as well as the whole group for general support.
+
=== Logistics ===
 +
Being completely remote, we need the ability to collaborate in teams as well as video conference as a group.
  
==Ideation==
+
We will try to have some sort of video conference running permanently for people to drop into, as well as some collaboration tool that can be used both by individual teams as well as the whole group for general support.
 +
 
 +
=== Ideation ===
 
The core of the Hackathon!  These are the projects, idea and problems that participants will be working on during the weekend.  In the weeks before the hackathon itself, participants can, and should, propose things to work on.  Simply create a wiki page describing your idea, and encourage people to contribute and get interested.
 
The core of the Hackathon!  These are the projects, idea and problems that participants will be working on during the weekend.  In the weeks before the hackathon itself, participants can, and should, propose things to work on.  Simply create a wiki page describing your idea, and encourage people to contribute and get interested.
  
Simply use the [[Template:Hackathon Proposal]] and your idea will appear magically in the category page linked below:
+
Simply use the {{tl|Hackathon Proposal}} template and your idea will magically appear on the [[:Category:Hackathon_2020_Ideas|Hackathon_2020_Ideas]] category page.
  
[[:Category:Hackathon_2020_Ideas]]
+
Not got an idea?  No problem!  Have a look at the ideas above, leave a comment on the Discussion page, and add yourself as an Interested Party for those you might consider working on during the Hackathon.  There is no commitment until Friday evening.
  
Not got an idea?  No problem!  Have a look at the ideas above, comment in the Discussion section, and add yourself as an Interested Party for those you might consider working on during the Hackathon.  There's no commitment until Friday evening.
+
=== Materials ===
 
+
== Materials ==
+
 
+
=Schedule=
+
  
 +
== Schedule ==
 
With (hopefully) a world-wide group of participants, and varying real life constraints, at any given time over the weekend there will hopefully be a couple of people active.   
 
With (hopefully) a world-wide group of participants, and varying real life constraints, at any given time over the weekend there will hopefully be a couple of people active.   
  
We'll have two big get-togethers:
+
We will have two big get-togethers:
 
+
==Friday 13th November 2000-2200 UTC.  Kick-off==
+
  
 +
=== Friday 13th November 2000-2200 UTC. Kick-off ===
 
* General welcome
 
* General welcome
 
* Introductions  
 
* Introductions  
Line 79: Line 74:
 
This is the point at which participants will decide which Hacks they want to work on.  The sponsors of each of the Hacks proposed head of time will be invited to give a 5 minutes pitch to the group, with some questions from the audience.  Slides/screenshots optional.
 
This is the point at which participants will decide which Hacks they want to work on.  The sponsors of each of the Hacks proposed head of time will be invited to give a 5 minutes pitch to the group, with some questions from the audience.  Slides/screenshots optional.
  
After all the Hacks have been pitched, we'll have a little break for people to chat and work out which Hack they want to work on.  
+
After all the Hacks have been pitched, we will have a little break for people to chat and work out which Hack they want to work on.  
 
+
If a Hack ends up with fewer than 2 people wanting to work on it (including the sponsor), then it will normally be dropped.  This is to encourage people to work in groups - larger teams can get more done in the time, and have more opportunities to learn from each other, plus it's more sociable!
+
 
+
==Sunday 15th November 2000-2200 UTC.  Wrap-up and demos==
+
  
At the end of the hackathon we'll have a get together and have each team present the results of their hack. 
+
If a Hack ends up with fewer than 2 people wanting to work on it (including the sponsor), then it will normally be dropped.  This is to encourage people to work in groups - larger teams can get more done in the time, and have more opportunities to learn from each other, plus it is more sociable!
  
Depending on the number of hacks, each team will have 5-15 minutes to demonstrate their hack, describe what they've learned, and what their next steps are.
+
=== Sunday 15th November 2000-2200 UTC.  Wrap up and demos ===
 +
At the end of the hackathon we will have a get together and have each team present the results of their hack.
  
We'll finish with voting for the best hack of the weekend.
+
Depending on the number of hacks, each team will have 5-15 minutes to demonstrate their hack, describe what they have learned, and what their next steps are.
  
=FAQ=
+
We will finish with voting for the best hack of the weekend.
  
'''Q''': What's the aim of the Hackathon?<br />
+
== FAQ ==
'''A''': To learn and have fun hacking FlightGear.  Encourage people to get their hands dirty and modify code.  Try out new ideas.  Working with other people.  Ultimately increase the number of core developers.
+
'''Q''': What is the aim of the Hackathon?<br />
 +
'''A''': To learn and have fun hacking FlightGear.  Encourage people to get their hands dirty and modify code.  Try out new ideas.  Working with other people.  Ultimately to increase the number of core developers.
  
 
'''Q''': What can participants expect to get out of the weekend?<br />
 
'''Q''': What can participants expect to get out of the weekend?<br />
Line 100: Line 93:
  
 
'''Q''': What organization will be provided?<br />
 
'''Q''': What organization will be provided?<br />
'''A''': We'll provide tools for collaboration, and organize a couple of meetings, but not much more.  The idea behind hackathons is that participants largely self-organize - teams form around interesting ideas on Friday evening and organize themselves.  Participants will need to provide their own computers, pizza, haribo, beer.  The last three are traditional, but optional.
+
'''A''': We will provide tools for collaboration, and organize a couple of meetings, but not much more.  The idea behind hackathons is that participants largely self organize - teams form around interesting ideas on Friday evening and organize themselves.  Participants will need to provide their own computers, pizza, Haribo, beer.  The last three are traditional, but optional.
  
 
'''Q''': How much time do I need to commit?<br />
 
'''Q''': How much time do I need to commit?<br />
'''A''': The more the better.  A traditional hackathon would be 24-48 hours of solid work with sleep optional.  That's not realistic for most people, but 20 hours over the weekend would be a good amount to aim for.  Certainly if you can only commit to a couple of evenings you may not get much out of Hackathon.
+
'''A''': The more the better.  A traditional hackathon would be 24-48 hours of solid work with sleep optional.  That is not realistic for most people, but 20 hours over the weekend would be a good amount to aim for.  Certainly if you can only commit to a couple of evenings you may not get much out of Hackathon.
  
 
'''Q''': What skills do I need?<br />
 
'''Q''': What skills do I need?<br />
'''A''': It depends on what you want to do.  You need to know C/C++ already to be able to hack the core of FlightGear.  The Hackathon isn't a good place to learn C++ for the first time.  However, there are lot of interesting projects using python, Nasal etc.   
+
'''A''': It depends on what you want to do.  You need to know C/C++ already to be able to hack the core of FlightGear.  The Hackathon is not a good place to learn C++ for the first time.  However, there are lot of interesting projects using Python, Nasal etc.   
  
'''Q''': I've got a great idea for the Hackathon.  What do I do?<br />
+
'''Q''': I have got a great idea for the Hackathon.  What do I do?<br />
'''A''': Great!  Create a wiki page describing it to enthuse other people and collect comments, and post a link to the Ideation section above so everyone can see it.
+
'''A''': Great!  Create a wiki page describing it to enthuse other people and collect comments (see [[#Ideation]] section above), and post a link to the Ideation section above so everyone can see it.
  
 
[[Category:Hackathon Materials]]
 
[[Category:Hackathon Materials]]

Revision as of 06:09, 14 October 2020

This is the landing page for the Virtual FSWeekend Hackathon 2020.

Normally in mid-November a group of FlightGear enthusiasts participate in FSWeekend at Lelystad Airport in the Netherlands. Over the years this has been a focal point for both finishing existing development/releases and a catalyst for new ideas in FlightGear, as well as an opportunity for FlightGear enthusiasts to share a beer. FSWeekend 2020 was cancelled, so to keep the spirit alive, we are planning to hold a Virtual FSWeekend Hackathon on the weekend of 14/15 November.

Hackathon?

For those who have not participated in a hackathon before, the broad idea is to get people from a wide variety of experience and backgrounds together to solve problems over a short period of time - typically 24 or 48 hours. Details vary, but typically at the start of the event, people pitch ideas and groups form organically based on what people are interested in. The groups then work together intensively, often fueled by pizza and caffeine etc. At the end of the hackathon the groups present their work and there are often prizes for the best hacks.

The idea of the virtual FSWeekend hackathon would be to encourage existing and new contributors to collaborate over the course of the weekend to create new and exciting features for FlightGear in the broadest sense. James and I would particularly like to use it as an opportunity to encourage people to get their hands dirty in the core code, so we will be primarily there to help people rather than hacking ourselves, but anything is possible :)

No prior development experience is necessary - we will try to run some education sessions ahead of the weekend so people can hit the ground running. Also, do not feel you have to commit to coding the entire weekend to the exclusion of all else. I think participants will still get real value if they can just commit to one day and some late evenings.

Sign up

To register your participation, please contact Stuart either on the forum post This is a link to the FlightGear forum., or via the -devel list.

Confirmed participants (in no particular order):

  • Stuart Buchanan
  • James Turner
  • merspieler
  • wlbragg
  • Rick Gruber-Riemer (vanosten)
  • Marc Eberhard
  • Julian Smith
  • Fernando García Liñán
  • Henning Stahlke
  • Pat Callahan
  • Isaak Dieleman
  • Michael Filhol
  • Patrick Trottier

Ahead of the Hackathon

There are a couple of key activities ahead of the weekend.

Getting started

So we can hit the ground running, we really want everyone participating to already have:

  • SourceForge credentials
  • A working build environment with OSG, PLIB etc.
  • A Git checkout of simgear/flightgear
  • A Git checkout of fgdata
  • Some experience with Git :)

James and Stuart will pull together (and improve) the wiki resources to make this easier.

Ideally, we would have a couple of weeks upfront to identify articles that would be useful to provide rough guidance, either to update these or rewrite/merge them with other articles.

Candidate articles are currently being put into the dedicated Hackathon Materials category.

If we can agree on a set of articles that seem useful (to walk people through the process of patching FlightGear to add self-contained functionality), it might make sense to reach out to the community to help with reviewing/proof reading and possibly translate such articles. Also, encouraging people to contribute artworks might be a good idea (screen shots, images, diagrams, drawings etc).

Logistics

Being completely remote, we need the ability to collaborate in teams as well as video conference as a group.

We will try to have some sort of video conference running permanently for people to drop into, as well as some collaboration tool that can be used both by individual teams as well as the whole group for general support.

Ideation

The core of the Hackathon! These are the projects, idea and problems that participants will be working on during the weekend. In the weeks before the hackathon itself, participants can, and should, propose things to work on. Simply create a wiki page describing your idea, and encourage people to contribute and get interested.

Simply use the {{Hackathon Proposal}} template and your idea will magically appear on the Hackathon_2020_Ideas category page.

Not got an idea? No problem! Have a look at the ideas above, leave a comment on the Discussion page, and add yourself as an Interested Party for those you might consider working on during the Hackathon. There is no commitment until Friday evening.

Materials

Schedule

With (hopefully) a world-wide group of participants, and varying real life constraints, at any given time over the weekend there will hopefully be a couple of people active.

We will have two big get-togethers:

Friday 13th November 2000-2200 UTC. Kick-off

  • General welcome
  • Introductions
  • Hack pitches
  • Team formation

This is the point at which participants will decide which Hacks they want to work on. The sponsors of each of the Hacks proposed head of time will be invited to give a 5 minutes pitch to the group, with some questions from the audience. Slides/screenshots optional.

After all the Hacks have been pitched, we will have a little break for people to chat and work out which Hack they want to work on.

If a Hack ends up with fewer than 2 people wanting to work on it (including the sponsor), then it will normally be dropped. This is to encourage people to work in groups - larger teams can get more done in the time, and have more opportunities to learn from each other, plus it is more sociable!

Sunday 15th November 2000-2200 UTC. Wrap up and demos

At the end of the hackathon we will have a get together and have each team present the results of their hack.

Depending on the number of hacks, each team will have 5-15 minutes to demonstrate their hack, describe what they have learned, and what their next steps are.

We will finish with voting for the best hack of the weekend.

FAQ

Q: What is the aim of the Hackathon?
A: To learn and have fun hacking FlightGear. Encourage people to get their hands dirty and modify code. Try out new ideas. Working with other people. Ultimately to increase the number of core developers.

Q: What can participants expect to get out of the weekend?
A: The primary goal is for people to learn through experimentation. To try out new ideas and in the process learn about the internals of FlightGear. James, Stuart and Fernando will be be providing coaching over the course of the weekend.

Q: What organization will be provided?
A: We will provide tools for collaboration, and organize a couple of meetings, but not much more. The idea behind hackathons is that participants largely self organize - teams form around interesting ideas on Friday evening and organize themselves. Participants will need to provide their own computers, pizza, Haribo, beer. The last three are traditional, but optional.

Q: How much time do I need to commit?
A: The more the better. A traditional hackathon would be 24-48 hours of solid work with sleep optional. That is not realistic for most people, but 20 hours over the weekend would be a good amount to aim for. Certainly if you can only commit to a couple of evenings you may not get much out of Hackathon.

Q: What skills do I need?
A: It depends on what you want to do. You need to know C/C++ already to be able to hack the core of FlightGear. The Hackathon is not a good place to learn C++ for the first time. However, there are lot of interesting projects using Python, Nasal etc.

Q: I have got a great idea for the Hackathon. What do I do?
A: Great! Create a wiki page describing it to enthuse other people and collect comments (see #Ideation section above), and post a link to the Ideation section above so everyone can see it.