From fe49cb86a7e12f4aba45fc36b2972ab0ba512413 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez <jorge@orpinel.com> Date: Fri, 11 Feb 2022 11:13:25 -0500 Subject: [PATCH 1/5] start: use `powershell` highligher for tab toggles per https://github.com/iterative/dvc.org/pull/3215#discussion_r804630813 --- content/docs/start/data-and-model-versioning.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/start/data-and-model-versioning.md b/content/docs/start/data-and-model-versioning.md index b6f795757a..9bdca18b83 100644 --- a/content/docs/start/data-and-model-versioning.md +++ b/content/docs/start/data-and-model-versioning.md @@ -174,9 +174,9 @@ $ rm -f data/data.xml </tab> <tab title="Windows"> -```dvc -$ rmdir .dvc\cache -$ del data\data.xml +```powershell +> rmdir .dvc\cache +> del data\data.xml ``` </tab> From 22c0b83c3125859466c27f220e05337412b036be Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez <jorge@orpinel.com> Date: Fri, 11 Feb 2022 11:37:30 -0500 Subject: [PATCH 2/5] start: Windows command tabs for Versioning page --- .../docs/start/data-and-model-versioning.md | 31 +++++++++++++------ 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/content/docs/start/data-and-model-versioning.md b/content/docs/start/data-and-model-versioning.md index 9bdca18b83..cb2a8c8cb2 100644 --- a/content/docs/start/data-and-model-versioning.md +++ b/content/docs/start/data-and-model-versioning.md @@ -109,10 +109,9 @@ $ git commit -m "Configure remote storage" DVC remotes let you store a copy of the data tracked by DVC outside of the local cache (usually a cloud storage service). For simplicity, let's set up a _local -remote_: +remote_ in `/tmp/dvcstore` (create the dir first if needed): ```dvc -$ mkdir -p /tmp/dvcstore $ dvc remote add -d myremote /tmp/dvcstore $ git commit .dvc/config -m "Configure local remote" ``` @@ -140,12 +139,10 @@ set up earlier. You can check that the data has been stored in the DVC remote with: ```dvc -$ ls -R /tmp/dvcstore -/tmp/dvcstore/: -a3 - -/tmp/dvcstore/a3: -04afb96060aad90176268345e10355 +$ tree /tmp/dvcstore +/tmp/dvcstore +└── a3 + └── 04afb96060aad90176268345e10355 ``` </details> @@ -175,8 +172,8 @@ $ rm -f data/data.xml <tab title="Windows"> ```powershell -> rmdir .dvc\cache -> del data\data.xml +rmdir .dvc\cache +del data\data.xml ``` </tab> @@ -204,11 +201,25 @@ latest version: Let's say we obtained more data from some external source. We can pretend this is the case by doubling the dataset: +<toggle> +<tab title="Mac/Linux"> + ```dvc $ cp data/data.xml /tmp/data.xml $ cat /tmp/data.xml >> data/data.xml ``` +</tab> +<tab title="Windows"> + +```powershell +copy data\data.xml ...\tmp\data.xml +type .../tmp/data.xml >> data\data.xml +``` + +</tab> +</toggle> + </details> ```dvc From 3c2d550cb0c2cee44049fad1d74d9dfaf66ebc11 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel <jorgeorpinel@users.noreply.github.com> Date: Sat, 12 Feb 2022 13:01:00 -0500 Subject: [PATCH 3/5] start: use `dvc` highlighter (and `$`) for Windows cmd blocks per https://github.com/iterative/dvc.org/pull/3273#pullrequestreview-880403668 --- content/docs/start/data-and-model-versioning.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/start/data-and-model-versioning.md b/content/docs/start/data-and-model-versioning.md index cb2a8c8cb2..caeecc1ded 100644 --- a/content/docs/start/data-and-model-versioning.md +++ b/content/docs/start/data-and-model-versioning.md @@ -172,8 +172,8 @@ $ rm -f data/data.xml <tab title="Windows"> ```powershell -rmdir .dvc\cache -del data\data.xml +$ rmdir .dvc\cache +$ del data\data.xml ``` </tab> @@ -213,8 +213,8 @@ $ cat /tmp/data.xml >> data/data.xml <tab title="Windows"> ```powershell -copy data\data.xml ...\tmp\data.xml -type .../tmp/data.xml >> data\data.xml +$ copy data\data.xml ...\tmp\data.xml +$ type .../tmp/data.xml >> data\data.xml ``` </tab> From 0ea1a353ed1c13ed704903e5160147b40fa3fc24 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez <jorge@orpinel.com> Date: Mon, 28 Feb 2022 17:48:52 -0600 Subject: [PATCH 4/5] start: Windows code blocks for /tmp location --- .../docs/start/data-and-model-versioning.md | 48 ++++++++++++------- 1 file changed, 30 insertions(+), 18 deletions(-) diff --git a/content/docs/start/data-and-model-versioning.md b/content/docs/start/data-and-model-versioning.md index 6fdc05bbf5..245e4bfd27 100644 --- a/content/docs/start/data-and-model-versioning.md +++ b/content/docs/start/data-and-model-versioning.md @@ -64,11 +64,11 @@ The data, meanwhile, is listed in `.gitignore`. ### 💡 Expand to see what happens under the hood. `dvc add` moved the data to the project's <abbr>cache</abbr>, and -<abbr>linked</abbr> it back to the <abbr>workspace</abbr>. +<abbr>linked</abbr> it back to the <abbr>workspace</abbr>. The `.dvc/cache` +should look like this: -```dvc -$ tree .dvc/cache -../.dvc/cache +``` +.dvc/cache └── a3 └── 04afb96060aad90176268345e10355 ``` @@ -114,13 +114,27 @@ $ git commit -m "Configure remote storage" DVC remotes let you store a copy of the data tracked by DVC outside of the local cache (usually a cloud storage service). For simplicity, let's set up a _local -remote_ in `/tmp/dvcstore` (create the dir first if needed): +remote_ in a temporary `dvcstore/` directory (create the dir first if needed): + +<toggle> +<tab title="Mac/Linux"> ```dvc $ dvc remote add -d myremote /tmp/dvcstore $ git commit .dvc/config -m "Configure local remote" ``` +</tab> +<tab title="Windows Cmd"> + +```dvc +$ dvc remote add -d myremote %TEMP%\dvcstore +$ git commit .dvc\config -m "Configure local remote" +``` + +</tab> +</toggle> + > While the term "local remote" may seem contradictory, it doesn't have to be. > The "local" part refers to the type of location: another directory in the file > system. "Remote" is what we call storage for <abbr>DVC projects</abbr>. It's @@ -140,12 +154,10 @@ files. ### 💡 Expand to see what happens under the hood. `dvc push` copied the data <abbr>cached</abbr> locally to the remote storage we -set up earlier. You can check that the data has been stored in the DVC remote -with: +set up earlier. The remote storage directory should look like this: -```dvc -$ tree /tmp/dvcstore -/tmp/dvcstore +``` +.../dvcstore └── a3 └── 04afb96060aad90176268345e10355 ``` @@ -174,11 +186,11 @@ $ rm -f data/data.xml ``` </tab> -<tab title="Windows"> +<tab title="Windows Cmd"> -```powershell -rmdir .dvc\cache -del data\data.xml +```dvc +$ rmdir .dvc\cache +$ del data\data.xml ``` </tab> @@ -215,11 +227,11 @@ $ cat /tmp/data.xml >> data/data.xml ``` </tab> -<tab title="Windows"> +<tab title="Windows Cmd"> -```powershell -copy data\data.xml ...\tmp\data.xml -type .../tmp/data.xml >> data\data.xml +```dvc +$ copy data\data.xml %TEMP%\data.xml +$ type %TEMP%/data.xml >> data\data.xml ``` </tab> From 2d89f9f89066dbd0e02cf9336650f269e88ccedd Mon Sep 17 00:00:00 2001 From: Jorge Orpinel <jorgeorpinel@users.noreply.github.com> Date: Tue, 1 Mar 2022 12:11:50 -0600 Subject: [PATCH 5/5] Apply suggestions from code review --- content/docs/start/data-and-model-versioning.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/start/data-and-model-versioning.md b/content/docs/start/data-and-model-versioning.md index 245e4bfd27..bc4efcb6a7 100644 --- a/content/docs/start/data-and-model-versioning.md +++ b/content/docs/start/data-and-model-versioning.md @@ -125,7 +125,7 @@ $ git commit .dvc/config -m "Configure local remote" ``` </tab> -<tab title="Windows Cmd"> +<tab title="Windows (Cmd)"> ```dvc $ dvc remote add -d myremote %TEMP%\dvcstore @@ -227,7 +227,7 @@ $ cat /tmp/data.xml >> data/data.xml ``` </tab> -<tab title="Windows Cmd"> +<tab title="Windows (Cmd)"> ```dvc $ copy data\data.xml %TEMP%\data.xml