Created
January 17, 2009 11:05
-
-
Save sr/48310 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sinatra Pimping | |
=============== | |
Ideas/Brain dump | |
---------------- | |
* Do not show the README on the front page. But: | |
* Elevator pitch | |
* Code | |
* Mailing-List, #sinatra, Bug tracker | |
* Explain what are the different doc available | |
* README, for a quick getting started guide | |
* The Book, for deployment tips etc | |
* API, for more well, the others :-) | |
* External resources deserves a better place | |
* cschneid's gittr.com | |
* RubyConf video and talk | |
* ... | |
* Same for blogs of people that contribute/talk about Sinatra | |
* Also, we should have a list of CONTRIBUTOR. I think it makes it more human and community-oriented | |
* The list of apps IMO deserve a better place than a gist. Why? | |
Real apps are IMO great to learn. New to sinatra usually look for | |
how to structure they're app etc. Also, they can act as a showcase. | |
I like <rubyonrails.org> approach a lot (of course Sinatra isn't Rails. I am talking of the general idea). | |
"Get Excited" → "Get Started" → "Get Better" → "Get Involved" | |
When applied to Sinatra: | |
"Get Started" (README) → "Get Better" (Book) → "Get Involved" (Code, IRC, Mailing-List, Lighthouse, ...) | |
Also, the docs might be focused on three big subject (in other word, there should be three web2.0-ish bold link ;-) | |
* Write | |
* Test | |
* Deploy | |
For the app list... well, I don't have much idea. Except maybe pick three-five apps to highlight and link to a page with all of them. But this is arbitrary... I don't know. | |
### Collaboration | |
* Anyone should be able to participe. Here is the "commit" policy I am thinking about: | |
* People from the "pimping team" should have push privilege to github.com/sinatra/website.git | |
* If possible, the collaborators should also be able to deploy to rubyforge. | |
* I think five is a good number. It'd ensure that contributions can be quickly merged. | |
My point is that relying on one person's avalaibility is a *bad* thing. | |
* How about github pages? | |
Twitter could be used to post quick news about Sinatra, link to interesting articles, annoucement, etc. | |
<http://twitter.com/datamapper> is a great example IMO. | |
@sinatra is already taken but we're trying to claim it back. If not possible, I have @sinatrarb | |
### External resources | |
* delicious. easy maintenance, less work. | |
* Do it manually, and have a page on sinatra's website where we link to things. It means more works | |
but also would allow us to only link to the finest | |
TODO | |
---- | |
* Pick-up a way to manage this list. It should be simple, provides a way to follow updates, versionned and | |
allow anyone to participate. | |
* Claim twitter.com/sinatra | |
* Write the front-page text. It should: | |
* include an elevator pitch "Sinatra is at Domain Specific Language (DSL) for quickly creating web-applications in Ruby." ? | |
* link to various materials: | |
* README, as the "Getting Started" guide | |
* The Book, for more, in-deepth documention and various recipes, such as ORM, deployment, etc. | |
* External materials: <gittr.com>, RubyConf video and talk (should those be kept on an other page?) | |
* API, for those who wants "low-level" doc | |
* twitter.com/sinatra(rb) | |
* link to "community" stuff (LH, IRC, ML, etc) | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment