Skip to content

Commit

Permalink
win: improve notes about POSIX options and
Browse files Browse the repository at this point in the history
remove term "console" in favor of "terminal" in all docs
  • Loading branch information
jorgeorpinel committed Jul 24, 2019
1 parent 0465fde commit bf396a3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion static/docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ get them [here](https://github.com/iterative/dvc/releases/).
> For a POSIX-like command line terminal in Windows users, we recommend
> [Git Bash](https://gitforwindows.org/#bash) or
> [Anaconda Prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-prompt-win).
> Its even possible to enjoy a full Linux experience with the
> Its even possible to enjoy a full Linux terminal experience with the
> [WSL](https://blogs.windows.com/windowsdeveloper/2016/03/30/run-bash-on-ubuntu-on-windows/)
We also provide `deb`, `rpm` and `homebrew` repositories:
Expand Down
2 changes: 1 addition & 1 deletion static/docs/user-guide/contributing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ setting up.
- **Markdown**: Syntax highlighting in fenced code blocks should use the `usage`
and `dvc` custom languages. `usage` is employed to show `dvc help` commands
output in each command reference doc. `dvc` can be used to show
[DVC-file](/doc/user-guide/dvc-file-format) contents, or examples of console
[DVC-file](/doc/user-guide/dvc-file-format) contents, or examples of terminal
commands and their output.

> Check out any of the command reference `.md` source code to get a better idea.
2 changes: 1 addition & 1 deletion static/docs/user-guide/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ your OS. After that you should have `gcloud` command line tool available and
authenticated with your google account.

You then need to create a bucket, a service account and get its credentials. You
can do this via web UI or console. Then you need to put your keys to
can do this via web UI or terminal. Then you need to put your keys to
`scripts/ci/gcp-creds.json` and add these to your `ENV`:

```dvc
Expand Down
7 changes: 5 additions & 2 deletions static/docs/user-guide/running-dvc-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ They are mostly related to NTFS (a file system that the Windows uses)
characteristics and Windows built-in security mechanisms. Below are some
workarounds that can help avoid these performance penalties:

## POSIX-like command line terminal
## POSIX-like command line shell

Many of the DVC commands have POSIX-style options that are given with a double
dash `--`. This isn't supported by the simple Windows command prompt `cmd`.

We recommend [Git Bash](https://gitforwindows.org/#bash) or
[Anaconda Prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-prompt-win).
Its even possible to enjoy a full Linux experience with the
Its even possible to enjoy a full Linux terminal experience with the
[WSL](https://blogs.windows.com/windowsdeveloper/2016/03/30/run-bash-on-ubuntu-on-windows/)

## Disable short-file name generation
Expand Down

0 comments on commit bf396a3

Please sign in to comment.