ardupilot / ardupilot_wiki

Repository for ArduPilot wiki issues and wiki-specific website infrastructure.

ArduPilot Wiki Editing Guide

Visit our main wiki page at ArduPilot.

For comprehensive editing guidelines, please refer to our Editing Guide. Most wiki pages also allow proposing changes, using rudimentary direct editing of the page by clicking the top right link: "Edit on GitHub".

We also have a dedicated documentation channel on our developers' Discord server. Connect with us at ArduPilot Discord Server.

All members of the community are welcome to contribute to this wiki! You can help by creating new articles, re-checking older ones, fixing broken links, or correcting spelling and grammatical errors. Any help is valued.

To participate, all you need is a GitHub account. You can sign up here.

Contribute to the ArduPilot Wiki by joining us today!

ardupilot_wiki's Issues

CHDK has duplicate docs

You can see duplicates in search: http://copter.ardupilot.com/?s=chdk&submit=Search

To log out of WP you have to enter the "first level" credentials

Logout should simply skip this request.

Note that you can log out, but you need to enter the first level credentials.

Randy Copter Fix list

Hamish, All,

On another note, here are the things that I’d like to fix on the copter wiki. I know we may not get to these immediately but I wanted to get them written down in any case.

Formatting changes:

Done: #10 (comment)

Done. Split out assembly section instructions to #23 (comment)

Done. Split up the configuring hardware section: #10 (comment)

Done. Made Pixhawk ahead of APM2 everywhere: #10 (comment)

New/changed contents:

Done/handled elsewhere: Discussion around Planning a Waypoint Mission has been split out to #150

Done/handled elsehwere. Split out "Antenna Tracker needs a set-up video" issue to #149

Done. Parameter reset doc created by Randy: #10 (comment)

Clean up APM2 docs that aren't relevant to current APM2.x generations

Docs under consideration:
http://copter.ardupilot.com/wiki/apm2board/
http://copter.ardupilot.com/wiki/initial-setup/assembly-instructions/
http://copter.ardupilot.com/wiki/connecting-the-escs-and-motors/
http://copter.ardupilot.com/wiki/common-disabling-the-built-in-gps-on-apm2-to-use-an-external-gps-instead/

Tidy CLI pages in Dev Wiki

All CLI content was moved to dev wiki as part of #15 . This task is to tidy those remaining documents.

Mission Planner Terminal
    common-CLI Setup Test modes
    common-Mission Planner Command Line Interface (CLI)
    Mission Planner Command Line Interface (CLI)
    Using the Command Line Interface
    Setting up flight modes with the CLI
    Using the Command Line Interface to Configure APM:Copter

Copter/Mission planning - separate analysis and logs documents

In the Instructions menu.

Config files for common airframes has 2 pages and they need to be merged

These two pages need to be merged back into the first page.

http://plane.ardupilot.com/wiki/flying/tuning/configuration-files-for-common-airframes/
http://plane.ardupilot.com/wiki/configuration-files-for-common-airframes-2/

Investigate improved printing support

The community requirement (posted in the [wiki editors group}(https://groups.google.com/forum/?hl=en#!topic/ardu-wiki-editors/imSJg_lF3DM) ) was a request to support an offline version of multiple wiki documents. For example, an MS word version or pdf version of whole (or selected parts of) the wiki.

This issue is to investigate available plugins and options - e.g. https://wordpress.org/plugins/kalins-pdf-creation-station/ (from http://premium.wpmudev.org/blog/4-plugins-to-provide-pdfs-of-wordpress-posts-but-why-manual-is-better/)

Improve Google Indexing by adding a proper sitemap

There is a well-respected plugin for this. See https://wordpress.org/plugins/google-sitemap-generator/

Mac OS X dev configuration page needs to be updated

This page needs to be tidied up and brought up to date.

http://plane.ardupilot.com/wiki/arm_ide_setup_osx-3/

Mission Planner: Decouple MP/GCS and device setup walkthroughs

There should also be some focus on decoupling the documentation of showing Mission Planner walk throughs on how to configure the device. At best the ardupilot docs should discuss in principal what needs to be configured and the walkthroughs should be a link to numerous GCS pages for the setup walkthrough. This is important as we also have tablet devices that also do the same job as the desktop GCSs.

(BILL B)

Fix cause of apache logs related to translations

Error looks something like:

[Wed Jan 07 22:50:19.087980 2015] [:error] [pid 8556] [client 60.241.80.31:49724] WordPress database error Ta
ble 'multisite.wp_8_download_monitor_files' doesn't exist for query SELECT * FROM wp_8_download_monitor_files
ORDER BY hits DESC LIMIT 5; made by wp_dashboard, do_meta_boxes, call_user_func, dlm_download_top_widget, W3
_Db->query, W3_DbCache->query, W3_DbCallUnderlying->query, W3_Db->query, W3_DbProcessor->query, W3_Db->defaul
t_query, referer: http://ardupilot.com/

The logs can be found using:
grep exist.for.query /var/log/apache2/error.log|cut -d'%' -f2|sort -u|less

Current log list of affected titles:
2.0
2.8
aileron
ailerons
altimeter
and
Antenna
antennatracker
antennatracker-frame-assembly
antennatracker-introduction
APM
ardupilot
autO
AUTO
autopilots
Autopilots
AUTOTORIM
calibration
CLI
Command
common
common-3dr-radio-version-2
common-3dr-radio-version-2/feed/rss2/wiki/common-3dr-radio-version-2

Improve Wordpress wiki load performance

Using google fonts can slow loading as the fetch operation is blocking and the fonts expire immediately. Usually this is not a big problem, but if there are lots of fonts fetched or if google is misbehaving this can significantly impact page rendering (see http://www.webnots.com/fix-slow-page-loading-waiting-fonts-googleapis-com/ ).

Solution for this problem has been to:

• install https://wordpress.org/plugins/disable-google-fonts/ (removes google fonts from the theme).
• In the Nextend menu plugin change the font from google Arimo to Arial (the font was not found locally).

Support proper hierarchical listing of wiki pages

The TOC pages are created using the real time sitemap plugin's [wp-realtime-sitemap] shortcode, which in turn generates listings based on the plugin settings.

The current settings use a menu for the TOC. This is very flexible and allows mixing pages, wiki articles, and links. However it causes problems because
a) the menus are fragile
b) it separates the page from its location in the hierarchy

In addition, it would be useful to be able to list sub-pages etc.

On balance, it would be safer to instead generate the TOC using the parent/page order fields in each page.

1. This cannot be done using the [wp-realtime-sitemap] shortcode - not supported
2. The [wikilist] shortcode does appear to work!

However if we install https://wordpress.org/plugins/page-list/ , we can generate the necessary ordering and also sub-page lists, . This plugin is well respected (very highly ranked) .

Review and merge Python topics

We have a number of Python topics:

• http://plane.ardupilot.com/wiki/common-using-python-scripts-in-mission-planner/ (Official/common topic)
• http://plane.ardupilot.com/wiki/python-scripting-tutorial/ - a copy of http://diydrones.com/profiles/blogs/scripted-fixed-wing-acrobatics. The above topic links to the original topic.
• http://plane.ardupilot.com/wiki/python-3/

Notes:

• These articles were all known to work a year ago.
• Likely to be superseded by new Python scripting layers

Require investigation to determine what can be merged into the common topic. Note that it is fine for us to have multiple topics, but they should be clearly differentiated by what they cover.

Create notification to translation author when original changes

Translations can get out of step with originals. Would be good to be able to identify pages where that is the case, and email authors to give them a chance to retranslate.

Tutorial videos coming up as private (plane)

All but two of these videos are coming up as private on YouTube: http://plane.ardupilot.com/wiki/videoguides/

(originally posted here: http://ardupilot.com/forum/viewtopic.php?f=51&t=4704 )

[site_ArduRover] and friends are not being rendered

The conditional shortcodes to only display text in a particular context are not working (these were part of the theme). They need to be added back into the theme.

varnish cache is not being auto-invalidated on page update

When we edit a wiki page the new page should be immediately visible to all users. To support that we use a wordpress plugin to tell the varnish cache to invalidate any cached content for that page. That used to work, but stopped working on one of the wordpress updates. We need to diagnose and fix that problem.

Fix up the 3DR Radio docs

The documents for the different radios contain a lot of duplication. The proposal is to split them under a landing page with the 3Dr version 2 and version 1 documents containing only the hardware specific information. The country specific information should also be separated.

copter menu points to missing pages

the optional hardware menu includes a link to relay: http://copter.ardupilot.com/wiki/common-relay/

but this in turn directs to this other page: http://copter.ardupilot.com/wiki/common-relay-2/

Developer reports unable to log out of live sites

As above. Once logged in, attempting to log out results in automatic re-login

Search higlighting doesn't work on Firefox

Search higlighting doesn't work on Firefox - see search:

http://copter.ardupilot.com/?s=zener+diode&submit=Search

Highlighting does work on Chrome.

Copter has 2 troubleshooting articles

Merge

• http://copter.ardupilot.com/wiki/troubleshooting-2/ - appears to be more complete.
• http://copter.ardupilot.com/wiki/troubleshooting-guide/ - not been updated for 2 years.

Investigate best way to support localization

Transposh support was turned off during theme update (was getting apache errors, and may have had some effect on stability). The purpose of this issue is to investigate options for localisation support, and to address the following comment by bys1123.

Reorganise copter "assembly instructions"

1. Turn http://copter.ardupilot.com/wiki/initial-setup/assembly-instructions/ into a landing page with links to board-specific sub-pages for APM2, Pixhawk (and maybe PX4).

HW Done.

1. We can leave the big “Typical Quadcopter Layout” image on this landing page. It’s a bit big and scary and it’s for the APM2 so we should replace it with a version for the Pixhawk but.. for now, it’s ok.

HW Removed by changes

1. The “Powering your copter” section should be moved to a new page called “Powering the APM2” which is the equivalent to this one for the Pixhawk: http://copter.ardupilot.com/wiki/common-powering-the-pixhawk/.

HW Done

• It’s possible that some of the top part of this page should also be moved to this new “Powering the APM2” page. http://copter.ardupilot.com/wiki/common-3dr-power-module/

From #10 -

• Re-organise the First-Time-Setup>>Assembly Instructions
  • Group the board-specific set-up instructions by board. I.e. a few pages for Pixhawk, a few pages for APM2

HW Done

• Make separate pages for “Powering the APM2”

HW Done

• Make separate pages for “Powering the PX4”

HW Done

• Somehow consolidate the 4 different versions of the vehicle motor directions diagrams we have (one for each board) on these three pages
• http://copter.ardupilot.com/wiki/connecting-the-escs-and-motors/
• http://copter.ardupilot.com/wiki/common-pixhawk-wiring-and-quick-start/
• http://copter.ardupilot.com/wiki/px4fmu-plus-px4io-wiring/
• http://copter.ardupilot.com/wiki/motor-setup/

HW Done - there is now just a single topic http://copter.ardupilot.com/wiki/connect-escs-and-motors/

Pixhawk wiring should should be split into common and then vehicle specifics

In
http://rover.ardupilot.com/wiki/pixhawk-wiring-rover/
and
http://rover.ardupilot.com/wiki/common-pixhawk-wiring-and-quick-start/

The first half of each page is common (the same) and should be separated out into a common page. This should also be done for PX4 and APM2 wiring.

Then a vehicle specific page should be created highlighting the differences required for each vehicle.

Automated sign-up email should include all necessary information for accessing the system.

Problem is that people keep ignoring the fact there is a 2 level login. Solution is to add this information to email that sends out WP details.

Groundstation description not complete

The description of the HUD in http://copter.ardupilot.com/wiki/common-using-a-ground-station/ is not complete, it ends with 11 (which btw. seems to be wrong description), while the numbers go to 15.

(Originally posted here: http://ardupilot.com/forum/viewtopic.php?f=51&t=9879 )

Make broken links more visible

Currently broken links aren't visible in the wiki text. Highlighting them makes it easier to see and fix them, and while frustrating to users, it is less frustrating to discover a broken link before pressing it.

The menus under dev.ardupilot.com need to be re-structured

These menu items have grown over time. They now need to be sorted out as lots of them at the top level should be grouped together under the same level. Will action this once the new Wiki format comes online.

/indoor-flying/ doc needs to appear in hierarchy

Find a place for http://copter.ardupilot.com/wiki/indoor-flying/

Wiki(s): pages that may need deletion

Wiki text that is copied become the same colour as background (not easy to see)

Need to invert the colour of text when it is being copied in light theme.

Update wiki SITL instructions to use Vagrant

Setup instructions are here: https://github.com/diydrones/ardupilot/blob/master/Tools/vagrant/README.md

Discussion on Drones discuss: https://groups.google.com/forum/#!msg/drones-discuss/PVadRaurYS8/V4hximDr104J

add dev page on firmware binary bisection search

See for example this discussion between me and MarkM
http://diydrones.com/profiles/blog/show?id=705844%3ABlogPost%3A1899907&xg_source=activity&page=3#comments

Add Antenna Tracker to drop-down list under Home

This link: http://copter.ardupilot.com/wiki/common-antennatracker-introduction/

ANGLE_MAX not displayed in auto-generated Copter parameters

ANGLE_MAX does not appear in http://copter.ardupilot.com/wiki/arducopter-parameters/

Move common editor warning and page-title cleanup to a plugin

The warning on common editor pages and the code which strips common- from the title for display is currently in the theme. This can be moved out to a plugin, which will make the theme easier to maintain.

Low priority!

Sik Documentation points to the wrong wiki

https://github.com/tridge/SiK
points to http://code.google.com/p/ardupilot-mega/wiki/3DRadio
but that site has the technical details of the radios that are missing from the new wiki
we need to add the technical details to the dev wiki and rationalize the other radio pages

Broken wiki-style links are shown as normal text

The esimplewiki plugin marks up "invalid" wiki-style ([[Title of page]]) links using class="unwiki", but this is not used in the theme to highlight links. CSS should be added to the theme for this to show the links in red.

Layout: Make sidebar appear on left for 768pt(w) displays

Fix template to keep Side Navigation Bar on left-hand side of screen for tablets.

Also reduce the size of the main text font by a few points, or have options to decrease the size (see below)

Drag'n'drop addition of media files doesn't work

When adding media files to a wiki page it pops up a screen that says you can drag-and-drop the files or push a button to select the file. I found that I couldn't do the drag-and-drop method but the file select did work.

This was tested Firefox. Not clear when problem first occurred but probably within last 4 weeks. I don’t remember having this problem when I updated the px4flow wiki page a couple of weeks ago.

(Originally raised by Randy)

Remove CLI from main wiki sites to dev wiki

The CLI is being phased out on all platforms. The features were massively cut down with AC3.1.5 and then it was removed for the APM2 completely anyway with AC3.2. All CLI functions are now available via regular MAVlink commands in the GCSs.

Consensus is to delete all mention. I'd personally be happy with at least a glossary mention.

These are the pages that need to be removed from the copter wiki:

• Instructions > Advanced Configuration > Command Line Interface (CLI) : http://copter.ardupilot.com/wiki/using-the-command-line-interpreter-to-configure-apmcopter/
• TOC > Advanced Configuration & Tuning > Using the Command Line Interface: http://copter.ardupilot.com/wiki/using-the-command-line-interpreter-to-configure-apmcopter/
• TOC > Advanced Configuration & Tuning > Using the Command Line Interface > CLI Setup Test Modes : http://copter.ardupilot.com/wiki/common-cli-setup-test-modes/
• TOC > Advanced Configuration & Tuning > Using the Command Line Interface > RC Input : http://copter.ardupilot.com/wiki/common-rc-input/
• TOC > Advanced Configuration & Tuning > Using the Command Line Interface > EEProm : http://copter.ardupilot.com/wiki/common-eeprom/

http://copter.ardupilot.com/wiki/common-sensor-testing/
MOVE THIS ONE TO TRASH: http://copter.ardupilot.com/wiki/using-the-command-line-interpreter-to-configure-apmcopter/ ß moved to trash

The pages should of course be deleted from common wiki, and anywhere else they appear.

Delete http://planner.ardupilot.com/wiki/common-apm-2-board/

Delete http://planner.ardupilot.com/wiki/common-apm-2-board/ (this has been replaced by http://copter.ardupilot.com/wiki/common-apm25-and-26-overview/)

Centralised one-click creation of new user accounts

Simplify user account creation as far as possible.

Lidar-Lite wiki: we should add info re the cap that goes between VCC and GND

There's a discussion on diydrones about the exact cap that should be used. I think Philip, Chris Anderson and Tridge all know which cap should be used.

APM Instructions - broken link

I'm trying to learn about log files but when I click through on the link "learn more about working with log files" contained within the APM Throttle Mid page in the APM Copter instructions the link is broken.

Can anyone direct me to where I can find the info, please?

I am struggling to graph data off my apm2.5. I have followed the instructions on the APM Throttle Mid page but there does not appear to be any relevant info in my log file and I cannot graph the data. Trying to find out what I am doing wrong.

(Originally posted http://ardupilot.com/forum/viewtopic.php?f=51&t=7307 )

Parent menu items that are deleted permanently break main menu

If a menu item with sub menu items is deleted, then the sub items are displayed at the wrong level, causing disruption of the main menus. This is a.k.a. "Phantom tortoise problem".

We need either:

1. Mechanism to prevent items being deleted (with reason) if they are in menus
2. Mechanism to ensure that menus still render properly even if parent item is deleted
3. Ideally a good way to detect if items in trash or delete permanently are in menus.

Support versioning information on pages

Add support for page/content version information. Currently plan is to add as Wordpress tags, or possibly as dedicated WP taxonomy.