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

clarifying the readme #1244

Merged
merged 8 commits into from
Aug 7, 2019
Merged

clarifying the readme #1244

merged 8 commits into from
Aug 7, 2019

Conversation

arschles
Copy link
Member

we don't have a public stable proxy and don't have concrete plans to release one, so let's not say we do for now.

we don't have a public stable proxy and don't have concrete plans to release one, so let's not say we do for now.
@arschles arschles requested a review from a team as a code owner May 27, 2019 10:46
@scottilee
Copy link
Contributor

It would be nice if you could link to the experimental public proxy.

As a side note, have you considered making a list of companies using Athens in production to display somewhere?

README.md Outdated
@@ -29,7 +29,7 @@ We encourage you to [try it out](https://docs.gomods.io/install/), let us know w

The proxy implements the [Go modules download protocol](https://docs.gomods.io/intro/protocol/).

There is currently an experimental public proxy, and we have plans to host a more stable public proxy with more guarantees. We also have a community of folks using Athens inside their organizations as an internal proxy. In either deployment, developers set their `GOPROXY` environment variable to point to the Athens proxy of their choice. At that point, `go get`, `go build`, and `go build`s will use the proxy to download dependencies as necessary.
There is currently an experimental public proxy that you can use to try out Athens, without installing anything locally. We also have a community of folks using Athens in production inside their organizations as an internal proxy. In either deployment, developers set their `GOPROXY` environment variable to point to the Athens proxy of their choice. At that point, `go get`, `go build`, `go build`, and more commands will use the proxy to download dependencies as necessary.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mark the word experimental somehow (bold?) to make it clear.
Also go build repeats twice.

@arschles
Copy link
Member Author

arschles commented Aug 5, 2019

@marpio I made the changes you suggested - thanks for that.

@scottilee - I also added a link to the experimental proxy. If I get some time I'll put a domain in front of it. I have it on my list to ask folks to let us know if they're using Athens at their company, but haven't gotten to it yet. Would you be interested in helping?

@scottilee
Copy link
Contributor

@arschles Yeah, would be happy to. I've been busy but starting next week I should have more time. It looks like @marwan-at-work already started something at #1323. Let me know what else I need to do.

@arschles
Copy link
Member Author

arschles commented Aug 6, 2019

@scottilee all good! I tweeted about #1323 from the Athens account. A retweet and any other way you can spread the word would be much appreciated! I really appreciate your help 😄

@marpio marpio merged commit a336c55 into gomods:master Aug 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants