Explain vendor vs proxy #1403
Explain vendor vs proxy #1403
Conversation
…when to use athens or another proxy server
…explain-vendor-vs-proxy
…n-vendor-vs-proxy
… into explain-vendor-vs-proxy
There was a problem hiding this comment.
@schafer14 so awesome. Thanks for this, it's looking great 💚 . I made a few comments
docs/content/faq.md
Outdated
|
|
||
| The Go community has used vendor directories for a long time before module proxies like Athens came along, so naturally each group collaborating on code should decide for themselves whether they want to use a vendor directory, use Athens, or do both! | ||
|
|
||
| Vendor (without a proxy) are valuable when: |
There was a problem hiding this comment.
Can you write this as Using a vendor directory (without a proxy) is valuable when:?
docs/content/faq.md
Outdated
| - When the vendor directory is so small that it is still faster to check it out from a repo than it is to pull zip files from the server | ||
| - If you're coming from glide/dep or another dependency management system that leveraged the vendor directory | ||
|
|
||
| Athens valuable when: |
There was a problem hiding this comment.
Can you write this as Athens (without a vendor directory) is valuable when:? I want the docs to be clear that we're talking about just a proxy, and deleting the entire vendor directory
docs/content/faq.md
Outdated
| - For developers slow checkouts will not be as much of a problem as for ci tools which frequently need to checkout fresh copies of the project | ||
| - You do not want to pollute your project with the vendor directory | ||
| - Extra noise in pull requests | ||
| - Extra difficulty doing fuzzy file searching in your project |
There was a problem hiding this comment.
Can you elaborate on this and the previous bullet point? It sounds like Athens will be valuable in reducing these two things. Is that right?
There was a problem hiding this comment.
This is awkward phrasing. Is this easier to follow?
- You want to remove the vendor directory from your project to:
- Reduce noise in pull requests
- Reduce difficulty doing fuzzy file searching in your project
There was a problem hiding this comment.
Most definitely, that's easier to follow!
There was a problem hiding this comment.
@schafer14 this looks great. Thanks for your patience & making the changes. 🚀 
🎉
I am going to hold off on merging this until one more person looks at it. @chriscoffee @marwan-at-work @robjloranger would any of you like to take a look?
What is the problem I am trying to address?
There have been a few questions in the recent past about when/why to use a
vendor directory instead of (or along with) Athens or another proxy.
How is the fix applied?
I added a section to the FAQ that explains some pros and cons for when to use
vendor and when to use a proxy server like Athens.
Mention the issue number it fixes or add the details of the changes if it doesn't have a specific issue.
Fixes #1338
This is following up on PR #1340