Skip to content
This repository has been archived by the owner on Oct 2, 2020. It is now read-only.

Add todo list + kv tutorial to docs #216

Merged
merged 6 commits into from
Aug 9, 2019
Merged

Conversation

kristianfreeman
Copy link
Contributor

@kristianfreeman kristianfreeman commented Jun 4, 2019

Waiting on cloudflare/wrangler-legacy#203 before this can be merged - KV namespace support in wrangler shouldn't be in documentation until it's out, on a released version. Still ready for review in the meantime :)

@kristianfreeman kristianfreeman force-pushed the kristian/kv-tutorial branch 2 times, most recently from 637f290 to 8483bfd Compare June 5, 2019 19:01
@kristianfreeman kristianfreeman changed the title WIP Begin adding kv/todo list tutorial Begin adding kv/todo list tutorial Jun 10, 2019
Copy link
Contributor

@xortive xortive left a comment

Choose a reason for hiding this comment

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

Overall really like this tutorial. Only really needs some branding changes (s/worker/workers) for consistency.

content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Outdated Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
content/tutorials/build-a-todo-list/_index.md Show resolved Hide resolved
@kristianfreeman kristianfreeman changed the title Begin adding kv/todo list tutorial [BLOCKED] Begin adding kv/todo list tutorial Jun 21, 2019
@kristianfreeman kristianfreeman changed the title [BLOCKED] Begin adding kv/todo list tutorial Add todo list + kv tutorial to docs Jul 31, 2019
@exvuma
Copy link
Contributor

exvuma commented Jul 31, 2019

I think this tutorial is phenomenally helpful, but I wish I could find this information in the reference docs without being walked through another tutorial.

We should be careful about adding anymore tutorials (there are already 4) in the future, and instead add information the the existing tutorials (e.g. using KV to store the API keys from slack bot tutorial..? ). Ideally one could go through just 1 tutorial and be on boarded with an imagination of what Workers can do and one could go through 3 tutorials and get a comprehensive understanding of all of Worker's flagship capabilities. Asking one to pick from 4+ tutorial losses a lot of audience and a lot of attention.

I suggest we 1. focus on giving KV ref docs love 2. incorporate KV to one of the existing tutorials.

@kristianfreeman
Copy link
Contributor Author

I think this tutorial is phenomenally helpful, but I wish I could find this information in the reference docs without being walked through another tutorial.

I agree, we should have accompanying docs for the "happy path" of KV (using it with Wrangler) in the Reference part of our docs. I know some conversations have been happening about the KV section of the docs, and I imagine that either adding info about the Wrangler integration, or just linking to the Wrangler docs specifically (or the README) would cover help alleviate this.

That being said, l still think this should be a flagship tutorial, listed in the sidebar. I don't personally feel like five tutorials are too much cognitive overhead for devs to choose from, and the concepts in this tutorial, in particular, are useful and approachable in a way that some of the other ones (i.e. the Slack/GitHub webhook tutorial) aren't:

  • Rendering HTML/CSS/JS from in the browser
  • (obviously) using KV in Wrangler and in your actual code

I think the work in #290 is going to support how we build new educational content in the docs in the future, but I'd like to proceed with adding this tutorial, and continue to think about how to present this kind of info throughout the site!

@kristianfreeman kristianfreeman merged commit 3d139b3 into master Aug 9, 2019
@delete-merged-branch delete-merged-branch bot deleted the kristian/kv-tutorial branch August 9, 2019 16:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants