-
Notifications
You must be signed in to change notification settings - Fork 62
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
Fixes for #247 #248
Conversation
* 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
updated master so it runs tests |
…nto hgw_installing_247
|
||
<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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
…nto hgw_installing_247
</aside> | ||
|
||
First install _virtualenv_ on Solo using _pip_: | ||
The CLI takes care of packaging all the scripts in a folder: |
There was a problem hiding this comment.
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:
@peterbarker This should be ready to merge. |
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.