-
Notifications
You must be signed in to change notification settings - Fork 394
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
Comments
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. |
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"): It even seems like it is possible to convert automatically a Linux example to a Windows example. |
@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? |
@jorgeorpinel agreed! the first link I would into install/windows. |
@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?) |
This comment has been minimized.
This comment has been minimized.
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 |
@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 - let's create a ticker for the engine to add support for this. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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:
Should we remove/de-emphasize/re-think these Windows terminal tips? |
This comment has been minimized.
This comment has been minimized.
@jorgeorpinel git bash is pretty bad by itself ... let's do some research and recommend one best configuration. |
@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 |
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.) |
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.The text was updated successfully, but these errors were encountered: