docs: consistent remote location URLs + related copy edits#1695
Conversation
jorgeorpinel
had a problem deploying
to
dvc-landing-jorge-c8sgvd3e6cu3
|
This comment has been minimized.
This comment has been minimized.
|
|
||
| ```dvc | ||
| $ dvc remote add myremote s3://bucket/path | ||
| $ dvc remote add myremote s3://bucket/key |
There was a problem hiding this comment.
why do we change this? it's confusing for most people.
There was a problem hiding this comment.
Ok, rolled these back.
- Maybe it should be
path/to/dataorpath/to/objectdepending on the type?
There was a problem hiding this comment.
p.s. There were instances of bucket/mykey before too, so given this comment, I changed those to path as well (88d5f27).
jorgeorpinel
changed the title
jorgeorpinel
changed the title
jorgeorpinel
changed the title
| $ dvc remote add -d myremote s3://my-bucket/path/to/dir | ||
| $ dvc remote add -d myremote s3://mybucket/path/to/dir |
There was a problem hiding this comment.
Cosmetic: I removed - in URLs in this file and in remote modify, mainly.
|
|
||
| ```dvc | ||
| $ dvc remote add newremote s3://mybucket/myproject | ||
| $ dvc remote add newremote s3://mybucket/path |
There was a problem hiding this comment.
Changed possibly confusing concepts like "project" or "key" to a more generic "path" in URLs (mostly S3 URLs had this problem).
There was a problem hiding this comment.
since we change this - we might want to use -d ?
There was a problem hiding this comment.
Probably not in this one under the Customize an additional S3 remote example (meant as a continuation of the previous example where a default local remote is added).
|
I renamed the PR and focused the changes (down to 10 files from 16) @shcheklein. I also left a bunch of comments on what the changes are about startgin in #1695 (review). PTAL |
| | `ssh` | SSH server | `ssh://user@example.com/path/to/data` | | ||
| | `hdfs` | HDFS to file\* | `hdfs://user@example.com/path/to/data.csv` | | ||
| | `http` | HTTP to file\* | `https://example.com/path/to/data.csv` | | ||
| | `webdav` | WebDav to file\* | `webdavs://example.com/public.php/webdav/path/to/data.csv` | |
There was a problem hiding this comment.
is public.php is a very common thingy for webdav?
There was a problem hiding this comment.
I'm not familiar TBH but apparently yes there's some sort of endpoint. Not sure if it's typically PHP. I took this from https://dvc.org/doc/command-reference/remote/add#supported-storage-types
But let me check, maybe it's quick to figure this out. ⌛
There was a problem hiding this comment.
From https://linuxconfig.org/webdav-server-setup-on-ubuntu-linux and https://docs.microsoft.com/en-us/iis/install/installing-publishing-technologies/installing-and-configuring-webdav-on-iis WebDAV is setup similar to any HTTP server so no special need for PHP here... We should probably review all these in a separate PR though, so merging this for now (will create a ticket).
There was a problem hiding this comment.
public.php is a public endpoint for Nextcloud and Owncloud. There's remote.php as a private endpoint. It can be removed from most of the places, but good to keep one as an example, as most of our WebDAV users are either using Owncloud or Nextcloud.
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
Looks good to me! just a few minor questions
4 participants
Uh oh!
There was an error while loading. Please reload this page.