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 commenti) (0 reazioni) (0 assegnatari)Go (19.008 fork)batch import

DocumentationNeedsFixhelp wantedpkgsite

Metriche repository

Star: (133.883 star)
Metriche merge PR: (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca: Leggi il worker.md esistente, esplora gli endpoint di server.go, comprendi il proxy del modulo e l'elaborazione zip, quindi aggiorna la documentazione con descrizioni e collegamenti chiari.
Tech stack: go
Dominio: documentation
Tipo issue: Documentazione
Difficoltà: 2
Tempo stimato: 1-2 giorni
Stato attività: Nuova
Chiarezza: Chiara
Prerequisiti: GoDocumentation writing
Adatta ai principianti: 65

Metriche repository

Descrizione

Guida contributor

Ricevi issue Easy fresche nella tua inbox.