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

General Feedback #193

Open
djnugent opened this issue Oct 6, 2015 · 1 comment
Open

General Feedback #193

djnugent opened this issue Oct 6, 2015 · 1 comment
Labels

Comments

@djnugent
Copy link
Contributor

djnugent commented Oct 6, 2015

Just read through the docs(didn't execute them)and here are my notes:

Virtualenv
I am new to virtualenv, is it up to me to research it and figure out which parts are applicable to solo or could we have a better explanation of the capabilities and application of virtualenv for Solo.
Here are my question the I have after reading the docs and before researching virtualenv:

  • Can I have multiple virtual environments?
  • Can I clone an existing virtual environment?
  • Not really sure what I should install on solo and what to install in a virtual environment
  • Can I backup a virtual environment?
  • Should the virtual environment be part of my project when I push it to a repo?

Runit
Also new to runit. Not really sure how it works.

  • I never saw it's name used in bash examples. A more detailed breakdown would be nice.
  • Again I don't fully understand it's capabilities so I struggling to figure out use cases
  • run file was mentioned, but I am not sure where it is located.

Video Pipeline

  • The video pipeline diagram seems broken. Is it supposed to appear as a list?
  • I want to acquire video once I start my DK2 script(which seemed confusing to do). What is the advantage of doing from Solo CLI?

Installing DKExample

  • Seems harder than it should be. But that is definitely due to my lack of knowledge of virtualenv and rsync

Formatting

  • love the PC/Solo icons next to bash commands!
  • String falls off page on Yocto Linux page
  • We should make an Additional Resources header for the Dronekit page which just points to python.dronekit.io Make it more obvious that we want the user to visit there. It is a pretty big deal.
  • Would like a similar layout between dronekit.io and dev.3dr.com This guide has made me realize how congested dronekit.io looks.
@hamishwillee
Copy link
Contributor

Good feedback. At the moment the instructions are very "clean" and straightforward with links to runit/virtualenv docs so you can find out more yourself. I think a little more on what you can do with the tools (answering your questions above) makes sense. This probably means splitting the topics into more subsections with clear "overview" vs steps material. I can probably do the docs if "someone" can answer the bullet points.

For the pipeline, the bullet list appears to be a recent change from a flat in-line list. I previously suggested a diagram, with the flow from left to right. Thoughts?

With respect to dronekit theme being croweded we agree. The discussion on this appears to be stalled: dronekit/sphinx_3dr_theme#39

@tcr3dr As first step, would be good if you can provide bullet answers to the above. I am happy to integrate them and do further research, but would save a lot of time if you already know the answers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants