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: (30d に merged PR はありません)

説明

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

コントリビューターガイド

調査方針: 既存のworker.mdを読み、server.goのエンドポイントを調査し、モジュールプロキシとzip処理を理解した上で、明確な説明とリンクを含むドキュメントを更新してください。
技術スタック: go
領域: documentation
Issue 種別: ドキュメント
難度: 2
推定時間: 1-2日
活動状況: 新着
明確さ: 明確
前提条件: GoDocumentation writing
初心者向け度: 65

Repository metrics

説明

コントリビューターガイド

新着 Easy issues をメールで受け取る。