mirror of
https://github.com/gomods/athens
synced 2026-02-03 11:00:32 +00:00
removing the "alpha" tag from the readme (#977)
* removing the "alpha" tag from the readme b/c we're now beta. also shortening a few other pieces of the readme * write out CDN * listing out some of the storage options
This commit is contained in:
committed by
Manu Gupta
parent
0b2aece18d
commit
c4e7c9b521
@@ -15,26 +15,30 @@ Welcome to the Athens project! We are a proxy server for the [Go Modules downloa
|
||||
|
||||
|<img src="docs/static/meeting-icon.svg" alt="Developer Meetings" width="20" height="20" />Developer Meetings|
|
||||
|------------------|
|
||||
|We hold weekly developer meetings on a Thursday, to join them, watch previous meeting recordings or find more information, please see [the docs](https://docs.gomods.io/contributing/community/developer-meetings/). Absolutely everyone is invited to attend these, suggest topics, and participate!|
|
||||
|We hold weekly developer meetings every Thursday. To join them, watch previous meeting recordings or find more information, please see [the docs](https://docs.gomods.io/contributing/community/developer-meetings/). Absolutely everyone is invited to attend these, suggest topics, and participate!|
|
||||
</br>
|
||||
|
||||
See our documentation site [https://docs.gomods.io](https://docs.gomods.io) for more details on the project.
|
||||
|
||||
# Project Status
|
||||
|
||||
Project Athens is in alpha. Things might change, so we recommend that you don't run it for production workloads. We have organizations that are testing it internally, and there is an experimental public proxy server running.
|
||||
Project Athens is in beta. It's being tested and used used on teams and has an experimental deployment for public use.
|
||||
|
||||
We encourage you to [test it out](https://docs.gomods.io/install/) and [contribute](#contributing) when you can!
|
||||
We encourage you to [try it out](https://docs.gomods.io/install/), let us know what you think, and [contribute](#contributing) when you can!
|
||||
|
||||
# More Details Please!
|
||||
|
||||
Although the project is alpha, here's where we're going:
|
||||
|
||||
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 who are testing Athens inside their organizations, as an "internal proxy." In either deployment, users 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, 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.
|
||||
|
||||
Athens proxies are highly configurable, so they can work for lots of different deployments. For example, public proxies can store code in cloud databases and CDNs, while internal "enterprise" deployments can use disk-based (i.e. NFS) storage.
|
||||
Athens proxies are highly configurable, so they can work for lots of different deployments. For example, proxies support a wide variety of storage drivers including:
|
||||
|
||||
- Cloud blob storage services
|
||||
- MongoDB
|
||||
- Content distribution networks (CDNs)
|
||||
- Shared disk
|
||||
- In-memory
|
||||
|
||||
# Development
|
||||
|
||||
@@ -44,14 +48,14 @@ Speaking of contributing, read on!
|
||||
|
||||
# Contributing
|
||||
|
||||
This project is early and there's plenty of interesting and challenging work to do.
|
||||
This project has plenty of interesting and challenging work to do and a wonderful community.
|
||||
|
||||
If you find a bug or want to fix a bug, we :heart: PRs and issues! If you see an issue
|
||||
in the [queue](https://github.com/gomods/athens/issues) that you'd like to work on, please just post a comment saying that you want to work on it. Something like "I want to work on this" is fine.
|
||||
|
||||
If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. If you haven't used Github before, the awesome [@bketelsen](https://github.com/bketelsen) has created a good overview on how to contribute code - see [here](https://www.youtube.com/watch?v=bgSDcTyysRc).
|
||||
|
||||
Before you do start contributing or otherwise getting involved, we want to let you know that we follow a general [philosophy](./PHILOSOPHY.md) in how we work together, and we'd really appreciate you getting familiar with it before you start.
|
||||
Before you do start getting involved or contributing, we want to let you know that we follow a general [philosophy](./PHILOSOPHY.md) in how we work together, and we'd really appreciate you getting familiar with it before you start.
|
||||
|
||||
It's not too long and it's ok for you to "skim" it (or even just read the first two sections :smile:), just as long as you understand the spirit of who we are and how we work.
|
||||
|
||||
@@ -85,8 +89,7 @@ We all strive to write nice and readable code which can be understood by every p
|
||||
This project follows the [Contributor Covenant](https://www.contributor-covenant.org/) (English version [here](./CODE_OF_CONDUCT.md)) code of conduct.
|
||||
|
||||
If you have concerns, notice a code of conduct violation, or otherwise would like to talk about something
|
||||
related to this code of conduct, please reach out to me, Aaron Schlesinger on the [Gophers Slack](https://gophers.slack.com/). My username is `arschles`. Note that in the future, we will be expanding the
|
||||
ways that you can contact us regarding the code of conduct.
|
||||
related to this code of conduct, please reach out `@arschles` on the [Gophers Slack](https://gophers.slack.com/).
|
||||
|
||||
---
|
||||
Athens banner attributed to Golda Manuel
|
||||
|
||||
Reference in New Issue
Block a user