sharing exp: document studio.token

iterative · Apr 17, 2023 · 321235b · 321235b
1 parent 46e5578
commit 321235b
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/content/docs/command-reference/exp/push.md b/content/docs/command-reference/exp/push.md
@@ -47,6 +47,10 @@ to see experiments in the remote.
 This command will also try to `dvc push` all <abbr>cached</abbr> data associated
 with the experiments to [remote storage], unless `--no-cache` is used.
 
+If `studio.token` config or `DVC_STUDIO_TOKEN` environment variable is set, DVC
+will notify Studio about new experiments, and display a Studio project URL to
+view experiments.
+
 ## Options
 
 - `-A`, `--all-commits` - push all experiments in the repository (overrides

diff --git a/content/docs/command-reference/exp/remove.md b/content/docs/command-reference/exp/remove.md
@@ -38,7 +38,11 @@ With `--queue`, the list of experiments awaiting execution is cleared instead.
   include all first-parent commits (similar to `git log -n`).
 
 - `-g`, `--git-remote` - Name or URL of the Git remote to remove the experiment
-  from
+  from.
+
+  If `studio.token` config or `DVC_STUDIO_TOKEN` environment variable is set,
+  DVC will ping Studio to remove experiments. Studio automatically removes
+  experiment removed from the Git remote, but this expedites the removal.
 
 - `-h`, `--help` - shows the help message and exit.
 

diff --git a/content/docs/user-guide/project-structure/configuration.md b/content/docs/user-guide/project-structure/configuration.md
@@ -65,6 +65,7 @@ within:
 - [`plots`](#plots) - options for configuring `dvc plots`.
 - [`state`](#state) - see [Internal directories and files][internals] to learn
   more about the state database.
+- [`studio`](#studio) - options for configuring Studio token
 - [`index`](#index) - see [Internal directories and files][internals] to learn
   more about remote index files.
 
@@ -378,6 +379,22 @@ Composition].
 
 <details>
 
+## studio
+
+- `studio.token` - Studio access token to use. When this is set, DVC uses this
+  to notify Studio of new experiments, and provide live updates of metrics and
+  plots to Studio. Alternatively, this can also be specified through
+  `DVC_STUDIO_TOKEN` environment variable. For security reasons, we advise
+  setting token to either a local config or a global config. Note that the above
+  functionality is disabled if the config or the environment variable is not
+  set.
+
+- `studio.url` - URL of Studio to use (in case of self-hosted Studio instance).
+
+</details>
+
+<details>
+
 ## index
 
 - `index.dir` - specify a custom location for the directory where remote index