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 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (19.008 Forks)batch import

DocumentationNeedsFixhelp wantedpkgsite

Repository-Metriken

Stars: (133.883 Stars)
PR-Merge-Metriken: (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung: Lesen Sie die vorhandene worker.md, erkunden Sie die Endpunkte von server.go, verstehen Sie den Modul Proxy und die Zip Verarbeitung, und aktualisieren Sie dann die Dokumentation mit klaren Beschreibungen und Links.
Tech Stack: go
Domain: documentation
Issue Type: Dokumentation
Schwierigkeit: 2
Geschätzte Zeit: 1-2 Tage
Aktivitätsstatus: Frisch
Klarheit: Klar
Voraussetzungen: GoDocumentation writing
Einsteigerfreundlichkeit: 65

Repository-Metriken

Beschreibung

Contributor Guide

Erhalte frische Easy Issues per E-Mail.