{"action":"closed","issue":{"url":"https://api.github.com/repos/autolab/Autolab/issues/403","repository_url":"https://api.github.com/repos/autolab/Autolab","labels_url":"https://api.github.com/repos/autolab/Autolab/issues/403/labels{/name}","comments_url":"https://api.github.com/repos/autolab/Autolab/issues/403/comments","events_url":"https://api.github.com/repos/autolab/Autolab/issues/403/events","html_url":"https://github.com/autolab/Autolab/issues/403","id":62478175,"number":403,"title":"Brush Up Documentation","user":{"login":"jez","id":5544532,"avatar_url":"https://avatars.githubusercontent.com/u/5544532?v=3","gravatar_id":"","url":"https://api.github.com/users/jez","html_url":"https://github.com/jez","followers_url":"https://api.github.com/users/jez/followers","following_url":"https://api.github.com/users/jez/following{/other_user}","gists_url":"https://api.github.com/users/jez/gists{/gist_id}","starred_url":"https://api.github.com/users/jez/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jez/subscriptions","organizations_url":"https://api.github.com/users/jez/orgs","repos_url":"https://api.github.com/users/jez/repos","events_url":"https://api.github.com/users/jez/events{/privacy}","received_events_url":"https://api.github.com/users/jez/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/autolab/Autolab/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":7,"created_at":"2015-03-17T18:30:43Z","updated_at":"2016-10-05T21:55:08Z","closed_at":"2016-10-05T21:55:08Z","body":"Very little of the newer versions of Autolab is documented. We should soon before we market Autolab to a wider audience. We can't exactly redirect people to docs.autolab.cs.cmu.edu where the first bullet point tells them to send an email to ugradlabs.\r\n\r\nIdeally, our documentation should have up-to-date screenshots (or as up-to-date as possible), listings, and maybe even sample terminal output from certain commands.\r\n\r\nHere's a list of some things I think we should make sure is well documented--feel free to edit this description and add to the list:\r\n\r\n- [ ] Installation instructions for the Autolab front end for\r\n  - [x] Mac OS X\r\n  - [x] Ubuntu Linux\r\n- [ ] Installation instructions for Tango back end for\r\n  - [ ] Mac OS X (If this is complicated right now, then we should make sure that it's _very_ clear, because people _will_ want to do this to try it out.)\r\n  - [x] Ubuntu Linux\r\n- [ ] How to create a class\r\n- [ ] How to create an assessment\r\n- [ ] Tips for managing a course\r\n  - We have a lot of buttons, menus, and options that have very similar names: Manage submissions, Grade submisisons, Manage course, etc. It'd be nice to just give some general tips/FAQ, like \"I want to do this => go look here\"\r\n\r\nIdeally, we'd move this into the Autolab Wiki rather than docs.autolab.cs.cmu.edu so all of our documentation is centrally located and easier to keep up to date."}}
{"actor":{"display_login":"nayak16"}}