{"action":"created","issue":{"url":"https://api.github.com/repos/diydrones/dronekit-python/issues/35","labels_url":"https://api.github.com/repos/diydrones/dronekit-python/issues/35/labels{/name}","comments_url":"https://api.github.com/repos/diydrones/dronekit-python/issues/35/comments","events_url":"https://api.github.com/repos/diydrones/dronekit-python/issues/35/events","html_url":"https://github.com/diydrones/dronekit-python/issues/35","id":65383772,"number":35,"title":"DOC: Getting Started - content and structural issues","user":{"login":"hamishwillee","id":5368500,"avatar_url":"https://avatars.githubusercontent.com/u/5368500?v=3","gravatar_id":"","url":"https://api.github.com/users/hamishwillee","html_url":"https://github.com/hamishwillee","followers_url":"https://api.github.com/users/hamishwillee/followers","following_url":"https://api.github.com/users/hamishwillee/following{/other_user}","gists_url":"https://api.github.com/users/hamishwillee/gists{/gist_id}","starred_url":"https://api.github.com/users/hamishwillee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hamishwillee/subscriptions","organizations_url":"https://api.github.com/users/hamishwillee/orgs","repos_url":"https://api.github.com/users/hamishwillee/repos","events_url":"https://api.github.com/users/hamishwillee/events{/privacy}","received_events_url":"https://api.github.com/users/hamishwillee/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":{"login":"hamishwillee","id":5368500,"avatar_url":"https://avatars.githubusercontent.com/u/5368500?v=3","gravatar_id":"","url":"https://api.github.com/users/hamishwillee","html_url":"https://github.com/hamishwillee","followers_url":"https://api.github.com/users/hamishwillee/followers","following_url":"https://api.github.com/users/hamishwillee/following{/other_user}","gists_url":"https://api.github.com/users/hamishwillee/gists{/gist_id}","starred_url":"https://api.github.com/users/hamishwillee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hamishwillee/subscriptions","organizations_url":"https://api.github.com/users/hamishwillee/orgs","repos_url":"https://api.github.com/users/hamishwillee/repos","events_url":"https://api.github.com/users/hamishwillee/events{/privacy}","received_events_url":"https://api.github.com/users/hamishwillee/received_events","type":"User","site_admin":false},"milestone":null,"comments":5,"created_at":"2015-03-31T07:13:20Z","updated_at":"2015-05-06T04:59:08Z","closed_at":"2015-05-06T04:59:08Z","body":"http://python.dronekit.io/getting_started.html\r\n\r\n1. The companion computer information is not sufficiently visible because it is right at the end of a long document. It is also discussed in the body of the doc before it is mentioned. The section could be moved to the top (before SITL) or it more likely we could start with an introductory sentence explaining that we cover both setting up in a simulated environment and on a companion computer, with a link down.\r\n\r\n[Update: This fixed by https://github.com/diydrones/dronekit-python/commit/4054edf65abd2f2ae24d0e02f7890e07a54728ca]\r\n\r\n2. The [Companion computer link](http://dev.ardupilot.com/wiki/companion-computers/) is not very helpful for explaining what you do next. It refers to different hardware and to the DroneAPI rather than DroneKit. As a reader I don't think it will be clear that they are the same thing, and what you do next. I think we need to use DroneKit terminology to make that link clear. It would also help possibly to have this/these docs written so that it is obvious which bit of the task is \"installing dronekit\".\r\n\r\n3. SITL and Installing DroneKit section feels a bit complicated:\r\n\r\n* Set up a simulated vehicle | Dependencies - is just wrong. Should be renamed to \"Setting up in a Virtual Machine\" and should be after the following \"Setting up on Linux\" topic.\r\n\r\n  * Ideally we should note that there are timing issues in a VM but that it is still great for basic app testing.\r\n\r\n   * Link to the VAGRANT setup as it is much better - provided it can do the job (?)\r\n\r\n  * No need to talk about VirtualBox or whatever here as a dependency, that gets covered in the linked docs.\r\n\r\n* [Installing DroneKit](http://python.dronekit.io/getting_started.html#installing-dronekit) looks a bit odd because the \"optional\" dependencies are at the same level as thinks like setting up MAVLink. \r\n\r\nAlso we talk about installing dronekit on windows and MAC, and I find this confusing because we have SITL running on the VM. We need to make it clear where dronekit runs and how it fits with SITL simulation/MAVLINK. \r\n\r\nConsider 2 options: a) putting the \"dependencies\" under a common heading. OR b) have an end to end topic \"Setting up DroneKit on Linux\" and then have separate sections covering setting up on Windows/Mac. These can just say \"it's the same, but instead you need to do X, Y, Z\""},"comment":{"url":"https://api.github.com/repos/diydrones/dronekit-python/issues/comments/99323456","html_url":"https://github.com/diydrones/dronekit-python/issues/35#issuecomment-99323456","issue_url":"https://api.github.com/repos/diydrones/dronekit-python/issues/35","id":99323456,"user":{"login":"hamishwillee","id":5368500,"avatar_url":"https://avatars.githubusercontent.com/u/5368500?v=3","gravatar_id":"","url":"https://api.github.com/users/hamishwillee","html_url":"https://github.com/hamishwillee","followers_url":"https://api.github.com/users/hamishwillee/followers","following_url":"https://api.github.com/users/hamishwillee/following{/other_user}","gists_url":"https://api.github.com/users/hamishwillee/gists{/gist_id}","starred_url":"https://api.github.com/users/hamishwillee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hamishwillee/subscriptions","organizations_url":"https://api.github.com/users/hamishwillee/orgs","repos_url":"https://api.github.com/users/hamishwillee/repos","events_url":"https://api.github.com/users/hamishwillee/events{/privacy}","received_events_url":"https://api.github.com/users/hamishwillee/received_events","type":"User","site_admin":false},"created_at":"2015-05-06T04:59:08Z","updated_at":"2015-05-06T04:59:08Z","body":"Closing this - superseded by #76 76"}}