-
Notifications
You must be signed in to change notification settings - Fork 15
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
Fix Linux setup tutorial #7
Conversation
Thanks for the PR, I think the wording in this tutorial is correct because it's referring to running a Linux docker container on a macOS Host machine. Do you have a suggestion for alternative wording for both macOS and Linux host machines? |
The tutorial is split in "Get started on macOS" which sets you up on macOS without Docker or "Get started on Linux using Docker" (see the screenshot). If the tutorial is supposed to be for both macOS and Linux its not obvious at all since macOS is not mentioned. I guess it could work on mac as well, but I feel like the whole tutorial needs to be rewritten if so. |
I mean that's kind of the point. The host OS doesn't really matter, this tutorial should generally work with a windows host as well. If you have suggestions on how to reword the content to make this tutorial more clear, I'd be happy to review it. |
it's for Docker on any platform and not just Linux
@rauhul the documentation has been updated and reworded to better reflect that its for any platform with Docker. |
@rauhul did you get a chance to look at my latest changes? |
Sorry I had forgotten about this pr, I think I would still like to include Linux because it is the guest OS somewhere in the article title. Any ideas? |
@rauhul : Should we call it "Get started on Linux or macOS using Docker"? Or would that be confusing since there will be two tutorials on how to get started on macOS? |
I think mentioning additional host operating systems like macOS is not desirable because this guide should generally also work on windows/wsl. Maybe "Get started on a Linux Docker container", I don't love that title but it's more clear. |
Ok! I have updated the wording to reflect your suggestion. |
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.
Looks good to go, thanks for working through the feedback and contributing!
Updated documentation should now be live |
It seems like the setup instructions in this part was just copy/pasted from the macOS setup. According to the documentation found here the device usually shows up as
/dev/ttyUSB0
on Linux, and that was true for me as well.