From de4838fb2b93a9c925066149e63084d5fdddbabe Mon Sep 17 00:00:00 2001 From: Brady Johnson Date: Mon, 16 Oct 2023 19:25:12 -0600 Subject: [PATCH 1/2] Add aliases for common commands --- content/docs/command-reference/exp/list.md | 2 ++ content/docs/command-reference/exp/remove.md | 2 ++ content/docs/command-reference/move.md | 2 ++ content/docs/command-reference/remove.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/content/docs/command-reference/exp/list.md b/content/docs/command-reference/exp/list.md index a0a7de40f9..584026277b 100644 --- a/content/docs/command-reference/exp/list.md +++ b/content/docs/command-reference/exp/list.md @@ -1,5 +1,7 @@ # exp list +> Aliased to `dvc ls`. + List experiments in a DVC repository (remote or local). ## Synopsis diff --git a/content/docs/command-reference/exp/remove.md b/content/docs/command-reference/exp/remove.md index 0ab6956d7e..8bcee891ef 100644 --- a/content/docs/command-reference/exp/remove.md +++ b/content/docs/command-reference/exp/remove.md @@ -1,5 +1,7 @@ # exp remove +> Aliased to `dvc exp rm`. + Delete specific experiments from the project. ## Synopsis diff --git a/content/docs/command-reference/move.md b/content/docs/command-reference/move.md index 3541afc84a..64f252a1b1 100644 --- a/content/docs/command-reference/move.md +++ b/content/docs/command-reference/move.md @@ -1,5 +1,7 @@ # move +> Aliased to `dvc exp mv`. + Rename a file or directory tracked with a `.dvc` file, and modify the `.dvc` file to reflect the change. The `.dvc` file is renamed if the file or directory has the same base name (typical). diff --git a/content/docs/command-reference/remove.md b/content/docs/command-reference/remove.md index 8d888e7b78..006a0a2f01 100644 --- a/content/docs/command-reference/remove.md +++ b/content/docs/command-reference/remove.md @@ -1,5 +1,7 @@ # remove +> Aliased to `dvc rm`. + Remove stages from `dvc.yaml` and/or stop tracking files or directories (and optionally delete them). From e9feae817fa87502e9c7db26cd3d4d62a163ffac Mon Sep 17 00:00:00 2001 From: Brady Johnson Date: Tue, 31 Oct 2023 23:13:00 -0600 Subject: [PATCH 2/2] Add aliases to linked terms; Fix typos --- content/docs/command-reference/exp/list.md | 2 +- content/docs/command-reference/move.md | 2 +- content/linked-terms.js | 16 ++++++++++++++++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/exp/list.md b/content/docs/command-reference/exp/list.md index 584026277b..cba6bd8192 100644 --- a/content/docs/command-reference/exp/list.md +++ b/content/docs/command-reference/exp/list.md @@ -1,6 +1,6 @@ # exp list -> Aliased to `dvc ls`. +> Aliased to `dvc exp ls`. List experiments in a DVC repository (remote or local). diff --git a/content/docs/command-reference/move.md b/content/docs/command-reference/move.md index 64f252a1b1..3b5394f0aa 100644 --- a/content/docs/command-reference/move.md +++ b/content/docs/command-reference/move.md @@ -1,6 +1,6 @@ # move -> Aliased to `dvc exp mv`. +> Aliased to `dvc mv`. Rename a file or directory tracked with a `.dvc` file, and modify the `.dvc` file to reflect the change. The `.dvc` file is renamed if the file or directory diff --git a/content/linked-terms.js b/content/linked-terms.js index 140e564faa..134a7f4d01 100644 --- a/content/linked-terms.js +++ b/content/linked-terms.js @@ -30,5 +30,21 @@ module.exports = [ { matches: 'dvc ls', url: '/doc/command-reference/list' + }, + { + matches: 'dvc mv', + url: '/doc/command-reference/move' + }, + { + matches: 'dvc rm', + url: '/doc/command-reference/remove' + }, + { + matches: 'dvc exp ls', + url: '/doc/command-reference/exp/list' + }, + { + matches: 'dvc exp rm', + url: '/doc/command-reference/exp/remove' } ]