grpc / grpc/grpc.io

Eliminate duplicate docs across site and repos

Open
#180 0 comments 0 reactions 1 assignee Claimed by @chalin View on GitHub
cleanup/refactoring e2-days p1-high
Dominant language
HTML
Stars
479
Forks
545
Avg merge
2d 7h
Merged PRs (30d)
5

Description

(AI from gRPC Docs Working Group 03/30)

This issue concerns keeping out docs [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) across grpc.io content and repo content, be it https://github.com/grpc/grpc or any of the language specific sites like https://github.com/grpc/grpc-java.

For example, https://github.com/grpc/grpc/blob/master/examples/cpp/cpptutorial.md is an outdated version of https://grpc.io/docs/tutorials/basic/cpp.

Also in scope of this issue is the cleanup of code repo README files so that they, for example, include better references into the appropriate language pages on grpc.io.

- [x] C++ Hello World: refer reader to Quick Start grpc/grpc#22636
- [x] C++ examples README cleanup grpc/grpc#22635
- [x] Removing obsolete C++ tutorial content grpc/grpc#22633
- [x] Go `examples/README` cleanup https://github.com/grpc/grpc-go/pull/3738
- [ ] Migrate docs from grpc-web repo to here #271

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.