Help Me Improve The Marionette Wiki

Documentation is difficult to write, and even more difficult to write well so that it covers all of the nuances and details that the people building the actual project tend to assume and forget. My Marionette project is no different. I continue to receive feedback that it’s hard to know what each piece is really best suited for, questions on which View type is best suited for a scenario, and general inquiries for examples on how to implement specific behaviors and features.

And I need your help to answer these questions and improve the documentation and wiki.

The Marionette Wiki

In addition to the technical documentation in the project’s readme, I’ve started up the wiki on the github project page. I’ve begun with two simple pages: an overview on the different view types, and page to let Marionette users show of their projects and websites that are using it.

Help me and the rest of the community of Marionette users improve the documentation for this project by providing examples, best practices, answers to frequently asked questions, and more. 

Head over to the wiki and start helping! 

https://github.com/derickbailey/backbone.marionette/wiki

Topics To Cover

Example topics that should be covered in the wiki:

  • Using Marionette with RequireJS
  • Using JST templates with Marionette views
  • Using Handlebars templates with Marionette views
  • Using jQuery plugins and visual controls with Marionette
  • and much, much more

I realize that some of these are items that I’ve blogged about here. One of my hopes and goals is to have many of the Marionette blog posts from this blog, copied in to the Wiki in a manner that makes sense for the wiki. I will try to do some of this myself, but it would also be wonderfully helpful if other members of the Marionette community could assist in doing this.

I Need Your Help. Yes. YOU.

I know I’m asking a lot – but I believe the community of Marionette users is up to it. It only takes a few minutes of time to improve one page or create a new one with some very basic information. Then another person can come along and make another improvement. Then another, and another. 

Lastly: don’t think “oh, someone else will do it”. They won’t. Believe me. The distribution of responsibility is the single largest reason that people won’t take responsibility or put effort in to something. Everyone assumes that someone else will do it, and no one actually does it.


Post Footer automatically generated by Add Post Footer Plugin for wordpress.

About Derick Bailey

Derick Bailey is an entrepreneur, problem solver (and creator? :P ), software developer, screecaster, writer, blogger, speaker and technology leader in central Texas (north of Austin). He runs SignalLeaf.com - the amazingly awesome podcast audio hosting service that everyone should be using, and WatchMeCode.net where he throws down the JavaScript gauntlets to get you up to speed. He has been a professional software developer since the late 90's, and has been writing code since the late 80's. Find me on twitter: @derickbailey, @mutedsolutions, @backbonejsclass Find me on the web: SignalLeaf, WatchMeCode, Kendo UI blog, MarionetteJS, My Github profile, On Google+.
This entry was posted in Community, Marionette. Bookmark the permalink. Follow any comments here with the RSS feed for this post.
  • Kirk Wood

    Your first topic to write should be “What is Marionette?” Sorry, but this is a pet peeve of mine with open source projects. There seems to be a deep seated belief that if I land there I know what you have.

    The reality is that I may have seen a post while researching for a solution and thought, “Perhaps this might help.” But I won’t know because you don’t tell me. The only clue about what your doing is that it works with RequireJS. Sometimes that is enough, but it might not be.

  • http://twitter.com/scoarescoare scott coates

    When I first landed on the GitHub wiki page I was surprised at how well it was structured. I’ll see what I can do to help out.

  • http://twitter.com/SerkanSerttop Serkan Serttop

    I think what is needed (at least what I would have found most useful) is an api doc page similar to ones at http://backbonejs.org/ or http://underscorejs.org . I would like to help with such api doc, but I am not sure if their structure is allowed for cloning. I did not see any reference to that, nor is there a relevant project at documentcloud’s github account. Do you know if it is possible to use their structure or Is there a similar open source project?

    • http://mutedsolutions.com Derick Bailey

      marionette already has API docs, though they aren’t in the same format. the project homepage at http://github.com/marionettejs/backbone.marionette has the API docs listed in the readme.

      the wiki is what needs more attention. it’s grown significantly since i originally posted this, but still needs more work.

    • http://mutedsolutions.com Derick Bailey

      marionette already has API docs, though they aren’t in the same format. the project homepage at http://github.com/marionettejs/backbone.marionette has the API docs listed in the readme.

      the wiki is what needs more attention. it’s grown significantly since i originally posted this, but still needs more work.

  • http://twitter.com/SerkanSerttop Serkan Serttop

    I think what is needed (at least what I would have found most useful) is an api doc page similar to ones at http://backbonejs.org/ or http://underscorejs.org . I would like to help with such api doc, but I am not sure if their structure is allowed for cloning. I did not see any reference to that, nor is there a relevant project at documentcloud’s github account. Do you know if it is possible to use their structure or Is there a similar open source project?