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

Fixes for #247 #248

Merged
merged 5 commits into from
Feb 1, 2016
Merged

Fixes for #247 #248

merged 5 commits into from
Feb 1, 2016

Conversation

hamishwillee
Copy link
Contributor

This updates the Installing Files document to (firstly) address the issue raised in #247. The problem in #247 was that this doc references droneapi, which has been superseded. On top of that, this document talked a fair bit about virtualenv, but not the solo script commands, which we now hope people will use.

The change adds a section on how to use solo CLI (and recommending it). The virtualenv section has been simplified, positioned as a "manual option" and droneapi has been replaced with dronekit.

* master:
  add CI badge
  Revert a commit that mistakenly brakes a link
  omit /website/ directory from link check crawler
  remove async from debug test
  debug build assets from gitbook
  lets give circleci a try
  remove gitbook dependency
  fix link to deploy dronekit scripts on solo
  use node 5 on tests
  Make units consistent in document to fix #259
  Change C measurements to Amps
  Updates to accessory board documentation to better display accessory board and explain how to connect to it
  Update battery bay docs. Rename charger doc. Add battery charger image
  Update charger documentation to be charger specific
  Add battery docs to sidebar. Fix rendering issues.
  renamed battery docs with md extension
  Battery docs
  Update hardware-accessorybay.md
  Update hardware-accessorybay.md
  Typo in example-webserver.md
@mrpollo
Copy link
Contributor

mrpollo commented Jan 26, 2016

updated master so it runs tests


<aside class="note">
Solo uses many globally installed packages that may be out of date (in particular, [DroneKit](example-dronekit.html)). Using _virtualenv_ means that you don't need to update the global versions; potentially disturbing native Solo code.
Solo uses many globally installed packages that may be out of date (in particular, [DroneKit](example-dronekit.html)). Using an isolated environment means that you don't need to update the global versions; potentially disturbing native Solo code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Using an isolated environment means that you don't need to update the global versions; potentially disturbing native Solo code." semi-colon should be a comma.

Perhaps this:

Using an isolated environment means that the native Solo code will not be disturbed by updates to the global versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed this to

Solo uses many globally installed packages that may be out of date (in particular, DroneKit), but which cannot be updated without potentially affecting Solo's stability. Using a virtual environment allows you to safely use any package you like.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and in the pip section I made a change to make the caution more explicit.

By default, using pip installs or updates packages in the global Python environment. We recommend that instead you install packages into an isolated environment.

</aside>

First install _virtualenv_ on Solo using _pip_:
The CLI takes care of packaging all the scripts in a folder:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest:
+The CLI takes care of packaging all the scripts in your current folder:

@hamishwillee
Copy link
Contributor Author

@peterbarker This should be ready to merge.

peterbarker added a commit that referenced this pull request Feb 1, 2016
@peterbarker peterbarker merged commit 141f3cb into master Feb 1, 2016
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

Successfully merging this pull request may close these issues.

3 participants