{"action":"created","issue":{"url":"https://api.github.com/repos/videojs/docs/issues/12","labels_url":"https://api.github.com/repos/videojs/docs/issues/12/labels{/name}","comments_url":"https://api.github.com/repos/videojs/docs/issues/12/comments","events_url":"https://api.github.com/repos/videojs/docs/issues/12/events","html_url":"https://github.com/videojs/docs/pull/12","id":117295622,"number":12,"title":"Version docs","user":{"login":"sprice","id":165397,"avatar_url":"https://avatars.githubusercontent.com/u/165397?v=3","gravatar_id":"","url":"https://api.github.com/users/sprice","html_url":"https://github.com/sprice","followers_url":"https://api.github.com/users/sprice/followers","following_url":"https://api.github.com/users/sprice/following{/other_user}","gists_url":"https://api.github.com/users/sprice/gists{/gist_id}","starred_url":"https://api.github.com/users/sprice/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sprice/subscriptions","organizations_url":"https://api.github.com/users/sprice/orgs","repos_url":"https://api.github.com/users/sprice/repos","events_url":"https://api.github.com/users/sprice/events{/privacy}","received_events_url":"https://api.github.com/users/sprice/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":9,"created_at":"2015-11-17T06:56:41Z","updated_at":"2015-12-17T12:19:28Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/videojs/docs/pulls/12","html_url":"https://github.com/videojs/docs/pull/12","diff_url":"https://github.com/videojs/docs/pull/12.diff","patch_url":"https://github.com/videojs/docs/pull/12.patch"},"body":"This PR is by no means complete. Right now it's a simple proof of concept looking for some initial feedback.\r\n\r\nWe should have versioned docs so that when users are relying on documentation they can be certain they see the full and complete docs for the version of video.js they are working with.\r\n\r\nRight now the docs are created against the `master` branch of video.js. There are a couple of reasons this isn't a good thing. One, unless `master` is integrated into `gh-pages` only when a new version is cut, the docs are not a correct representation of the latest version of video.js. Second and more importantly, there's not historical record of docs. If I'm still working on `4.x` there's no guarantee that what I'm looking at is correct. \r\n\r\nI've hacked together a method to capture the version number to use. Right now it's set in two places which sort of sucks (the Gruntfile for the git checkout and the file writing, and the client side JS via `vjs-version.js` for link building). I hope there's a better way to do this.\r\n\r\nThe current changes in this PR are that it does a `git checkout TAG` to get a specific version and then builds the docs within a `docs/VERSION/` directory rather than `docs/`. There's a bunch left to do like fixing up some links, advertising the version on the docs pages, and linking to the correct Github source code. If we agree this is worth doing I'm happy to finish this off."},"comment":{"url":"https://api.github.com/repos/videojs/docs/issues/comments/165438298","html_url":"https://github.com/videojs/docs/pull/12#issuecomment-165438298","issue_url":"https://api.github.com/repos/videojs/docs/issues/12","id":165438298,"user":{"login":"rcrooks","id":619617,"avatar_url":"https://avatars.githubusercontent.com/u/619617?v=3","gravatar_id":"","url":"https://api.github.com/users/rcrooks","html_url":"https://github.com/rcrooks","followers_url":"https://api.github.com/users/rcrooks/followers","following_url":"https://api.github.com/users/rcrooks/following{/other_user}","gists_url":"https://api.github.com/users/rcrooks/gists{/gist_id}","starred_url":"https://api.github.com/users/rcrooks/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rcrooks/subscriptions","organizations_url":"https://api.github.com/users/rcrooks/orgs","repos_url":"https://api.github.com/users/rcrooks/repos","events_url":"https://api.github.com/users/rcrooks/events{/privacy}","received_events_url":"https://api.github.com/users/rcrooks/received_events","type":"User","site_admin":false},"created_at":"2015-12-17T12:19:28Z","updated_at":"2015-12-17T12:19:28Z","body":"I'll have another look.\r\n\r\nI agree with you that it's nice having all the generated docs in master, but will defer to @gkatsev on that."}}