Update tutorials to use the build plugin #2178
Merged
+124
−54
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: The examples have been updated to use the build plugin; so too should the tutorials. Modifications: Update tutorials to use the build plugin. Result: Better tutorials.
gjcairo
reviewed
Jan 24, 2025
| @Steps { | ||
| @Step { | ||
| In a terminal run `swift run hello-world serve` to start the server. By default it'll start | ||
| listening on port 31415. | ||
| In a terminal run `PROTOC_PATH=$(which protoc) swift run hello-world serve` to start the |
There was a problem hiding this comment.
Should we explain why PROTOC_PATH is needed and/or link to the plugin docs that explain it in more detail?
There was a problem hiding this comment.
Yeah that's a great point, I'll do that.
|
|
||
| @Code(name: "Protos/route_guide.proto", file: "route-guide-sec02-step01-import.proto") | ||
| It's good practice to organise your `.proto` files according to the package they are |
There was a problem hiding this comment.
Nit: should we stick to American spelling (organise vs organize)?
There was a problem hiding this comment.
We should. (Sadly.)
glbrntt
commented
Jan 24, 2025
| You may notices that the `swift` commands are all prefixed with `PROTOC_PATH=$(which protoc)`, | ||
| this is to let the build system know where `protoc` is located so that it can generate stubs | ||
| for you. You can read more about it in the [gRPC Swift Protobuf | ||
| documentation](https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs). |
There was a problem hiding this comment.
Note that this is a pre-emptive change: I think we should move the generating stubs doc to the protobuf package and then link to it from the core package docs.
glbrntt
commented
Jan 24, 2025
Sources/GRPCCore/Documentation.docc/Tutorials/Hello-World/Hello-World.tutorial
Outdated
Show resolved
Hide resolved
glbrntt
commented
Jan 24, 2025
Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial
Outdated
Show resolved
Hide resolved
gjcairo
approved these changes
Jan 24, 2025
Sources/GRPCCore/Documentation.docc/Tutorials/Hello-World/Hello-World.tutorial
Outdated
Show resolved
Hide resolved
Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
The examples have been updated to use the build plugin; so too should the tutorials.
Modifications:
Update tutorials to use the build plugin.
Result:
Better tutorials.