grpc / grpc/grpc.io

Add link to grpc src repo docs from language landing page

Open
#506 0 comments 0 reactions 1 assignee Claimed by @chalin View on GitHub
e0-minutes e1-hours enhancement
Dominant language
HTML
Stars
479
Forks
545
Avg merge
2d 7h
Merged PRs (30d)
5

Description

Tech writers and some site readers have expressed the preference that **_all_ gRPC docs be under grpc.io** (#98), as opposed to there being some "low-level technical" pages under a documentation folder of grpc package source repos (e.g., https://github.com/grpc/grpc/tree/master/doc).

It seems doubtful that all such grpc source repo pages will be migrated to grpc.io. A compromise is to offer a link to the source repo docs folder from the corresponding language homepage. For an example, see the [Java homepage](https://grpc.io/docs/languages/java/), which already has this link:

>

Related: #345

---

- [x] Android
- Java - N/A
- Kotlin - N/A
- [x] C# (core-library implementation) - #510
- [x] C++ - #507
- Dart - N/A
- [x] Go - #494
- [x] Java - #494
- Kotlin - N/A
- [ ] Node
- [ ] Objective-C
- PHP - N/A
- [x] Python - #508
- [ ] Ruby

---

Alternative names for the links were discussed during the 2020-07-20 Docs WG meeting. Here are some of the alternative names:

- Low-level technical docs
- **Additional docs** on GitHub ← preferred name (with or w/o "on GitHub)
- Extra docs (GitHub)
- Feature docs
- GitHub docs

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.