Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples: fix the quickstart link in the routeguide example #7162

Merged
merged 2 commits into from
Apr 25, 2024

Conversation

arjan-bal
Copy link
Contributor

@arjan-bal arjan-bal commented Apr 23, 2024

Point to the Go quickstart link which has the instructions for installing protoc and the required plugins.

RELEASE NOTES: none

Copy link

linux-foundation-easycla bot commented Apr 23, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@arjan-bal arjan-bal changed the title Fix the quickstart link in routeguide example Fix the quickstart link in the routeguide example Apr 23, 2024
@arjan-bal arjan-bal changed the title Fix the quickstart link in the routeguide example cleanup: fix the quickstart link in the routeguide example Apr 23, 2024
@ginayeh ginayeh requested a review from aranjans April 23, 2024 16:38
@arjan-bal arjan-bal added this to the 1.64 Release milestone Apr 24, 2024
@arjan-bal arjan-bal added the Type: Documentation Documentation or examples label Apr 24, 2024
@aranjans
Copy link
Contributor

@arjan-bal Just to double check, quickstart guide is updated and enough to generate the dependencies right?

@aranjans aranjans assigned arjan-bal and unassigned aranjans Apr 24, 2024
@arjan-bal
Copy link
Contributor Author

@arjan-bal Just to double check, quickstart guide is updated and enough to generate the dependencies right?

Yes, the prerequisites section of the guide has the instructions to install the required tools, mainly the go and grpc-go plugins for protoc.

@arjan-bal arjan-bal assigned aranjans and unassigned arjan-bal Apr 24, 2024
@@ -28,7 +28,7 @@ Then change your current directory to `grpc-go/examples/route_guide`:
$ cd $GOPATH/src/google.golang.org/grpc/examples/route_guide
```

You also should have the relevant tools installed to generate the server and client interface code - if you don't already, follow the setup instructions in [the Go quick start guide](https://github.com/grpc/grpc-go/tree/master/examples/).
You also should have the relevant tools installed to generate the server and client interface code - if you don't already, follow the setup instructions in [the Go quick start guide](https://grpc.io/docs/languages/go/quickstart).
Copy link
Contributor

Choose a reason for hiding this comment

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

Just following the other PR's review, shall we change this to something like

"Ensure you have the relevant tools installed to generate the server and client interface code. If you don't, follow the setup instructions in the Go quick start guide (https://grpc.io/docs/languages/go/quickstart)."

What do you think @arjan-bal?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it sounds better. Changed accordingly.

@arjan-bal arjan-bal requested a review from aranjans April 25, 2024 16:26
@aranjans
Copy link
Contributor

aranjans commented Apr 25, 2024

Thanks @arjan-bal. LGTM!. Pitching in @dfawley to have one more approval.

Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@dfawley dfawley changed the title cleanup: fix the quickstart link in the routeguide example examples: fix the quickstart link in the routeguide example Apr 25, 2024
@dfawley dfawley merged commit dd953fd into grpc:master Apr 25, 2024
12 checks passed
@arjan-bal arjan-bal deleted the fix-quickstart-link branch September 4, 2024 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation or examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants