From ceed44897659de554352a6fba408a79f7490eeb3 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 25 May 2020 13:12:12 -0500 Subject: [PATCH 1/8] cmd ref: update WebDAV remote info per https://github.com/iterative/dvc.org/pull/1187#issuecomment-619568544 --- content/docs/command-reference/remote/add.md | 7 ++++--- content/docs/command-reference/remote/modify.md | 13 +++---------- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index bda945f8d1..db92fde51e 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -350,13 +350,14 @@ $ dvc remote add myremote https://example.com/path/to/dir
-### Click for WebDav +### Click for WebDAV ```dvc -$ dvc remote add myremote webdavs://example.com/path/to/dir +$ dvc remote add myremote webdav://example.com/path/to/dir ``` -> See also `dvc remote modify` for a full list of WebDav parameters. +> Note that WebDAV is an extension of HTTP. See also `dvc remote modify` for a +> full list of HTTP parameters.
diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index a7135d5ddb..78673c0882 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -504,7 +504,9 @@ more information.
-### Click for HTTP +### Click for HTTP & WebDAV + +> Note that WebDAV is an extension of HTTP so the same parameters apply. - `auth` - authentication method to use when accessing a remote. The accepted values are: @@ -565,15 +567,6 @@ more information.
-
- -### Click for WebDav - -Since it's an extension for the HTTP protocol the same settings apply as for -HTTP. See above for the HTTP. - -
- ## Example: Customize an S3 remote Let's first set up a _default_ S3 remote. From 3cfbf9ba1bad0ba308ded53591aa00caf508e30e Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 25 May 2020 13:24:13 -0500 Subject: [PATCH 2/8] cmd ref: remove WebDAV remote info for #1355 --- content/docs/command-reference/remote/add.md | 13 ------------- content/docs/command-reference/remote/modify.md | 4 +--- 2 files changed, 1 insertion(+), 16 deletions(-) diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index db92fde51e..b0bc12d5e5 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -350,19 +350,6 @@ $ dvc remote add myremote https://example.com/path/to/dir
-### Click for WebDAV - -```dvc -$ dvc remote add myremote webdav://example.com/path/to/dir -``` - -> Note that WebDAV is an extension of HTTP. See also `dvc remote modify` for a -> full list of HTTP parameters. - -
- -
- ### Click for local remote A "local remote" is a directory in the machine's file system. diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 78673c0882..f245433818 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -504,9 +504,7 @@ more information.
-### Click for HTTP & WebDAV - -> Note that WebDAV is an extension of HTTP so the same parameters apply. +### Click for HTTP - `auth` - authentication method to use when accessing a remote. The accepted values are: From d4ec8a5663df9ce5b4ff91dbce1720c483525bc7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 25 May 2020 16:29:42 -0500 Subject: [PATCH 3/8] glossary: add back DVC project per https://github.com/iterative/dvc.org/pull/1334#pullrequestreview-417880802 --- .../user-guide/basic-concepts/dvc-project.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 content/docs/user-guide/basic-concepts/dvc-project.md diff --git a/content/docs/user-guide/basic-concepts/dvc-project.md b/content/docs/user-guide/basic-concepts/dvc-project.md new file mode 100644 index 0000000000..486e994379 --- /dev/null +++ b/content/docs/user-guide/basic-concepts/dvc-project.md @@ -0,0 +1,20 @@ +--- +name: 'DVC Project' +match: + [ + 'DVC project', + 'DVC projects', + project, + projects, + 'DVC repository', + 'DVC repositories', + repository, + repositories, + ] +--- + +Initialized by running `dvc init` in the **workspace** (typically in a Git +repository). It will contain the +[`.dvc/` directory](/doc/user-guide/dvc-files-and-directories) and +[DVC-files](/doc/user-guide/dvc-file-format) created with commands such as +`dvc add` or `dvc run`. From bd544801cbeaf1fbbf07e6510c7645c680f0a1bd Mon Sep 17 00:00:00 2001 From: rogermparent Date: Mon, 25 May 2020 18:33:58 -0400 Subject: [PATCH 4/8] Re-add abbrs within details This feature broke at some point in the past and all these were removed. The feature has since been fixed, so these are safe to re-add. --- content/docs/command-reference/import-url.md | 2 +- content/docs/command-reference/remote/add.md | 7 ++++--- content/docs/command-reference/remote/index.md | 6 +++--- content/docs/command-reference/remote/list.md | 6 +++--- content/docs/tutorials/get-started/configure.md | 6 +++--- content/docs/tutorials/pipelines.md | 12 ++++++------ content/docs/tutorials/versioning.md | 6 +++--- 7 files changed, 23 insertions(+), 22 deletions(-) diff --git a/content/docs/command-reference/import-url.md b/content/docs/command-reference/import-url.md index 0346f418da..6787def8c9 100644 --- a/content/docs/command-reference/import-url.md +++ b/content/docs/command-reference/import-url.md @@ -146,7 +146,7 @@ $ git checkout 2-remote $ mkdir data ``` -You should now have a blank workspace, just before the +You should now have a blank workspace, just before the [Add Files](/doc/tutorials/get-started/add-files) chapter.
diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index b0bc12d5e5..5e40bd22fc 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -355,9 +355,10 @@ $ dvc remote add myremote https://example.com/path/to/dir A "local remote" is a directory in the machine's file system. > While the term may seem contradictory, it doesn't have to be. The "local" part -> refers to the machine where the project is stored, so it can be any directory -> accessible to the same system. The "remote" part refers specifically to the -> project/repository itself. Read "local, but external" storage. +> refers to the machine where the project is stored, so it can be +> any directory accessible to the same system. The "remote" part refers +> specifically to the project/repository itself. Read "local, but external" +> storage. Using an absolute path (recommended): diff --git a/content/docs/command-reference/remote/index.md b/content/docs/command-reference/remote/index.md index aa56881e8f..09a006936b 100644 --- a/content/docs/command-reference/remote/index.md +++ b/content/docs/command-reference/remote/index.md @@ -76,9 +76,9 @@ For the typical process to share the project via remote, see ### What is a "local remote" ? While the term may seem contradictory, it doesn't have to be. The "local" part -refers to the machine where the project is stored, so it can be any directory -accessible to the same system. The "remote" part refers specifically to the -project/repository itself. Read "local, but external" storage. +refers to the machine where the project is stored, so it can be any +directory accessible to the same system. The "remote" part refers specifically +to the project/repository itself. Read "local, but external" storage.
diff --git a/content/docs/command-reference/remote/list.md b/content/docs/command-reference/remote/list.md index fcc37b126f..a18510f0aa 100644 --- a/content/docs/command-reference/remote/list.md +++ b/content/docs/command-reference/remote/list.md @@ -46,9 +46,9 @@ Let's for simplicity add a _default_ local remote: ### What is a "local remote" ? While the term may seem contradictory, it doesn't have to be. The "local" part -refers to the machine where the project is stored, so it can be any directory -accessible to the same system. The "remote" part refers specifically to the -project/repository itself. Read "local, but external" storage. +refers to the machine where the project is stored, so it can be any +directory accessible to the same system. The "remote" part refers specifically +to the project/repository itself. Read "local, but external" storage. diff --git a/content/docs/tutorials/get-started/configure.md b/content/docs/tutorials/get-started/configure.md index 753e8ea89d..cb3b429f50 100644 --- a/content/docs/tutorials/get-started/configure.md +++ b/content/docs/tutorials/get-started/configure.md @@ -16,9 +16,9 @@ For simplicity, let's setup a local remote: ### What is a "local remote" ? While the term may seem contradictory, it doesn't have to be. The "local" part -refers to the machine where the project is stored, so it can be any directory -accessible to the same system. The "remote" part refers specifically to the -project/repository itself. Read "local, but external" storage. +refers to the machine where the project is stored, so it can be any +directory accessible to the same system. The "remote" part refers specifically +to the project/repository itself. Read "local, but external" storage. diff --git a/content/docs/tutorials/pipelines.md b/content/docs/tutorials/pipelines.md index 1ba072eb11..415daa2dd2 100644 --- a/content/docs/tutorials/pipelines.md +++ b/content/docs/tutorials/pipelines.md @@ -126,9 +126,9 @@ This file can be committed with Git instead of the data file itself. The data file `Posts.xml.zip` is linked (or copied) from `.dvc/cache/ce/68b98d82545628782c66192c96f2d2`, and added to `.gitignore`. Even -if you remove it from the workspace, or `git checkout` a different commit, the -data is not lost if a corresponding DVC-file is committed. It's enough to run -`dvc checkout` or `dvc pull` to restore data files. +if you remove it from the workspace, or `git checkout` a different +commit, the data is not lost if a corresponding DVC-file is committed. It's +enough to run `dvc checkout` or `dvc pull` to restore data files. @@ -183,10 +183,10 @@ outs: ``` Just like the DVC-file we created earlier with `dvc add`, this stage file uses -`md5` hashes (that point to the cache) to describe and version control -dependencies and outputs. Output `data/Posts.xml` file is saved as +`md5` hashes (that point to the cache) to describe and version +control dependencies and outputs. Output `data/Posts.xml` file is saved as `.dvc/cache/a3/04afb96060aad90176268345e10355` and linked (or copied) to the -workspace, as well as added to `.gitignore`. +workspace, as well as added to `.gitignore`. Two things are worth noticing here. First, by analyzing dependencies and outputs that DVC-files describe, we can restore the full series of commands (pipeline diff --git a/content/docs/tutorials/versioning.md b/content/docs/tutorials/versioning.md index 20234ffddb..8efa24f7c8 100644 --- a/content/docs/tutorials/versioning.md +++ b/content/docs/tutorials/versioning.md @@ -163,9 +163,9 @@ $ git tag -a "v1.0" -m "model v1.0, 1000 images" ### Expand to learn more about DVC internals As we mentioned briefly, DVC does not commit the `data/` directory and -`model.h5` file with Git. Instead, `dvc add` stores them in the cache (usually -in `.dvc/cache`) and adds them to `.gitignore`. We then `git commit` DVC-files -that contain file hashes that point to cached data. +`model.h5` file with Git. Instead, `dvc add` stores them in the +cache (usually in `.dvc/cache`) and adds them to `.gitignore`. We +then `git commit` DVC-files that contain file hashes that point to cached data. In this case we created `data.dvc` and `model.h5.dvc`. Refer to [DVC-File Format](/doc/user-guide/dvc-file-format) to learn more about how these From 3a936f5b23f0de3cf06899c5a6e7e0b440e7975d Mon Sep 17 00:00:00 2001 From: rogermparent Date: Mon, 25 May 2020 20:17:57 -0400 Subject: [PATCH 5/8] Re-add cache directory in add-files --- content/docs/tutorials/get-started/add-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/tutorials/get-started/add-files.md b/content/docs/tutorials/get-started/add-files.md index 048aafa213..10c28f15be 100644 --- a/content/docs/tutorials/get-started/add-files.md +++ b/content/docs/tutorials/get-started/add-files.md @@ -40,7 +40,7 @@ Committing DVC-files with Git allows us to track different versions of the ### Expand to learn about DVC internals -`dvc add` moves the actual data file to the cache directory (see +`dvc add` moves the actual data file to the cache directory (see [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories)), while the entries in the workspace may be file links to the actual files in the DVC cache. From 0fd73159aed7a9120acfd3660a6a27015a5e3f9e Mon Sep 17 00:00:00 2001 From: rogermparent Date: Mon, 25 May 2020 22:44:27 -0400 Subject: [PATCH 6/8] Change "cache directory" to "cache" We don't have a tooltip match for "cache directory" --- content/docs/tutorials/get-started/add-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/tutorials/get-started/add-files.md b/content/docs/tutorials/get-started/add-files.md index 10c28f15be..438ef9495d 100644 --- a/content/docs/tutorials/get-started/add-files.md +++ b/content/docs/tutorials/get-started/add-files.md @@ -40,7 +40,7 @@ Committing DVC-files with Git allows us to track different versions of the ### Expand to learn about DVC internals -`dvc add` moves the actual data file to the cache directory (see +`dvc add` moves the actual data file to the cache directory (see [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories)), while the entries in the workspace may be file links to the actual files in the DVC cache. From 376cf4186e7dda7764d144021e229fe9e6d81e92 Mon Sep 17 00:00:00 2001 From: rogermparent Date: Tue, 26 May 2020 16:50:09 -0400 Subject: [PATCH 7/8] Re-add some missed abbrs --- content/docs/tutorials/pipelines.md | 4 ++-- content/docs/tutorials/versioning.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/tutorials/pipelines.md b/content/docs/tutorials/pipelines.md index 415daa2dd2..0e756eb39e 100644 --- a/content/docs/tutorials/pipelines.md +++ b/content/docs/tutorials/pipelines.md @@ -103,8 +103,8 @@ When we run `dvc add` `Posts.xml.zip`, DVC creates a ### Expand to learn about DVC internals At DVC initialization, a new `.dvc/` directory is created for internal -configuration and cache -[files and directories](/doc/user-guide/dvc-files-and-directories), that are +configuration, as well as some cache +[files and directories](/doc/user-guide/dvc-files-and-directories) that are hidden from the user. This directory is automatically staged with `git add`, so it can be easily committed with Git. diff --git a/content/docs/tutorials/versioning.md b/content/docs/tutorials/versioning.md index 8efa24f7c8..06eb3a8624 100644 --- a/content/docs/tutorials/versioning.md +++ b/content/docs/tutorials/versioning.md @@ -281,8 +281,8 @@ the `v2.0` tag. ### Expand to learn more about DVC internals As we have learned already, DVC keeps data files out of Git (by adjusting -`.gitignore`) and puts them into the cache (usually it's a `.dvc/cache` -directory inside the repository). Instead, DVC creates +`.gitignore`) and puts them into the cache (usually it's a +`.dvc/cache` directory inside the repository). Instead, DVC creates [DVC-files](/doc/user-guide/dvc-file-format). These text files serve as data placeholders that point to the cached files, and they can be easily version controlled with Git. From 39f9c8c54d8d3fb92ec02c78a3853246f48e4cf7 Mon Sep 17 00:00:00 2001 From: rogermparent Date: Tue, 26 May 2020 16:59:30 -0400 Subject: [PATCH 8/8] Revert grammar change I think I missed the correct context originally when editing it, and committed it because it looked like any other abbr addition. --- content/docs/tutorials/pipelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/tutorials/pipelines.md b/content/docs/tutorials/pipelines.md index 0e756eb39e..537351863e 100644 --- a/content/docs/tutorials/pipelines.md +++ b/content/docs/tutorials/pipelines.md @@ -103,7 +103,7 @@ When we run `dvc add` `Posts.xml.zip`, DVC creates a ### Expand to learn about DVC internals At DVC initialization, a new `.dvc/` directory is created for internal -configuration, as well as some cache +configuration and cache [files and directories](/doc/user-guide/dvc-files-and-directories) that are hidden from the user. This directory is automatically staged with `git add`, so it can be easily committed with Git.