x/pkgsite: improve documentation on worker architecture and how documentation is rendered · golang/go#40937

2020-08-20T21:29:12.000Z

Add the following: - [ ] Describe and link to worker endpoints in [server.go](https://go.googlesource.com/pkgsite/+/refs/heads/master/internal/worker/server.go#93) to doc/worker.md - [ ] Describe how packages are added, and link to module proxy documentation: - https://golang.org/cmd/go/#hdr-Module_proxy_protocol - https://proxy.golang.org - [ ] Describe how source links are generated and link to https://github.com/golang/gddo/wiki/Source-Code-Links - [ ] Describe what happens during zip processing - [ ] Add a script to seed local database for initial setup /cc @jba @jamalc @AceroM @shaqque

(0 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import

DocumentationNeedsFixhelp wantedpkgsite

Repository metrics

Stars: (133,883 stars)
PR merge metrics: (No merged PRs in 30d)

Description

Add the following:

Describe and link to worker endpoints in server.go to doc/worker.md
Describe how packages are added, and link to module proxy documentation:
- https://golang.org/cmd/go/#hdr-Module_proxy_protocol
- https://proxy.golang.org
Describe how source links are generated and link to https://github.com/golang/gddo/wiki/Source-Code-Links
Describe what happens during zip processing
Add a script to seed local database for initial setup

/cc @jba @jamalc @AceroM @shaqque

Contributor guide

Research direction: Read existing worker.md, explore server.go endpoints, understand module proxy and zip processing, then update the documentation with clear descriptions and links.
Tech stack: go
Domain: documentation
Issue type: Documentation
Difficulty: 2
Estimated time: 1-2 days
Activity status: Fresh
Clarity: Clear
Prerequisites: GoDocumentation writing
Newbie friendliness: 65

Repository metrics

Description

Contributor guide

Get fresh easy issues in your inbox.