{"action":"created","issue":{"url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/10","labels_url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/10/labels{/name}","comments_url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/10/comments","events_url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/10/events","html_url":"https://github.com/symphonycms/docs.getsymphony.com/issues/10","id":55377674,"number":10,"title":"Consistent way to indicate versions, when relevant","user":{"login":"tachyondecay","id":337128,"avatar_url":"https://avatars.githubusercontent.com/u/337128?v=3","gravatar_id":"","url":"https://api.github.com/users/tachyondecay","html_url":"https://github.com/tachyondecay","followers_url":"https://api.github.com/users/tachyondecay/followers","following_url":"https://api.github.com/users/tachyondecay/following{/other_user}","gists_url":"https://api.github.com/users/tachyondecay/gists{/gist_id}","starred_url":"https://api.github.com/users/tachyondecay/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tachyondecay/subscriptions","organizations_url":"https://api.github.com/users/tachyondecay/orgs","repos_url":"https://api.github.com/users/tachyondecay/repos","events_url":"https://api.github.com/users/tachyondecay/events{/privacy}","received_events_url":"https://api.github.com/users/tachyondecay/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-01-24T17:07:04Z","updated_at":"2015-01-24T21:23:26Z","closed_at":null,"body":"LIkely most of the documentation will be either version-agnostic or apply to the most recent version. However, the particular situation I’m thinking of would be screencasts that demonstrate a concept using a version of Symphony from years ago.\r\n\r\nIn many cases these screencasts are still useful; Symphony’s backend hasn’t changed too much over the years, and most of the major concepts are the same. We should still use those videos, when possible, at least until someone gets around to making updated versions. But it could confuse new users watching those videos to see an interface slightly different from theirs.\r\n\r\nSo we should establish a consistent way to indicate when a page applies to or features details from a specific version of Symphony. I’m not too familiar with Jekyll, but I’m assuming there’s some way to include templates or otherwise abstract this? Something along the lines of:\r\n\r\n> This screencast features a previous version of Symphony ([version number]). The concepts it demonstrates still apply to the current version, and we have noted any changes below that affect the tutorial.\r\n\r\nThis could appear as a little note at the top of the page, and then as implied below, anything that has changed since the screencast was made can be listed below the video, e.g., \"Utilities editor has since been removed; use your preferred text editor instead.\""},"comment":{"url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/comments/71338000","html_url":"https://github.com/symphonycms/docs.getsymphony.com/issues/10#issuecomment-71338000","issue_url":"https://api.github.com/repos/symphonycms/docs.getsymphony.com/issues/10","id":71338000,"user":{"login":"johnpuddephatt","id":8030910,"avatar_url":"https://avatars.githubusercontent.com/u/8030910?v=3","gravatar_id":"","url":"https://api.github.com/users/johnpuddephatt","html_url":"https://github.com/johnpuddephatt","followers_url":"https://api.github.com/users/johnpuddephatt/followers","following_url":"https://api.github.com/users/johnpuddephatt/following{/other_user}","gists_url":"https://api.github.com/users/johnpuddephatt/gists{/gist_id}","starred_url":"https://api.github.com/users/johnpuddephatt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/johnpuddephatt/subscriptions","organizations_url":"https://api.github.com/users/johnpuddephatt/orgs","repos_url":"https://api.github.com/users/johnpuddephatt/repos","events_url":"https://api.github.com/users/johnpuddephatt/events{/privacy}","received_events_url":"https://api.github.com/users/johnpuddephatt/received_events","type":"User","site_admin":false},"created_at":"2015-01-24T21:23:26Z","updated_at":"2015-01-24T21:23:26Z","body":"Hmmm. I'm not sure what the best solution is here.\r\n\r\nIf we include version information in the front matter, this would need updating on each file for every release. While this is perhaps the *right* thing to do, I'm concerned that in practice it would make the documentation laborious to maintain."}}