Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref: better prioritize and highlight common remote options #1699

Closed
Tracked by #1859
jorgeorpinel opened this issue Aug 15, 2020 · 2 comments
Closed
Tracked by #1859

ref: better prioritize and highlight common remote options #1699

jorgeorpinel opened this issue Aug 15, 2020 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference duplicate This issue or pull request already exists. help wanted Contributors especially welcome type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 15, 2020

Extracted from https://peckofpickledpojos.wordpress.com/2020/08/09/learning-dvc-by-trial-and-error
(also related to https://discuss.dvc.org/t/dvc-push-to-public-s3-bucket/457):

ran into the issue of setting up a remote add to my S3 bucket... seemed like a simple credentials issue... It’s a little difficult to find but if you click around to check the remote add command...

DVC-based solution:

$ dvc remote modify myremote credentialpath ~/.aws/credentials

Probably many other remote config options that are only listed in collapsed sections of https://dvc.org/doc/command-reference/remote/modify (already buried inside the > remote cmd ref. nav element). Maybe we should use them more in and link to them more from other examples related to remotes (of which we may need more too), and/or write guides similar to https://dvc.org/doc/user-guide/setup-google-drive-remote for the most common remotes.


This issue can probably be addressed by several PRs, one per remote type (at least the most commonly used ones: S3, GCS, Azure, SSH)

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions help wanted Contributors especially welcome A: docs Area: user documentation (gatsby-theme-iterative) labels Aug 15, 2020
@jorgeorpinel
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel changed the title remote: better prioritize and highlight common config options ref: better prioritize and highlight common remote options Sep 26, 2021
@iesahin iesahin added the C: ref Content of /doc/*-reference label Oct 21, 2021
casperdcl added a commit that referenced this issue Feb 18, 2022
- related #2939
- related #1859
- related #2866
- related #1699
@jorgeorpinel jorgeorpinel added the duplicate This issue or pull request already exists. label Jul 28, 2022
@jorgeorpinel
Copy link
Contributor Author

#2866 should cover this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference duplicate This issue or pull request already exists. help wanted Contributors especially welcome type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

2 participants