Refresh Quickstart content for website.
hsaliak opened this issue · comments
- Volunteers for every language.
- Review content, provide PRs if necessary.
We now have a Python quickstart in this PR that should be used as a model for the other languages: #223
Preview here: https://github.com/LisaFC/grpc.github.io/blob/quickstarts/docs/quickstarts/python-quickstart.md
- @murgatroid99 can you do node and ruby?
- @nicolasnoble C++?
- @ejona86 java
Lets follow the python template and get this done
- @apolcyn for C#
Does the quickstart replace the tutorial? Or is it in addition?
It's in addition - the idea is that it's for someone who wants to dive straight in and DO SOMETHING, without much explanation, just letting them complete a proper task. Then they look at the tutorial for a walk through with all the context information and links.
I have shamelessly stolen this idea from cloud.google.com's doc template and UX research...
Node is unusual here because it has two different kinds of code generation. Dynamic code generation is simpler/easier to use, but static code generation has a workflow and interface more consistent with how this will work in other languages. Which should my Node quickstart guide cover?
Do we want users to eventually move to the static flow, if so we should
just cover that here so that we do not have to come back and update the
guide later.
If we want to leave the static code generation flow as an advanced feature
and let most users just do dynamic code generation, then i think the latter
is sufficient.
On Fri, Jul 22, 2016 at 11:38 AM Michael Lumish notifications@github.com
wrote:
Node is unusual here because it has two different kinds of code
generation. Dynamic code generation is simpler/easier to use, but static
code generation has a workflow and interface more consistent with how this
will work in other languages. Which should my Node quickstart guide cover?—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#237 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAJKXAxs81bqVjL5sQ7M_Qa7QkBSp0POks5qYQ4-gaJpZM4JIKyW
.
I think that if we want the reader to get something up and running quickly and relatively easily, dynamic codegen works better for that. I'm not exactly sure if we want all users to switch to static codegen, but I don't think we intend to remove the dynamic codegen anytime soon. Plus, switching won't be a ton of work, so, I'll go with dynamic codegen for now.
Also, should these quickstart guides go into the GA branch or the master branch?
They should go into the GA branch.
On Fri, Jul 22, 2016, 2:28 PM Michael Lumish notifications@github.com
wrote:
Also, should these quickstart guides go into the GA branch or the master
branch?—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#237 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAJKXCtBmU4oenpQhZXi8XwhJtoJPbZSks5qYTXmgaJpZM4JIKyW
.
C# draft here #253. Greeter and route_guide examples seemed to need to be updated too, with grpc/grpc#7514.
@dgquintas for C++ quickstart
Reiterating that quickstarts should include "updating a grpc service" by way of adding a method to hello world proto and using it.
For C# quickstart.
Because of the pending change that breaks IDE usage on mac and linux, in PR grpc/grpc#7519, I will have to update the quickstart, and possibly the examples, with workarounds for using them on mac and linux.
Update: The only remaining merge is for C#, all other content should be in.
Fixed, all quickstarts are in. Closing.