marionettejs / marionettejs.com

:triangular_flag_on_post: Source files for the Marionette site
https://marionettejs.com
MIT License
26 stars 32 forks source link

Remove "Requirements" section from home page? #106

Closed jamesplease closed 9 years ago

jamesplease commented 9 years ago

The requirements section can be removed, I think. That information really only needs to be on an installation page...not near the top of our landing page. To me, if Developer Jane comes to our website, the last thing I want her to think about is all of the things she needs on her page for marionette.core.js to work. I want her to focus on all of the problems it solves for you on top of Backbone. Once she has decided to install it is when she will need to know what the reqs are.

jamesplease commented 9 years ago

@samccone brought up his thoughts on this section over here

jdaudier commented 9 years ago

Maybe the requirements section can be replaced with a "Why Marionette?" section with like a bulleted list of the top 3 to 5 reasons

jamesplease commented 9 years ago

That's definitely an option we should consider. I'd like to see what people can come up with for those bulleted items. I'm worried that we won't be able to come up with anything that's as communicative as just showing some really kickass examples on the home page. I like how Ember organizes their page:

Feature A. This is what it does. This is why it kicks ass. Code example. Feature B. ...and so on.

If we make that our homepage, then the entire page is a really in-depth bulleted list, and we don't need to restrain ourselves to trying to summarize really complex ideas in a few words.

But maybe there's a place for both an abridged version and a more detailed one!

kkemple commented 9 years ago

I completely agree with @jmeas, we are on-boarding two new developers right now and when we said we use Marionette both of them asked where they could get good information on how to use it, I have to give them a curated list of blog posts and repos to look at, etc... but really they should be able to get that info just by landing on the homepage.

kkemple commented 9 years ago

We use the docs all the time when we want API specifics but as far as how all the parts fit together we have to send them elsewhere

jamesplease commented 9 years ago

@kkemple, we also plan to have guides which will show very in-depth how all the pieces fit together (#98). My idea for a home page is a bit different from that. You wouldn't send your devs to the home page to learn how the pieces fit. That'd be what the guides are for. But you might send someone who, say, is accustomed to writing plain Backbone to show them how Marionette can clean up their code. It's conveying the same information as a bulleted list showing off our best features, but doing it in slightly more detail. Does that make sense?

kkemple commented 9 years ago

@jmeas yeah absolutely, when I said how to use it, I really meant what it is. More along the lines of what you were saying, the features of Marionette, why use it, where does it improve upon Backbone, etc. Not so much on application structure and implementation specifics, although I am looking forward to the guides as well!

Something like Ember's homepage. (As you said :smile:)

jamesplease commented 9 years ago

dope :+1:

peterblazejewicz commented 9 years ago

I think requirements sounds just terrible. Reminds me Windows software stack, (first one from google search): http://www.acmefiles.com/FAQ/windowsdefender/143-what-are-the-system-requirements-for-windows-defender Ember has dependencies but does not print them in bold letters. It's enough to show people what to include in header scripts to get basic idea what's required (and let them use Bower or .zip)

jdaudier commented 9 years ago

"Dependencies" perhaps

jamesplease commented 9 years ago

Ha, good point, @peterblazejewicz! There's no question in my mind that we should obliterate the word 'requirements' from the site altogether. @jdaudier's suggestion to use "Dependencies" is a good one, I think.

I still contend that these dependencies or requirements or whatever we decide to call them don't belong on the home page tho'

jasonLaster commented 9 years ago

Yup! Let's get another page in soon. I had a PR for a second page, it'll be great. We'll have to add some partials get another guy using the layout.

samccone commented 9 years ago

we killed it