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

Fix Linux setup tutorial #7

Merged
merged 4 commits into from
Jul 1, 2024
Merged

Fix Linux setup tutorial #7

merged 4 commits into from
Jul 1, 2024

Conversation

naknut
Copy link
Contributor

@naknut naknut commented Jun 20, 2024

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.

@rauhul
Copy link
Collaborator

rauhul commented Jun 20, 2024

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?

@naknut
Copy link
Contributor Author

naknut commented Jun 21, 2024

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.

image

@rauhul
Copy link
Collaborator

rauhul commented Jun 21, 2024

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
@naknut
Copy link
Contributor Author

naknut commented Jun 21, 2024

@rauhul the documentation has been updated and reworded to better reflect that its for any platform with Docker.

@naknut
Copy link
Contributor Author

naknut commented Jun 28, 2024

@rauhul did you get a chance to look at my latest changes?

@rauhul
Copy link
Collaborator

rauhul commented Jun 28, 2024

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?

@naknut
Copy link
Contributor Author

naknut commented Jun 29, 2024

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?

@rauhul
Copy link
Collaborator

rauhul commented Jun 29, 2024

@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.

@naknut
Copy link
Contributor Author

naknut commented Jun 30, 2024

@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.

Copy link
Collaborator

@rauhul rauhul left a 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!

@rauhul rauhul merged commit 3799daf into apple:main Jul 1, 2024
@rauhul
Copy link
Collaborator

rauhul commented Jul 1, 2024

Updated documentation should now be live

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.

None yet

2 participants