Posts Tagged documentation

become better at Merb

I hear a lot of people asking for better Merb documentation as they are learning Merb. I remember struggling with the very same problem when I started using Rails a few years ago.

The good news is that the core team is working hard on improving the state of documentation.

You have the Merb Book on which I am actively work on with a team of 20 people (writers, editors and translators).

You also have the documentation browsing application we are developing to let you browse documentation based on where you are in your app.

And of course, you have the 2 beta books (Merb in Action and the Merb way) plus two other ones in the process of being written (Beginning Merb and Merb: What You Need to Know).

Finally, you also have other resources like the Merb peepcode.

The point being that we are actively working on improving the overall state of documentation. However, if you wish to learn more about the internals, how to some more advanced stuff like writing plugins, building your own stack, knowing when to use what component, I would suggest you attend the training class that Yehuda Katz (Merb lead developer) and myself are giving in Phoenix, AZ, January 19-21.

This would give you a rare opportunity to spend time with some of people directly involved with the day to day development of the framework as well as other like minded developers.

Website:       http://merbclass.com
Curriculum:  http://merbclass.com/curriculum.html
Date:            Jan 19-21, 2009
Location:      Phoenix, AZ


View Larger Map

, , ,

No Comments

Merb news (Dec 8 2008)

3 days ago, I announced the Merb Open Source Book project. I expected that few people would be interested as we heard complaints about the lack of documentation.

What I did not expect, was more than 60 emails and pull requests in 2 days, people committing pages of content, fixes and offering their services to translate the book. The mailing list already has 60+ members and the GitHub repository is being watched by 150+ people and has 50+ forks.

While this could be almost overwhelming, I think this is very encouraging. I have to say that since 1.0 got released we heard a lot of praises and and lot of complaints. The Merb team has been trying to prioritize and address reported challenges one after the other. We recently announced that user documentation was our top priority and we decided to work on two projects:

  • better access to the code documentation
  • Open Source book

Code browsing:

Good news, we have an early beta of the new code browser: http://docsbeta.merbivore.com/

This is still an early beta and only works properly on FireFox and Safari. You’ll notice that currently, only merb-core’s public methods are available. merb-more addition is coming soon.

So what’s special about this code browser?

Contextual search and API filtering. In lay terms, you can see what public methods are available to you based on what you are doing. (are you in a controller, model, the console?)

Open Source Book

I put an early beta online: http://book.merbist.com

This is not a static version yet meaning that the markdown files get converted for every single request. I’m waiting for Geoffrey Grosenbach to finish his merb_static plugin. Once he will be done with the spidering, his plugin will automatically export the site as static HTML. The PDF version will be exported using a gem called UFO written by wycats. UFO is a JRuby bridge to Flying Saucer, an awesome Java library which can convert HTML to PDF.

As you can see if you browse the book, we don’t have a lot of content yet. However, you need to realize that we just started 3 days ago! That is what’s so amazing. People didn’t sit back and wait for some core team members to write the content. To the contrary, they have been submitting content and have already started the book translation into 10 languages:

  • English
  • French
  • Japanese
  • Portuguese
  • German
  • Chinese
  • Spanish
  • Russian
  • Bosnian
  • Dutch

I expect to receive the first Italian translations early next week and I was promised some Indian languages too.

Props to the entire community for putting its money where its mouth is!

What’s next?

Yehuda Katz was in Atlanta at MerbDay and had a great keynote about the future of Merb:

However, in the short term, we’ll still focus on documentation, bug fixes and recently added as a top priority: Merb and gem dependencies issues (Rubygems)

DataMapper news

Our good friends from the DM team announced DataMapper 0.9.8 and Extlib 0.9.9. What’s new?
  • update_attributes regression fixed
  • JRuby fixes
  • perf boost

Congrats guys!

, , , ,

5 Comments

Merb news nov-16-2008

I’ll try to keep the community posted on the latest merb news. Feel free to email me if you want me to feature your app, plugin, tool or blog post.

Read the rest of this entry »

, , , , ,

7 Comments

Merb Pre Sprint Meeting

Some of Los Señores del Merb, AKA the Merb “core team” met tonight in a secret location in San Diego, CA. Obviously, we had to meet in a Mexican restaurant and enjoy Tuesday Fish Taco night special ;)

While not everybody could make the trip, Yehuda, Andy, Daniel, Carl and myself met to plan the very first Merb Sprint.

Unfortunately, Michael and Fabien could not make it, but will work remotely during the next few days.

Yehuda sent attendees the following explanations about the Scrum:

“Tomorrow morning, the Merb core team will be setting up around 9am in the sprint room, setting up the git infrastructure for the event, and setting up CI and a wiki for the sprint.

We’re going to be breaking up into a few teams: an inline documentation team, a getting-up-and-running team, and merb-stack team. Each team will be led by a core team member, who will be responsible for pushing the work of the team up to the main merb repository, which will be manned by me throughout the sprint.”

The sprint will focus on 4 main points:

  • inline documentation
  • getting-up-and-running
  • Merb-stack
  • reported tickets (lead remotely by Michael)

This is a really exciting time and things are looking good.

For those wondering about Merb-Stack… well just wait few days and you’ll see ;)

, , ,

No Comments