Add page on collecting logs

docs/contributing.md

@@ -3,7 +3,7 @@
 ## Steps
 
 - Make sure your changes conforms to coding style around it. Please read our [short and sweet coding guidelines](coding_guidelines.md).
-- [File an issue first](https://github.com/Microsoft/AirSim/issues) so we are aware about change you want to make and possibly guide you.
+- [File an issue first](https://github.com/Microsoft/AirSim/issues) so we are aware about change you want to make and possibly guide you.  Please include these [log files](logging.md) when you report an issue.
 - Use [usual steps](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) to make changes just like other GitHub projects.
 - Clean compile your changes on Windows and Linux and test basic simulator operations.
 - When your pull request is created, you might get prompted to one-time sign [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) unless changes are minor. It's very simple and takes less than a minute.

docs/faq.md

@@ -30,3 +30,12 @@ mapping changes.
 
 Yes, Unreal steals the mouse, and we don't draw one.  So to get your mouse back just use Alt+TAB to switch to a different window.
 
+### Build is not working on VS 2017
+
+Known working config is:
+````
+Windows 10 (Education) x64
+VS2015 update 3 (x86) with VC++
+Cmake 3.7 (x86)
+````
+Even though cmake 3.7 says it added support for VS 2017 folks are reporting build issues with that.

docs/logging.md

@@ -0,0 +1,36 @@
+# Logging
+
+When reporting issues it is good to collect some logs so we can reproduce the problem
+and then debug it.
+
+These are the useful things you can do:
+
+1. Add the following information to your issue report:
+````
+Operating System: Windows 10 64bit
+CPU: Intel Core i7
+GPU: Nvidia GTX 1080
+RAM: 32 gb
+Flight Controller: Pixhawk v2
+Remote Control: Futaba
+````
+
+2. The following command will connect MavLinkTest app to the Simulator and enable logging
+of all mavlink commands to and from the PX4.
+````
+MavLinkTest -server:127.0.0.1:14550 -logdir:d:\temp
+````
+
+You will then see log files organized by date in d:\temp\logs.  Please include the specific
+*input.mavlink and *output.mavlink files in a zip file and attach those to the issue report.
+
+3. If you have modified the default ~/Document/AirSim/settings.json, please include your
+settings also.
+
+4. If you are using SITL mode, please copy the log file that SITL produces when drone is armed.
+Please zip it and attach it to the issue. The SITL terminal will contain the path to the log file,
+it should look something like this ``.
+
+5. If you are using Pixhawk hardware in HIL mode, then please setthis parameter: SYS_LOGGER=1
+using QGroundControl, then after the experiment, download the log file using QGroundControl
+and zip that and attach it to the issue.

docs/manual_flight.md

@@ -8,3 +8,4 @@
 Please see [this guide](http://ardupilot.org/copter/docs/common-pixhawk-and-px4-compatible-rc-transmitter-and-receiver-systems.html) for connecting Pixhawk to the RC transmitter.
 
 If you discover any issues during setup, please [let us know](https://github.com/Microsoft/AirSim/issues).
+Please include these [log files](logging.md) when you report an issue.

docs/use_precompiled.md

@@ -1,6 +1,8 @@
 # Coming Soon
 Unreal Environments are highly detailed and generates very large files. We are still trying to figure out the best strategy to host these big binaries. 
+
 If you would like to contribute or have any suggestions, [let us know](https://github.com/Microsoft/AirSim/issues). 
+Please include these [log files](logging.md) when you report an issue.
 
 We *might* be able to make binaries available through private channels as a one-off item to select individuals. Due to licensing 
 restrictions, we cannot make some of our environments available as source code.