Add documentation on customisations

[hamishwillee]

There have been some new customisation examples added to QGC recently:

• Custom gimbal control - see here for how to enable
• Custom example theme
• Custom build exampole

Minimally each of these needs:

• Documentation in this guide of their existence, and what they provide
• Documentation of how to enable them.
• Explanation of how to customise them.

Propose we create a section/page "Customised Builds" in which we introduce the supported customisations. For each customisation we have single page that covers the points above.

Now it might be for the last point (how to customise the custom example/how the custom code works) that the code is largely self explanatory??? In that case you don't need to say too much - just comment that overridding a "thingy" means creating a file of name xyz in location abc - and that you can either provide your whole new thingy by replacing the files, or tweak the example.

@dogmaphobic You want me to create placeholder docs for these? If so, will have to wait until next week.

[dogmaphobic]

I won't have the time to go into details tonight. They are not "examples" (plural). It's one single custom build of QGC showing how to build your own custom version of QGC while also trying to show all that can be customized within that one project. The end result are not several custom bits but one single, fully customized version of QGC. It should be one single document subdivided into "chapters", describing the various things that you can do to customize QGC.

Also, this is somewhat in its infancy. As we go about it, we find new things that can be customized and the necessary changes are done to QGC in order to allow it. The full customization example lives within the same source tree. The choice between building the "regular" QGC and the "custom" version is one simple switch (the renaming of the "custom-example" directory to just "custom"). That makes it a live example that grows along with QGC itself.

[hamishwillee]

OK. I've adopted the easy solution - assigning this to you for when you have time.

[jafrado]

I updated my tree and tested master again today; while I was there, I tried Gus's custom build. It's self explanatory from README.md; while there I managed to tweak a build for a buddy of mine and his (somewhat odd) preferences. Let me know if there is some Twiki page I can edit to add notes on this.

[hamishwillee]

@jafrado If you can help that would be great. We don't use twiki. Instead this repo contains source code in markdown format for docs, which we build using the legacy gitbook toolchain - ie the source here renders as https://dev.qgroundcontrol.com/en/. Instructions on editing are here: http://dev.px4.io/master/en/contribute/docs.html

I'd suggest creating a page on using this under https://dev.qgroundcontrol.com/en/custom_build/custom_build.html

\https://github.com/mavlink/qgc-dev-guide

[jafrado]

Okey dokey, will try to do this weekend.

[jafrado]

@hamishwillee - made some notes, it's not much. Also have some documentation for using Gimbal I could add ... let me know.

[hamishwillee]

@jafrado Where did you make the notes? For gimbal, if you can send a link I can evaluate what we can use.