docs: Revamp quickstart for wash dev #648
Conversation
Signed-off-by: Eric Gregory <eric@cosmonic.com>
✅ Deploy Preview for dreamy-golick-5f201e ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Eric Gregory <eric@cosmonic.com>
There was a problem hiding this comment.
I have one or two nits, and then one big idea for the second page that I think we can really nail. All of this is a wholesale improvement over today, and I think it could even go in as-is.
I want to make sure we don't hold the great improvements here in favor of getting everything perfect, we can refine slowly 😄
docs/tour/adding-capabilities.mdx
Outdated
| Let's extend this application to do more than just say "Hello!" | ||
|
|
||
| Using the `path_with_query` method on the incoming request, we can check the request for a name provided in a query string, and then return a greeting with that name. If there isn't one or the path isn't in the format we expect, we'll default to saying "Hello, World!" |
There was a problem hiding this comment.
Honestly, I would just skip this part entirely in the quickstart. We made the change to the code in the first bit, now we can get onto capabilities.
I do like your suggestion for generating bindings for Python, though, that still is nice to have
There was a problem hiding this comment.
This can be done here or as a followup, good either way
|
|
||
| To further enhance our application, let's add persistent storage to keep a record of each person that this application greeted. We'll use the key-value store provider for this, and just like HTTP server, you won't need to pick a library or a specific vendor implementation yet. You'll just need to add the appropriate interface to your component, and then you can pick a provider at runtime. | ||
| Now let's add persistent storage to keep a record of each person that this application greeted. |
There was a problem hiding this comment.
For this one, if you take my suggestion to not do the path/query parsing, I think we can just take the path with query as is (e.g. like the keyvalue counter)
So curl localhost:8000/howdy would say something like "Request count /howdy: 3"
Just looking for ways to simplify!
There was a problem hiding this comment.
This can be done here or as a followup, good either way
Co-authored-by: Brooks Townsend <brooksmtownsend@gmail.com> Signed-off-by: Eric Gregory <eric@cosmonic.com>
Co-authored-by: Brooks Townsend <brooksmtownsend@gmail.com> Signed-off-by: Eric Gregory <eric@cosmonic.com>
Co-authored-by: Brooks Townsend <brooksmtownsend@gmail.com> Signed-off-by: Eric Gregory <eric@cosmonic.com>
Signed-off-by: Eric Gregory <eric@cosmonic.com>
Signed-off-by: Eric Gregory <eric@cosmonic.com>
WIP