Website versions

[mharris717]

This PR does several things:

• Incorporates @joefiorini's PR to add S3 uploads of built docs.
• Adds ability to build docs for previous versions and upload to S3
• Adds .travis.yml file for travis builds
• Pushes latest docs to an edge S3 bucket on successful travis build.
• Adds page on emberjs.com with links to old docs.

Much of this functionality is in a gem, website_versions, that is now included in website. Obviously we'll want to move this gem over to the emberjs account.

https://github.com/mharris717/website_versions.

Notes:

• Tags to show on "old docs" page are in lib/versions.rb
• Currently the .travis.yml file has my encrypted S3 creds in it, they'll need to be changed.
• Build and push old docs with bundle exec rake versions:deploy_version REF=v0.9.7 S3_ACCESS_KEY_ID=abc S3_SECRET_ACCESS_KEY=xyz
• Build and push edge with bundle exec rake build versions:deploy_edge S3_ACCESS_KEY_ID=abc S3_SECRET_ACCESS_KEY=xyz
• The buckets all follow the same format. http://emberdocsv097.s3-website-us-east-1.amazonaws.com for tag v0.9.7.
• I don't believe the build and s3 commands are throwing proper non-0 error codes on failure, so the travis build doesn't die when something goes wrong.

There is certainly other stuff I need to say, it's not coming to me right now.

All feedback strongly encouraged.

Mike

[joefiorini]

Nicely done @mharris717! Started looking through this, it's looking pretty good. One thought, is that bucket names must match the cname that points to them. For example, if we want VERSION.emberjs.com then the bucket name would have to be v097.emberjs.com. Or we can always deploy latest stable to the www.emberjs.com bucket & master to edge.emberjs.com. Perhaps we can then create versioned archive buckets for each stable version?

[mharris717]

@joefiorini Good point about the bucket names, I'll plan on changing them. I'll wait a couple days and see if anyone cares about the format, then I'll make the change.

[mharris717]

Any movement on this?

[stefanpenner]

@mharris717 I will dedicate some time this sunday for the website. Do you think me and you can coordinate to touch base?

[mharris717]

@stefanpenner sure, whenever you want

[excalq]

As a suggestion, using git tags to denote the corresponding release version associated with the website (and most importantly the docs), would add a lot of organizational value.

[stefanpenner]

@excalq +1

[stefanpenner]

i feel bad, i havent been able to give this any attention :( @mharris717 what is the status? What needs to be done to get this live.

[mharris717]

@stefanpenner no worries. I'll refresh my memory this week and post an update

[stefanpenner]

@mharris717 ping me on gtalk stefan.penner@gmail.com

[mharris717]

Gonna make sure stuff is wrapped up on my end today

[mharris717]

Currently the PR gives weird merge conflicts with master HEAD.

I can rebase the branch and force push it to the same branch, or push to new branch, or something else. Just not sure what proper etiquette is.

also happy to squash stuff if you'd like. just let me know

[joefiorini]

I'm fine if you force push. I'm not sure I even have a local copy.

On Wed, Aug 7, 2013 at 10:08 AM, mharris717 notifications@github.comwrote:

Currently the PR gives weird merge conflicts with master HEAD.

I can rebase the branch and force push it to the same branch, or push to
new branch, or something else. Just not sure what proper etiquette is.

also happy to squash stuff if you'd like. just let me know

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/481#issuecomment-22253571
.

[stefanpenner]

Ya its your branch so feel free to force push. Ping me on gtalk when you have a chance.

[mharris717]

I'll push this afternoon and ping you.

Who handles the travis setup for emberjs/website? I could talk to them and make sure that part gets setup.

[mharris717]

Pushed to mharris717/website_versions.

Things that need to happen:

1. Move the website_versions repo to emberjs github account, and update gemfile in website repo. Optional, but I assume you'll want that.
2. Update the .travis.yml file with encrypted AWS creds, using the emberjs travis account. I can help with this if you let me know who handles travis for emberjs.

[coderberry]

Hey @mharris717 .. this looks great! I spoke with @stefanpenner and he said that he can get us set up with the travis config and s3 setup. I was wondering though if there might be a better place for the link "OLD DOCS" to be at.

The docs only includes the guides right? Maybe we can put it into the side nav under guides. What are your thoughts?

[mharris717]

Currently it builds the entire website, although it looks like the API link at the top of the homepage points to the main site's API.

[mharris717]

I'm testing building a bunch of versions today.

[coderberry]

I think before this one can get merged (it is an important PR), it needs to be decided on where the links should go. @stefanpenner mentioned that it would be nice to have it in the same area as appears on the API pages (top of the nav bar on the side). I'm not sure a dropdown is good but perhaps take the section screenshot I took, move it to the top and replace 'PREVIOUS VERSIONS' with 'v1.0.0-RC7' and be replaced when you select one of the options.

Thoughts?

[mharris717]

Happy to make any changes. Been swamped, will test out various versions in next couple days.

[tomdale]

Now that 1.0 is out, getting this merged in is super important. Can we get the infrastructure in and iterate on a design once it's landed?

[mharris717]

Right now we're waiting on me to make a change I discussed with @stefanpenner last week. I'll get that done and talk with him.

[fivetanley]

@mharris717 If you need any help or guidance let me know!

[samselikoff]

I'd love to help out as well, I think is going to be extremely valuable to the community.

I really like the design of Symfony's docs, for example: http://symfony.com/doc/current/book/routing.html. The version you're looking at is clear, and it's super easy to change. Notice also right below "Routing in Action," the blue alert tells you that the code you're looking at is new as of version 2.2. I think these types of messages would great for Ember!

Here's some info about their docs for reference: http://symfony.com/doc/current/contributing/documentation/overview.html

[joefiorini]

Wow, I like how specific they are in their contribution guidelines. I'm
curious if that's helped them to get more contributions than Rails or Ember
currently get.

The callout you noticed is something they can do easily with Sphinx. To
call out new features like you mentioned they are using a custom admonition.

.. versionadded:: 1.1

  Query parameters were added to the router for Ember 1.1. For prior
versions, please see the query params addon.

Sphinx will convert that to HTML (I believe a paragraph tag by default)
with a class of "versionadded". You can create custom themes to do things
like interpolate the version number to have a label like "New in Ember
1.1:".

On Sat, Sep 14, 2013 at 3:18 PM, Sam Selikoff notifications@github.comwrote:

I'd love to help out as well, I think is going to be extremely valuable to
the community.

I really like the design of Symfony's docs, for example:
http://symfony.com/doc/current/book/routing.html. The version you're
looking at is clear, and it's super easy to change. Notice also right below
"Routing in Action," the blue alert tells you that the code you're looking
at is new as of version 2.2. I think these types of messages would great
for Ember!

Here's some info about their docs for reference:
http://symfony.com/doc/current/contributing/documentation/overview.html

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/481#issuecomment-24455380
.

[samselikoff]

I'm really interested in helping out with this. I think having each page of the docs versioned would be extremely valuable.

Is there (a) grunt work I can help out with, or (b) conceptual research I can do (e.g. look into how Symfony does it) to move this forward?

[bcardarella]

Any updates on this?

[samselikoff]

I'm still available to help, if/when we decide on a direction.

[twokul]

@mharris717 ping.

[legomaniacs]

Hey guys, not sure if these topics are related, but we've been jammed for a while on this problem and would appreciate any help with routing subdomains dynamically and using an S3 storage space for each users content. Thanks! https://stackoverflow.com/questions/25196097/ember-cli-changing-route-path-to-show-subdomain-before-domain-name

[trek]

We've taken a different direction on versioned guides and docs since this, so closing this older issue.