Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,27 @@ This command reads and updates the DVC configuration files. By default, the
regular project's config file in `.dvc/config` is read or modified. This file is
meant to be tracked by Git and should not contain sensitive and/or user-specific
information (passwords, SSH keys, etc). Use the `--local` command option (flag)
instead, to set (or override) secrets. `--global` and `--system` are also
available to set config options for multiple projects and users, respectively.

| Command option | Priority | Linux location | Windows location |
| -------------- | -------- | ---------------------- | --------------------------------------------------------- |
| `--local` | 1 | `.dvc/config.local` | `.dvc/config.local` |
| None (default) | 2 | `.dvc/config` | `.dvc/config` |
| `--global` | 3 | `~/.config/dvc/config` | `%LocalAppData%/iterative/dvc/config` |
| `--system` | 4 | `/etc/dvc.config` | `%AllUsersProfile%/Application Data/iterative/dvc/config` |
instead, to set (or override) secrets:

| Flag | Priority | Config file location |
| -------------- | -------- | -------------------- |
| `--local` | 1 | `.dvc/config.local` |
| None (default) | 2 | `.dvc/config` |

The `--global` and `--system` flags are also available to set config options for
multiple projects and users, respectively:

| Flag | Priority | Mac location | Linux location | Windows location |
| ---------- | -------- | ---------------------------------------- | -------------------------- | --------------------------------------------------------- |
| `--global` | 3 | `$HOME/Library/Application\ Support/dvc` | `$HOME/.config/dvc/config` | `%LocalAppData%\iterative\dvc\config` |
| `--system` | 4 | `/Library/Application\ Support/dvc` | `/etc/dvc.config` | `%AllUsersProfile%\Application Data\iterative\dvc\config` |

<!-- Avoids new lines in the Flag column (above). -->
<style>
#markdown-root td:first-child code {
white-space: nowrap;
}
</style>

## Command options (flags)

Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ usage: dvc version [-h] [-q | -v]

| Line | Detail |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DVC version`](#components-of-dvc-version) | Version of DVC (along with a Git commit hash in case of a development version) |
| [`DVC version`](#components-of-dvc-version) | Version of DVC (along with a Git commit hash if running a development version) |
| `Python version` | Version of Python used in the environment where DVC is initialized |
| `Platform` | Information about the operating system of the machine |
| [`Binary`](#what-we-mean-by-binary) | Shows whether DVC was installed from a package or from a binary release |
Expand Down Expand Up @@ -44,6 +44,8 @@ The detail of DVC version depends upon the way of installing DVC.
[in our core repo](https://github.com/iterative/dvc/blob/master/dvc/version.py).
For example `0.40.2`.

> 💡 To only get this number, use `dvc -V`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to make it a note?

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Sep 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think its appropriate, because it's not about dvc version.

Still it feels it belongs here (as a note) more than in the cmd ref index (where dvc -C will be, for example).


- **Development version**: `pip install git+git://github.com/iterative/dvc` will
install DVC using the `master` branch of DVC's repository. Another way of
setting up the development version is to clone the repository and run
Expand Down
9 changes: 6 additions & 3 deletions content/docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,10 @@ is available from the big "Download" button on the [home page](/). You can also
get it from the [release page](https://github.com/iterative/dvc/releases/) on
GitHub.

> You'll need to download the installer each time to update DVC.
You'll need to download and run the installer again each time you want to update
DVC. You may use Windows Uninstaller to
[remove the program](https://support.microsoft.com/en-us/help/4028054/windows-10-repair-or-remove-programs).

> You may use Windows Uninstaller to
> [remove the program](https://support.microsoft.com/en-us/help/4028054/windows-10-repair-or-remove-programs).
> Note that this method by default enables symlink permissions for all users, so
> they can use them to
> [optimize DVC](/doc/user-guide/large-dataset-optimization) operations.
24 changes: 19 additions & 5 deletions content/docs/user-guide/running-dvc-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,19 @@ perfect solution, but here are some ideas:
- Install an actual Linux distro (e.g. Ubuntu) on a virtual machine, or in a HD
partition (dual boot).

## Disable short-file name generation
## Enable symbolic links

With NTFS, users may want to disable `8dot3` as per
[this article](https://support.microsoft.com/en-us/help/121007/how-to-disable-8-3-file-name-creation-on-ntfs-partitions)
to disable the short-file name generation. It is important to do so for better
performance when the user has over 300K files in a single directory.
This is done automatically by the DVC's Windows
[installer](/doc/install/windows), but you may want to do it manually after any
other installation methods like (`choco`, `conda`, `pip`).

Symlinks are one of the possible file link types that DVC can use for
[optimization](/doc/user-guide/large-dataset-optimization) purposes. They are
available on Windows, but the
[Create symbolic links](<https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn221947(v=ws.11)>)
user privilege is needed. It's granted to the _Administrators_ group by default,
so running `dvc` in a terminal as an admin is a good option for occasional use.
For regular users, it can be granted using the _Local Security Policy_ console.

## Whitelist in Windows Security

Expand All @@ -60,6 +67,13 @@ Search Indexing can also slow down file I/O operations on Windows. Try
[disabling](https://winaero.com/blog/disable-search-indexing-windows-10/) this
feature if you don't need it.

## Disable short-file name generation

With NTFS, users may want to disable `8dot3` as per
[this article](https://support.microsoft.com/en-us/help/121007/how-to-disable-8-3-file-name-creation-on-ntfs-partitions)
to disable the short-file name generation. It is important to do so for better
performance when the user has over 300K files in a single directory.

## Avoid directories with large number of files

The performance of NTFS degrades while handling large volumes of files in a
Expand Down
3 changes: 3 additions & 0 deletions content/docs/user-guide/setup-google-drive-remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ folder i.e. `gdrive://<base>/path/to/folder`. The base can be one of:
and [shared drives](https://support.google.com/a/users/answer/9310351)\*
(these two can only be referenced by ID).

> ⚠️ The folder in question should be shared to specific users (or groups) so
> they can use it with DVC. "Anyone with a link" is not guaranteed to work.

```dvc
$ dvc remote add myremote gdrive://0AIac4JZqHhKmUk9PDA
```
Expand Down