marionettejs / www Goto Github PK

Above the "fold"

• link to the docs hosted on the site
• a link to guides
• how to get the code (direct download + install through bower)
• (as a note the design should be able to work without the link to the docs / guides since they are still a work in progress)

New things

• a style guide for tutorials (see how http://emberjs.com/ and http://docs.angularjs.org/tutorial does it)
• a style guide for the doc pages (see http://underscorejs.org/ and http://roots.readthedocs.org/en/latest/extensions.html#file-sorting)

I’ve doublechecked the issues and I think it has gone unnoticed that the 2.1.0 downloads are corrupt. Both core/amd/backbone.marionette.min.js and core/amd/backbone.marionette.min.js simply contain the text Not Found.

This is two-ish issues in one:

Host the Docs on the site

The docs on Marionette are on the Github repo. That's fine, they can still be used, but they're not as accessible as they could be. Putting them on the website and give a nice menu to navigate with would be really helpful to new users, I think.

Create a Getting Start Guide

Marionette has Documentation but lacks an official Getting Started guide. The useful screencast links on the homepage can help a user get started, but I think it'd be even more useful to newcomers for there to be an official 'Getting Started' guide on the site.

The difference between the Docs and Getting Started is that the Docs outline every detail of the API, while the Getting Started guide is a guided introduction to Marionette, but would most likely leave out the finer details. I think a good idea for a Getting Started guide would be several looks at common web app architectures built with Marionette. The two that stand out are single-page apps and multi-page apps.

The goal of the Getting Started Guide, I think, should be to show at least one example of each Marionette class used in its most common form; from CompositeViews to AppRouters. In this way, users would have both the API of every class available to them (through the docs) and an example of each (through the Getting Started guide).

http://cl.ly/image/141z0r0m1Q3x

just need a fallback bg color here, or prefixed gradient.

https://github.com/marionettejs/marionettejs.github.com/pull/6

It seems that both of the links to the marionette package (for v1.5.1) on
http://marionettejs.com/#download contain an empty underscore.js file:

http://marionettejs.com/downloads/backbone.marionette.tar.gz
http://marionettejs.com/downloads/backbone.marionette.zip

Yup

The docs should live in the repository, or maybe even a separate repository just for the docs. Grunt, for instance, has a separate docs repo and builds them/includes in the website with a custom grunt task.

cc @samccone @cobbweb

Bower is an increasingly popular package management for the front-end and currently has both Marionette and some projects building on top of Marionette listed in search.

It would be fantastic if Marionette might consider adding bower install marionette type option to the homepage similar to what AngularJS, Normalize.css and SpineJS have done for their projects :)

Angular:

Normalize:

Spine:

The links that point you to where you can download the Bundled AMD version of MarionetteJS point you to some kind of GitHub HTML file.

http://cl.ly/VbAB

Ref

It would be great to have a screencasts section beneath the videos. So it would go...

• Videos
• Screencasts
• Books

I know DB has a few screencasts and of course BackboneRails =)

http://domandtom.com/

I know that you already had placed a "Docs" reference on "Quick Links" section, but I think it need to be more highlighted.

My suggest goes to a link after "Marionette.js on GitHub" called "Read the documentation". It's an important thing that people – mainly beginners – lost themselves until get right to the point.

Also, I think it's an easy approach to implement and you haven't put too much effort on it to turn it real.

Finally, this suggestion was born when I tried to find out where you placed the official Docs – I had to scroll in and out some times to get onto the documentation.

We did an awesome job at getting the current docs hosted on the site, but now it's time to think about the next step. I'd love to see the API I'm working on get hosted, and then have a separate section for guides, similar to how Ember has it broken up.

We could have guides for Getting Started, Setting up Your First App, Architecture, Wreqr, Views...so many things. But first we need the site configured to support it.

Ping @thejameskyle for the base so we can wrap this

The upgrade tool can be promoted more prominently, for example, on http://marionettejs.com/#download

http://marionettejs.com/docs/v1.8.2/marionette.itemview

Currently not all the headline links work

Hey guys,

OH on twitter, thought I'd open an issue. I'll take a stab at an initial setup next week. I'm not sure how to divide it, but the following things could be useful for someone getting started:

1. Adding MarionetteJS to your project (vanilla JS, RequireJS, CommonJS)
2. Removing boilerplate from your existing app
3. Building an app in Marionette
4. Resources:
   • Tutorials & Screencasts
   • Blog posts (more tips / tricks oriented as opposed to building an entire app)
   • Integrations & Boilerplates (Yeoman, Rails, Mimosa, w/e).

Would like to hear your thoughts.

Cheers!

For instance

Marionette.ItemView

should have all of the Marionette.View docs inside of it..

and so on and so on

via marionettejs/backbone.marionette#1746

Marionette logo on the homepage doesn't dance when you click "Make your Backbone applications dance!"

Hi, guys,
Nice thing about Backbone that you can open developers tools on its site and try to write something.
It would be cool if you could press F12 at Marionette's home page and have some fun.

Now I have to go to JSBin (need a few clicks) or JSFiddle (oh, have to find cdn).

Putting up our docs on the site is, in my mind, the mark of our website reaching v1. You guys did a ton of great work getting us here, and I'm really, really happy with what you've accomplished. Nice job @thejameskyle @jasonLaster @ahumphreys87 and @samccone! Moving traffic from the Github README's to the website is a really good step for us, I think. (...Ok so I know we're not quite done. We still need to link and stuff. But whatevs. Close enough.)

Anyway, once that's all squared away we'll need to start looking at what's next. So I'm making this issue to list what I'd like to see for the second version of the site. These are some lofty goals, but I think we can do it. And it goes without saying that I'd like y'alls feedback on these goals, and I'd love to hear what you think we should work on.

v2 goals

1. Unified website/docs theme. This could involve a major redesign of the site, or maybe minor tweaks. Either way I think they should look like the same entity. Right now the site looks fine, and the docs look fine, but they're much too different.
2. Splitting out the docs into API/Guides/Getting Started sections. In v2 of the site I want each of these endeavors to be off to a strong start, and a lot of my own resources will go toward making this a reality. I'll probably just go crazy for a week and try to finish all a first draft of the API in one go.

Yup, so just two goals. But I think it's enough work to keep us busy.

For v3, I'd like to see us utilize our website as a resource to the fullest extent that we can. We should have downloads for every version. We should have links to screencasts and tutorials. Meetup info, our official blog, changelogs, links to all of the tools we build for Marionette (upgrade scripts, polyfills)...all of this should be on the site in an intuitable, organized way.

Our website is our face, and likely the first thing people go to when they research the project. And when they do I want them to be compelled to sit down and learn what makes Marionette so awesome. I'm not sure if our website does that quite yet, but if we work on it some more I'm confident we can make it that way.

Can you get David's latest book added to the site?

https://leanpub.com/marionette-serious-progression

embed code:

<iframe width="160" height="400" src="https://leanpub.com/marionette-serious-progression/embed" frameborder="0" allowtransparency="true"></iframe>

ping @davidsulc

migrated from https://github.com/marionettejs/marionettejs.github.com/pull/9/files

The talk I gave at BackboneConf would be a good fit for the videos section. The youtube URL is here: http://www.youtube.com/watch?v=qWr7x9wk6_c

A couple different projects have customized jsbin's that have some default code and themes in place. I think we should do the same.

https://github.com/jsbin/jsbin/tree/bd5a9f5df87e88f051f331fc6e725a31acd1f304/public/custom

http://emberjs.jsbin.com/

Currently the docs on the site dont have an index page. Create an index page to introduce the app and provide links to sections

Currently the page takes a few seconds to load, I think this is due to the youtube embed and the number of images on the page. I would love to make the page load seem "instant".

This can be done via lazy loading images and optimizing the CSS for the site.

Things like behaviors are not present in earlier versions ect ect.

I think we would all agree that moving away from the one-page design is a necessary change for us as we begin work to expand the site. Here's what I think our nav should look like:

Home - The main about page. Much of what we have now can stay on the home page, I think. Just a general overview of what Marionette is.

Guides - All of our guides. Getting started would go here, along with guides on views, Marionette best practices, architecture solutions, and so on.

API - The API, which I think is separate from the guides.

Blog - The official blog. We can write about releases, general tips or strategies, or really, whatever we want here. This lets people know that there's an active core behind the project.

Download - Download every version and every type of build. Also download the individual pieces, or make a custom build.

Community - I'm not sure if we would want a single section for this, but I want a place where we can have information about meetups, and also a place for plugins and so on. One day I can see us having a Curated Backbone Plugins List, where we approve and help maintain popular Backbone plugins. This would give us a stronger footing in the greater backbone community, and help us stand out as an authority on Backbone, which is where I want us to be.

What do y'all think?

We (I am and @alchapone) have proposal to convert markdown docs into web pages. For example we used http://gitbook.io Just need create repo (for github pages) for this docs and point docs.marionettejs.com to it. Here our example: http://alchapone.github.io/marionette.doc/

👋 no more ruby pls

Would be amazing if you could click to the the tests per each API doc!

In jsfiddle template http://jsfiddle.net/derickbailey/M5J8Q/
change the the url of External Resources from "raw.github" to "rawgithub"
Check this https://rawgithub.com/ to see the reason of the problem.
This jsfiddle link is in Getting Started section of marionettejs.com.

h2 of "Downloads and Documentation", but only links to source files. marionettejs.com/#download

On the docs, from this page
http://marionettejs.com/docs/readme.html

ping @ahumphreys87