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.

Sign up for GitHub

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

Add docs on disabling cli analytics for performance purposes #699

Merged
merged 3 commits into from
Aug 3, 2021
Merged

Add docs on disabling cli analytics for performance purposes #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd8f637
add notes on disabling cli analytics to help performance
mattseddon Jul 31, 2021
9dfcd3c
Merge branch 'master' into update-docs
rogermparent Aug 3, 2021
632471e
Merge branch 'master' into update-docs
rogermparent Aug 3, 2021
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
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ Note: When using any project that relies on an isolated python environment
(conda, venv, etc) the
[ms-python.python](https://github.com/Microsoft/vscode-python) extension needs
to be installed into VS Code. It is used by this extension to locate and utilize
the required environment.
the required environment. Also the CLI's analytics should be disabled as they
severely impact the overall performance of the extension. You can do this by
running `dvc config core.analytics false --global` in your terminal.

## Development Environment

Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A Visual Studio Code Extension that aims to allow users of all technical
backgrounds to effectively use [DVC](https://dvc.org/), particularly the new
[Experiments](https://dvc.org/doc/start/experiments) feature.

This project is in a very early state, and will definitely change in the future.
This project is in a developmental state, and constantly evolving.

## Setup

Expand Down Expand Up @@ -51,6 +51,10 @@ allows for a few different methods for picking how to run DVC.

- Simply calling `dvc` on the CLI is used as a fallback.

- Please disable the CLI's analytics as they severely impact the overall
performance of the extension. You can do this by running
`dvc config core.analytics false --global` in your terminal.

Using the Python extension is the easiest way to use virtual environments, and
using a global install of dvc is the easiest way to not use the Python
extension. For other niche cases, the `dvc.dvcPath` setting should hopefully
Expand All @@ -74,6 +78,9 @@ command from the Command Palette.
To run experiments, use the "Run Experiment" command or use the UI elements
available when the table is visible.

There are experiments related views available in the DVC view container which
can be selected through the DVC icon in the activity bar.

![Experiment GUI Buttons](https://user-images.githubusercontent.com/9111807/118054967-40760300-b355-11eb-8ee6-38a344bdaced.png)

### SCM
Expand Down