Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove CLI from main wiki sites to dev wiki #15

Closed
hamishwillee opened this issue Jan 22, 2015 · 6 comments
Closed

Remove CLI from main wiki sites to dev wiki #15

hamishwillee opened this issue Jan 22, 2015 · 6 comments
Assignees

Comments

@hamishwillee
Copy link
Contributor

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:

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.

@CraigElder
Copy link
Contributor

Let's put the CLI information into the dev section in the documentation.
There are some commands and some details about the NSH shell that would be
good to keep around.

On Wed, Jan 21, 2015 at 6:21 PM, Hamish Willee notifications@github.com
wrote:

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:

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.


Reply to this email directly or view it on GitHub
#15.

@hamishwillee
Copy link
Contributor Author

Craig, any particular documents from the above to keep, or all? (or read carefully and use my judgement?).

Note, this will take a while as I am trying to simultaneously debug and avoid breaking the menus.

@hamishwillee
Copy link
Contributor Author

Following discussions with Craig and Randy I have removed all the CLI content from the menus in planner, copter, plane, rover. I have deleted some content and moved other to dev. I will outline "next steps" in next comment. Detail below:

  • common-eeprom deleted completely from all sites (does not work, and not a particularly useful "use case")
  • common-rc-input deleted completely from all sites (functionality no longer present)
  • commonmission-planner-command-line-interface-cli/ deleted from plane/copter/rover/planner
    • Moved to Dev here
    • Added a note to top explaining CLI is deprecated
  • using-the-command-line-interpreter-to-configure-apmcopter/ - deleted from copter
    • moved to Dev here
    • Added a note to top explaining CLI is deprecated
  • Updated common-cli-setup-test-modes with current running tests.
  • using-the-command-line-interface : this is a parent doc that was already on dev. I Added a note to top explaining CLI is deprecated
  • setting-up-flight-modes-with-the-cli/ moved to dev from copter

As an aside I also removed just the first video in http://planner.ardupilot.com/wiki/common-sensor-testing/ on "Raw sensor display: Enable Raw Sensor Values and Display Sensor Data on Graph Video How To’s Below." This is otherwise fine to leave in planner.

Status

These are now on Dev and need to be merged

Some of these are now waiting approval in the ardupilot wiki group

@hamishwillee
Copy link
Contributor Author

Removed CLI mentions from following without seeking review:

Moved http://planner.ardupilot.com/wiki/mission-planner-terminal/ to DEV (Top image with "Advanced view" circled is important.). Added this and other items to menus (TOC and Instructions). Also defined parents.

Tidied http://copter.ardupilot.com/wiki/troubleshooting-2/

Copied the architectural diagram from http://copter.ardupilot.com/wiki/common-sitl-software-in-the-loop-simulator/ into http://dev.ardupilot.com/wiki/setting-up-sitl-on-linux/. Then deleted (superseded) common-sitl-software-in-the-loop-simulator/ orphans in all sites. Requested by Randy/Craig.

Remove a CLI mention in http://copter.ardupilot.com/wiki/pitfalls/

Deleted these duplicates (discovered while doing CLI testing - approved by Randy):

Deleted CLI from http://rover.ardupilot.com/wiki/sonar-sensors/ and updated formatting

http://plane.ardupilot.com/wiki/apmplane-troubleshooting-guide/ - updated by Grant
http://plane.ardupilot.com/wiki/troubleshooting-3/ - Deleted (poor duplicate of http://plane.ardupilot.com/wiki/apmplane-troubleshooting-guide/ )
http://plane.ardupilot.com/wiki/mpterminal-3/ - Deleted (Grant confirmed)
http://rover.ardupilot.com/wiki/loading-the-code-and-setup/ - Deleted (Grant Confirmed)
Created "common-Autotest System" draft from rover/SITL. Grant to extend.
Deleted http://plane.ardupilot.com/wiki/test-3/ - it is superseded by http://dev.ardupilot.com/wiki/mission-planner-terminal/common-cli-setup-test-modes/ .
Deleted http://plane.ardupilot.com/wiki/sitl-3/ (superseded). Copied relevant information from JBSIM section into http://dev.ardupilot.com/wiki/setting-up-sitl-on-linux/#Step_2_JSBSim . Also created common-Autotest System doc (Grant request).
Deleted http://copter.ardupilot.com/wiki/apm2board/ (superseded)

@hamishwillee
Copy link
Contributor Author

empty

@hamishwillee hamishwillee self-assigned this Jan 26, 2015
@hamishwillee hamishwillee changed the title Remove CLI from the wiki Remove CLI from main wiki sites to dev wiki Jan 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants