This repository has been archived by the owner on Jul 22, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
How You Can Help
benjaminoakes edited this page Apr 29, 2012
·
32 revisions
You'd like to help? That's great!
Run into a problem? Contact newhaven.rb on Twitter.
- The web interface can handle most easy changes.
- If you want to work with a local clone, there's a software list that might help you out.
- You can't push by default if you're not a member of the newhaven.rb organization. We'll be happy to give you this access to contribute, but another option is forking and making a pull request. NOTE: the "code" repository may be out of date relative to the "wiki" repository.
You can make any improvement that you'd like, but here are some ideas:
If you feel like you need to coordinate on a task, consider adding a bullet point below with your GitHub username. We may start using GitHub issues, if appropriate.
- Pass the word along! The more eyes and contributors, the better. Examples: tweet, blog, email, tell a coworker, tell a Ruby podcast/blog.
- Click the "watch" button. It's a little like saying "thank you" in GitHub-ese. :)
- Read wiki pages you're interested in. Fixing typos, awkward/confusing wording comes naturally.
-
Check spelling. We have some problems with spelling. Many of these notes were written quickly without a spell checker. Useful tools:
- Most modern browsers have a spell checker, but you might have to do something to show misspelled words. (For example, in Chrome right click -> Spelling and Grammar -> Show Spelling and Grammar.)
-
vim
: turn on the spell checker with:set spell
-
emacs
: a quick search brought up the Checking and Correcting Spelling manual entry - TextMate: turn on the spell checker via Edit -> Spelling -> Check Spelling as You Type (or opt-cmd-;)
-
aspell
,ispell
if you're familiar with them
- Fix formatting. Know Markdown? A lot of this wiki was written offline, so some of the formatting doesn't look right on the web. It'll be obvious when you see it. :)
-
Add links. One of our goals is to have a comprehensive list of links to slides, gems, related sites, videos, etc.
- For slides, some are on Speaker Deck searching for "railsconf", but aren't categorized too well. Others only show up in a Twitter search. There might be more on SpeakerRate too.
- For videos, please see RailsConf 2012 on Confreaks.
- Start a discussion. Anything relating to the talk is fair game. One example of this is the DHH keynote. Also, see the template.
- Contribute missing notes. Talks missing notes are marked with "TODO" on the index.
-
Add notes you've taken yourself. Please add a section (
### From @username
) if you're adding a large block of notes to help reduce merge conflicts, or just integrate with the existing notes. - Improve a talk summary. A summary writting by one person might not be entirely accurate.
- Look for TODOs. Search for "TODO", "FIXME" in the wiki pages for (simple) tasks.
This is a generated list of files with "TODO" or "FIXME". See script/list-todos
.
As of 2012-04-26:
- Basecamp Next: Code Spelunking
- CoffeeScript for the Rubyist
- Home
- Its Not in Production Unless its Monitored
- Lightning Talks
- Practical Machine Learning and Rails
- RailsCore panel
- Rich Hickey Keynote
- Ruby Rogues Live Keynote
- Semi Automatic Code Review
- Taming the Kraken How Operations enables developer productivity
- Ten Things You Didn't Know Rails Could Do
- Using Rails without Rails
- software
- Write a talk summary. Some of the abstracts are a bit long, and sometimes not entirely accurate. Having 3-4 sentences/bullets to summarize would be nice. Also, see the template.
- Work toward a single layout. Adjust existing notes to fit the suggested template, if it makes sense to do so.
- Find more notes. Search for "railsconf" or "railsconf2012" on GitHub (or even Google for blog posts) for people who may be interested in contributing. Keep in mind that they need to be fine licensing their work under the Creative Commons license that we use.
- Combine notes. Many talks had notes taken by multiple people. It would make sense to merge them. This shouldn't be too bad, but will require more thought than the above tasks.
-
Categorize pages. There's not a built in category system like in MediaWiki, so this might need some thought. See below.
- Category pages with links to pages within that category might be all we need. Picking categories would be all that's left. - @benjaminoakes
-
Make a single "Ruby conference" wiki. This would need some discussion. See below.
- I wrote some notes for RubyConf and RailsConf in 2011, which was how this wiki was originally created. :) It might make sense to rename this wiki, move the content here (from anyone who will allow it), and have it all in one place. - @benjaminoakes
- Merge pull requests. If there are any, we need to at least get back to the contributor with a comment.
-
Update the "code" repository. Conceptually, as simple as
git pull wiki && git push code master
. We may want to automate this. -
Add analytics. Figure out if we can use our existing Google Analytics account with this wiki (e.g. via
_Footer.md
). GitHub doesn't provide great analytics on a page-by-page level.- Our options seem limited. See "Add Google Analytics to Github wiki pages". - @benjaminoakes
Photo: John Parker (urgetopunt) (CC BY-NC-SA 2.0)
A crowd-sourced RailsConf wiki!
Working together is better. :)