Skip to content

Docs: fix links to grpc.io quick start, tutorial and other pages#23220

Merged
jtattermusch merged 4 commits intogrpc:masterfrom
chalin:chalin-docs-fix-grpc-io-links-200616
Jun 22, 2020
Merged

Docs: fix links to grpc.io quick start, tutorial and other pages#23220
jtattermusch merged 4 commits intogrpc:masterfrom
chalin:chalin-docs-fix-grpc-io-links-200616

Conversation

@chalin
Copy link
Copy Markdown
Contributor

@chalin chalin commented Jun 16, 2020

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Jun 16, 2020

cc @ejona86

README files.

[gRPC Basics]: https://grpc.io/docs/tutorials/basic/cpp
[gRPC Basics]: https://grpc.io/docs/languages/cpp/basics
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

quickstart sounds good, but I still feel that "basics" is not best name for the "routeguide" example.

My confusion because quickstart and basics are synonyms.

  • Out of "quickstart" and "basics" which one is more basic?
  • should I start witht basics or with quickstart? to me they both mean the same.

Can we figure out a better name for "basics" before submitting this change, so that we don't have to change things several time?

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Jun 17, 2020

@jtattermusch, thanks for your feedback.

The page titles "Quick Start" and "Basics Tutorial" originate from at least the inception of the site. While I agree that, for example, the "Basics Tutorial" might not be the best name, IMHO, possible page renames would best be discussed at our next Docs WG meeting (I've added it to the meeting agenda), and are beyond the scope of this PR, whose purpose is to fix links to existing pages.

My confusion because quickstart and basics are synonyms.

I don't see them as synonyms:

Do you agree with the suggested strategy: approving and merging this PR and followup with a discussing at our next meeting?

@jtattermusch jtattermusch added release notes: no Indicates if PR should not be in release notes lang/all wrapped languages labels Jun 22, 2020
Copy link
Copy Markdown
Contributor

@jtattermusch jtattermusch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@jtattermusch jtattermusch merged commit 89be9c2 into grpc:master Jun 22, 2020
@chalin chalin deleted the chalin-docs-fix-grpc-io-links-200616 branch June 22, 2020 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lang/all wrapped languages release notes: no Indicates if PR should not be in release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants