1: # Hackathon 15
3: The 15th NetBSD hackathon will be run from August 10th through August 14th.
4: This time, it's a documentation hackathon ('docathon'), our main
5: focus is improving the NetBSD documentation and advertising.
7: Join us on the IRC channel #netbsd-code on freenode (irc.freenode.net).
8: Just join, have a look around and ask your questions or what work needs to be done.
10: There's also a thread on netbsd-users, just drop a mail if you're interested.
12: Additionally, this hackathon will be held parallel to the CCC camp (http://camp.ccc.de).
13: Some NetBSD people will be there and expressed interest in a meeting.
14: Mail to the list if you're interested in the meeting, or contact
15: via Jabber (firstname.lastname@example.org) or in IRCNet/Freenode (nick: gnrp).
18: ## Primary goals
20: We see four main goals one could achieve within five days with enough manpower:
22: 1. Update and complete the several guides we have.
23: The NetBSD guide could have some updates (e.g. one could write about npf,
24: or write one guide for it on its own).
25: The internals guide has many XXXs in it, too, and the part about regression
26: testing is factually empty, and perhaps could need one guide on its own.
28: 2. The wiki needs some work on it.
29: The old wiki needs to be migrated completely into the new one.
31: 3. NetBSD could need some new advertising material. Anyone good in writing
32: texts can make new texts for the current flyers, and if you're good with
33: inkscape and scribus, creating one or two posters for exhibitions would be
34: nice, too.
36: 4. Minor improvements (working on manpages), thinking about versioning the
37: documentation, address some topics that was not written about before.
40: ## Possible topics
42: There were several suggestions on what could be done, so here are topics
43: somebody wanted to be addressed:
45: ### Working on guides
46: * Create a list of notebooks and netbooks running NetBSd, what is missing
47: with them and what is running. This page could suit well into the wiki
48: where it is editable by more people.
49: * genfs, fifofs, layerfs and specfs actually have no manpages and nearly no
50: documentation. Documenting them would be good for writing new FSs.
51: * Look into internals guide. Every chapter (except for five) has XXXs in it
52: or misses fundamental information.
53: * Regression testing needs to be documented. It has a chapter in the
54: internals guide, but I want to stress this topic, as it is important for
55: people new to developing with NetBSD.
56: * The Xen-howto could be updated (http://www.lumbercartel.ca/library/xen/
57: might be a good source).
58: LumberCartel has permitted the use of his document,
59: don't forget to give credit and backlink to his pages.
60: * Write an introduction for people coming from Linux and migrating to
61: NetBSD, the main differences to consider, etc.
62: * Create an npf guide (similarly to the PF user's guide
63: http://openbsd.org/faq/pf/index.html). This doesn't need to be as lengthy
64: as the OpenBSD one, but having one would be nice.
65: This can also be addressed in the guide's chapter concerning firewalls.
66: * The pkgsrc guide could also need updates. Additionally, it would be good
67: for people new to pkgsrc if the way make works and how dependencies are
68: automatically resolved would be documented in the guide.
69: That would make it much easier for people who want to contribute.
70: * Write an example on how to migrate NetBSD to a new platform.
71: * Gather and actualize bluetooth information. The chapter in the guide could
72: be updated.
73: * Write an article on how to contribute. At the moment, there is
74: http://www.netbsd.org/contrib/, but having a guide on how NetBSD
75: development really works, where the code lies and how e.g. the website
76: is made (it took me weeks to figure out where the website lies), etc. would
77: be good.
79: ### wiki
80: * [[Migrate articles from the old user wiki to the new one.|wiki/todo/migrate_content_from_wiki.netbsd.se]]
81: * [[Describe your laptop.|laptops]]
82: * Design a new wiki frontpage and think about how to order the wiki. The old
83: user wiki had a pretty nice one.
84: * Create a site for 'general tips' related to NetBSD that don't really fit
85: into any other category.
86: * Think of an easier way for new users (non-developers) to contribute to the
87: wiki. At the moment, the way with getting an OpenID, writing a mail,
88: waiting for creation and activation is long and difficult.
89: One could e.g. think about having a simple NetBSD OpenID-server (SimpleID
90: is quite nice for that) and a registration form so that you don't have to
91: dig through OpenID first to get an account.
93: ### advertising material
94: * Work out posters (potentially A0) for exhibitions. Anybody fond with
95: inkscape, scribus and design could do great work on that!
96: * Work over the advertising materials, the exiting can be seen here:
98: They have nice designs, but are fairly outdated and don't really outline
99: what NetBSDs benefits are.
100: * Design new wallpapers. NetBSD needs nice wallpapers for your desktop. ;)
101: * Write convincing arguments to counter this: http://slonik-v-domene.livejournal.com/98273.html (in Russian,
102: ask some Russian to translate it or do it yourself).
103: Check criticism, identify drawbacks, suggest improvements.
105: ### miscellanous documentation
106: * pcap(3) could need cross-links (e.g. pcap_next and pcap_next_ex).
107: * Work over vfs(9) and vnode(9) (some functions missing), and insert them
108: into the internals guide.
109: * Work through the packages in pkgsrc/x11 and xsrc and document
110: correspondences and version numbers there. This is important for working
111: on pkgsrc's Xorg.
112: * Update the pages for possible projects and bounties, and think of some
113: infrastructure on how to make it easily appendable. Currently, there are
114: three pages for that issue: http://wiki.netbsd.org/projects/,
115: http://wiki-static.aydogan.net/Bounties ([[check this|wiki/todo/migrate_content_from_wiki.netbsd.se]]) and
117: I think, merging them all into one with a good table for all would be
118: possible, also coming up with new and gathering existing ideas and
119: contributing them.
CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb