Automatic docs publishing

[RyanZim]

@mde When you published the latest version, what happened with the automatic documentation push to gh-pages? I don't see the branch.

[mde]

I didn't have git-directory-deploy installed (and didn't notice it was a requirement). I will be doing another release soon, so it should update correctly then.

[RyanZim]

@mde It is listed in the devDeps, just run npm i and it should install automatically.

[RyanZim]

BTW, good catch on that root option.

[RyanZim]

@mde If you'd like, I can just run the doc docPublish task to update them now.

[mde]

Yes, I know how to install dependencies. :) I just hadn't noticed it had been added. I'll run the doc task now.

[mde]

Can you verify the gh-pages was correctly updated?

[RyanZim]

@mde Ain't seeing it; let me try.

BTW, is gh-pages listed when running git branch?

[mde]

No, it's not.

[RyanZim]

I ran jake docPublish manually, and it worked fine: http://mde.github.io/ejs/.

[RyanZim]

What was the output when you ran jake publish?

[mde]

It complained about git-directory-deploy not being installed.

[RyanZim]

Sorry, my comment above was incorrect, you need to run jake docPublish to update them on the server. jake doc just updates the local copy. docPublish runs doc first, that pushes to gh-pages.

[RyanZim]

Anyhow, it's working now; let me know if it chokes on the next release. If you're not sure if it worked; take a peek at https://github.com/mde/ejs/tree/gh-pages, and see when the latest commit was.

---

Do you want to hook up the gh-pages to api.ejs.co sometime? If we do that, we should link from ejs.co to there, and include a link to ejs.co from the JSDocs.

[mde]

Ah, I didn't look closely at the Jakefile to see what those tasks do. :)

Sure, let's hook up the API docs. How does GH Pages do domain aliasing?

[RyanZim]

Set api.ejs.co to CNAME mde.github.io.

I'll need to modify the Jakefile to insert a CNAME file just before publishing; PR coming.

The subdomain should then connect after the next release.

[RyanZim]

@mde BTW, do not set a wildcard record (*.ejs.co) pointing to gh-pages; that will allow anyone to publish a site on another subdomain.

[mde]

I only ever set a wildcard to the same as the www server, no worries. :)

[RyanZim]

@mde That's my point; never set a wildcard pointing to any of GitHub's servers.

Danger: Do not use wildcard DNS records (e.g. *.example.com) with GitHub Pages! A wildcard DNS record will allow anyone to host a GitHub Pages site at one of your subdomains.

https://help.github.com/articles/setting-up-a-custom-subdomain/

[mde]

Yes, I was saying I'd never do that -- I would only ever make wildcard entry that points to the same IP address as the existing www or main web server.

[RyanZim]

Here's your PR, merge at will: #219.

[RyanZim]

@mde Can you set the CNAME record for api.ejs.co?

[RyanZim]

@mde ping?

[mde]

I've set it up. Not sure how long it will take to propagate.

[mde]

[RyanZim]

It works! http://api.ejs.co/

[mde]

Sweeeeeeeeet! Sorry this took so long.