first iteration on adding an API docs site

[mikepmunroe]

start of fix for issue #235

for now, the site is manually generated using grunt docs task and uses
default YUIdoc styles

future iteration should be similar to jekyll site used for EAK - see
https://github.com/stefanpenner/ember-app-kit/tree/gh-pages

future iterations should also include styles that match other Ember
sites

[mikepmunroe]

@stefanpenner Travis is breaking in this branch, which I guess I would expect because it's only documentation. Any suggestions on what action we should take here? I'm guessing I should work on updating the tests that would potentially get run agains this branch in Travis?

[stefanpenner]

@mikepmunroe we can just make a make test that is a noop, and we should be fine.

[mikepmunroe]

Great. I'll give that a try.

Sent from my iPhone

On Mar 31, 2014, at 8:57 AM, Stefan Penner notifications@github.com wrote:

@mikepmunroe we can just make a make test that is a noop, and we should be fine.

—
Reply to this email directly or view it on GitHub.

[mikepmunroe]

@stefanpenner, I have started in on moving away from the default YUI styles for this. Do you think the styles should match Ember.js site styling or simpler styles similar to styling at http://iamstef.net/ember-cli/. I will also add the noop test to keep travis from failiing.

[mikepmunroe]

Since this is docs for the API on Github to fix issue #235, I will style them with a plane Github looking style.

[stefanpenner]

I like the simplistic style of ember-cli site.

[stefanpenner]

@tomdale @wycats what web-address should RSVP's site live on?

[mikepmunroe]

The latest commit should work for using 'grunt docs' to generate documentation and use a new rsvp theme.

[williamsbdev]

I have the domain rsvpjs.com and would love to get it transferred if someone else would like to take it over. Otherwise I can continue to own it. Right now it is setup for gh-pages. Just add the CNAME file with rsvpjs.com. Thanks!

[stefanpenner]

@williamsbdev sorry, i keep meaning to give you the info to transfer it. What would be easiest?

[williamsbdev]

No worries! I've honestly never transferred a domain before so I'm assuming I just need to know where to transfer it. I'll work with Hover to get that done.

[stefanpenner]

https://rsvpjs.com now points to this repo's GH pages. thanks to @williamsbdev

one step closer

• work on site design
• transfer domain
• ...

[yankeeinlondon]

what ever happened to this? The https://rsvpjs.com URL seems to be down. I had a question about race which I was able to figure by myself but it appeared that this documentation might have answered this. :)

[williamsbdev]

There is no SSL. it is simply http://rsvpjs.com. Since there is no index.html, GH pages does not have anything to supply for this domain. If we were to submit a PR with an index.html, that would get this repo going.

[ferdis]

I think this may have become less relevant since the API docs are also part of the Ember API docs: http://emberjs.com/api/classes/RSVP.html

But I think there's merit in getting proper docs up, as the Ember site doesn't cover most of the modules within rsvp/*. I had to delve into the source to get documentation recently.

[yankeeinlondon]

I would think the primary function of having docs on the rsvpjs.com site is to help nodejs users rather than Ember developers. Regardless, a single source seems a good idea and maybe we could:

• abandon the separate RSVP website
• update the README to point to Ember's docs
• update Ember docs to give full RSVP coverage
• possibly also have a section that just mentions nodejs/backend use cases

[williamsbdev]

Just chiming in to see if people would like me to renew the domain. I got an email about the automatic renewal in a couple months. If we think just adding to the Ember docs is a viable option, I will not renew the http://rsvpjs.com domain.