Skip to content

Commit

Permalink
Edited README.md via GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
chikamichi committed Aug 7, 2011
1 parent d3df550 commit dd727fc
Showing 1 changed file with 1 addition and 46 deletions.
47 changes: 1 addition & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1 @@
**Work in progress**.
**Work in progress**.
**Work in progress**.

## Synopsis

This repository is a gem-like Jekyll application for http://www.ruby-lang.org.

This is the "official" port, created by current contributors to ruby-lang.org (that is, the Visual Identity Team (VIT) as some used to call us). Obviousy, other projects are welcomed, but eventually, there should be only one central ("official") website for Ruby, along other community-based resources such as RubySource, Ruby Inside… Eventually, Matz will decide if people are not able to agree.

## Running the application localy

``` bash
git clone git@github.com:chikamichi/ruby-lang.org.git
cd ruby-lang.org
bundle
thor admin:preview
firefox http://localhost:4000
```

## Infos

This application is based around a Jekyll instance, but makes use of several other libraries and hand-made tools, to ease maintenance and deploy.
Goals:

* maintenance of ruby-lang.org through Github (this repos or another when it's ready)
* page editions through pull requests, anyone is invited (whohoo!)
* (hopefully) easy translations synchronization thx to the git workflow
* (hopefully) a brand new content, hopefully maintained up-to-date thx to the git workflow
* a set of tools for maintainers (deploy etc.)

What's been done so far:

* Thor tasks
* The Jekyll application (templates, basic structure, helpers) – with a little design refresh based on Octopress excellent theme
* A few pages (check under `en` and `fr` subdirectories), but more is coming really soon
* Many discussions on vit-core@ruby-lang.org about what to do next

What's missing so far:

* Most of the content => porting to markdown
* The credits page is important, asap!
* The actual content overhaul (re-thinking everything)
* Deploy tasks
* Asking Matz
* Production-ready checks (links, urls, content missing…) and deployment
SEE [http://github.com/rubylang/ruby-lang.org](http://github.com/rubylang/ruby-lang.org).

0 comments on commit dd727fc

Please sign in to comment.