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 评论) (0 反应) (0 负责人)Go (19,008 fork)batch import

DocumentationNeedsFixhelp wantedpkgsite

仓库指标

Star: (133,883 star)
PR 合并指标: (30 天内没有已合并 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
议题类型: 文档
难度: 2
预计时间: 1-2 天
活动状态: 新近可参与
清晰度: 清晰
前置要求: GoDocumentation writing
新手友好度: 65

仓库指标

描述

贡献者指南

每天在邮箱收到新鲜 Easy issues。