gomods / athens

A Go module datastore and proxy
https://docs.gomods.io
MIT License
4.38k stars 492 forks source link

Integrate Athens With pkg.go.dev (pkgsite) #1680

Open marwan-at-work opened 3 years ago

marwan-at-work commented 3 years ago

The code for pkg.go.dev is open source and it uses the GOPROXY as its main source for modules to show documentation for.

Therefore, a company, team, or individual should be able to run an internal documentation server that runs along side their internal Athens server.and uses it as its main source.

This issue tracks required features, docs, and UX to make the integration between Athens and pkgsite as easy as possible.

danieloleynyk commented 3 years ago

I'd like to give it a shot :)

arschles commented 3 years ago

I'd like to keep the do one thing and do it well pattern we've had until now, so can we leave pkgsite out of Athens itself? If we have to, I'm all for forking it into the gomods/ GitHub org

Xjs commented 3 years ago

@danieloleynyk I'm interested in this as well, before I start: have you made any progress with this? Do you happen to have a running athens+pkgsite setup or might I be wasting my time because it is hopeless? :)

danieloleynyk commented 3 years ago

@danieloleynyk I'm interested in this as well, before I start: have you made any progress with this? Do you happen to have a running athens+pkgsite setup or might I be wasting my time because it is hopeless? :)

Sadly I had to leave it since I had no free time for it :( I need this feature in my organization's air-gapped network, so all the things that I did had to be tested on an air-gapped network, quickly it became an issue since the /list and /latest api's of athens are not working in air-gapped networks(#1416)

issue #1416 is in progress, there is a listoffline branch that should resolve it, however, till its release the only way to make pkgsite and athens work together is possible only on connected networks...