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

user-guide: improve Windows POSIX/terminal tips #698

Closed
LucasErlacher opened this issue Oct 15, 2019 · 15 comments · Fixed by #725 or #915
Closed

user-guide: improve Windows POSIX/terminal tips #698

LucasErlacher opened this issue Oct 15, 2019 · 15 comments · Fixed by #725 or #915
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@LucasErlacher
Copy link

For windows users is necessary past to the same line the command when has \ in the end of line.

For example:
dvc get https://github.com/iterative/dataset-registry \ tutorial/ver/data.zip

to

dvc get https://github.com/iterative/dataset-registry tutorial\ver\data.zip

It's also necessary use \ in the path on windows.

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Oct 15, 2019
@shcheklein
Copy link
Member

that's why it's better to keep CLI example as close to one line as possible

Unfortunately, don't see an easy way out of this. Switching modes is too expensive too support at this stage. Open to any other reasonable suggestions.

@dashohoxha
Copy link
Contributor

Unfortunately, don't see an easy way out of this. Switching modes is too expensive too support at this stage. Open to any other reasonable suggestions.

I wonder what doc engine are they using in this tutorial, and how they make it possible to display command snippets with tabs ("Linux/Mac" and "Windows"):
https://dagshub.com/docs/pipeline/#featurization-or-pre-processing

It even seems like it is possible to convert automatically a Linux example to a Windows example.

@jorgeorpinel
Copy link
Contributor

@LucasErlacher did you notice our doc on Windows caveats? We recommend POSIX-like terminals in there: https://dvc.org/doc/user-guide/running-dvc-on-windows

Perhaps we should link to this doc more so people are able to find our recommendations easily?

@shcheklein
Copy link
Member

@jorgeorpinel agreed! the first link I would into install/windows.

@shcheklein
Copy link
Member

@dashohoxha they are using MkDocs . I doubt that it can automatically translate windows <-> linux. Would be great if you can take a look and see what takes for an editor to supports this, how does it look in their markdown (or what do they use as a format?)

@jorgeorpinel

This comment has been minimized.

@dashohoxha
Copy link
Contributor

dashohoxha commented Oct 29, 2019

how does it look in their markdown (or what do they use as a format?)

Unfortunately I could not find the code of their website/docs. DAGsHub does not seem to be open source (although they offer free service for open source projects).

However this discussion has some info about it: https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx

@shcheklein
Copy link
Member

@dashohoxha some suggestions look reasonable. We can't probably use direct MkDocs analog - consequent blocks with different language specifications, since we have a single language usually - dvc or usage, but we can come up with something similar or use something similar to this https://github.com/apache/spark/blob/master/docs/quick-start.md. I wonder how many code snippets are affected by this?

let's create a ticker for the engine to add support for this.

@shcheklein shcheklein reopened this Oct 29, 2019
@dashohoxha

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 25, 2019

Per this conversation I just noticed is that the recommendations in https://dvc.org/doc/user-guide/running-dvc-on-windows may not really be super helpful:

  • We should double check what POSX features other than -- and forward slash / Git Bash and Anaconda Prompt actually support (for example \ line continuation isn't available on Anaconda Powershell Prompt [miniconda]) before recommending them broadly.
  • People may not want to use WSL because apparently it can't access GPUs for training.

Should we remove/de-emphasize/re-think these Windows terminal tips?

@shcheklein

This comment has been minimized.

@shcheklein
Copy link
Member

@jorgeorpinel git bash is pretty bad by itself ... let's do some research and recommend one best configuration.

@shcheklein
Copy link
Member

@jorgeorpinel this is the good recommendation I would test and if it supports all the features we need would recommend it - https://cmder.net/ + git bash + conda

@jorgeorpinel jorgeorpinel added the status: research Writing concrete steps for the issue label Nov 25, 2019
@jorgeorpinel jorgeorpinel changed the title Windows doesn't support '\' (Line continuation). user-guid: improve Windows POSIX/terminal tips Nov 25, 2019
@jorgeorpinel jorgeorpinel changed the title user-guid: improve Windows POSIX/terminal tips user-guide: improve Windows POSIX/terminal tips Jan 14, 2020
@iterative iterative deleted a comment from dashohoxha Jan 14, 2020
@jorgeorpinel jorgeorpinel removed the status: research Writing concrete steps for the issue label Jan 14, 2020
@jorgeorpinel
Copy link
Contributor

recommend it - https://cmder.net/ + git bash + conda

Added in 5c07821 (as part of #915).

By "+ git bash + conda" you mean to not remove those suggestions, but to recommend full Cmder over those alternatives, right? (Feel fee to review in the PR, marked to close this issue.)

@iesahin iesahin added the C: guide Content of /doc/user-guide label Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
5 participants