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 commentaires) (0 réactions) (0 assignés)Go (19 008 forks)batch import

DocumentationNeedsFixhelp wantedpkgsite

Métriques du dépôt

Stars: (133 883 stars)
Métriques de merge PR: (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche: Lisez le worker.md existant, explorez les points de terminaison de server.go, comprenez le proxy de module et le traitement zip, puis mettez à jour la documentation avec des descriptions et des liens clairs.
Stack technique: go
Domaine: documentation
Type d'issue: Documentation
Difficulté: 2
Temps estimé: 1-2 jours
Statut d'activité: Récente
Clarté: Claire
Prérequis: GoDocumentation writing
Accessibilité débutant: 65

Métriques du dépôt

Description

Guide contributeur

Recevez de nouvelles issues Easy par e-mail.