search

temporalio / temporal-learning

temporal-learning.preview.thundergun.io
Other
3 stars 7 forks source link

#311: List more than one example on the Examples page :) #312

Closed webchick closed 2 weeks ago

webchick commented 3 weeks ago

(Corresponding Jira ticket EDU-1842)

What was changed

This PR adds a few more "non-controversial" examples (meaning, limited to the github.com/temporalio namespace for now) to the Examples page, including a reference to the new Order Management System which was just launched at Replay, so we can give people a bit more of a head start.

It also introduces the concept of "categories" on this page, so we can expand the list here to other types of examples in the future.

Why?

See #311 for background/rationale.

Checklist

  1. Pushes forward #311 (maybe doesn't "close" it)

  2. How was this tested: I ran vale index.md as instructed in the README and proactively fixed a few things that it found. (It unfortunately barfs on the link titles to the SDK examples though :)

I couldn't seem to get the link checking working (I blame midnight oil :D) so I did a manual click-through on those.

  1. Any docs updates needed? N/A?
vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
temporal-learning ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 3:28pm
webchick commented 3 weeks ago

A bikeshed we could reasonably paint here btw, is what categories make the most sense for the people perusing this content (vs. how "we" think of them); however, I once again underscore that right now the examples page has only ONE example, so I would prefer to defer that painting party to another time. ;)

axfelix commented 3 weeks ago

These are nice additions and the build is passing which is rare for first-time learn or docs site contributors, so thank you very much for that!

I think we've been meaning to have a longer conversation for a while about whether we want to link to the sample repos directly or whether we want to try to progressively write them up as tutorials, so this might be an open-ended addition -- and likewise for the OMS, I don't know how we're planning to socialize that at the moment.

So basically -- this PR should absolutely stay open for now, but I'm not 100% on where we stand on merging it currently.

axfelix commented 3 weeks ago

@temporalio/education

webchick commented 3 weeks ago

I think we've been meaning to have a longer conversation for a while about whether we want to link to the sample repos directly or whether we want to try to progressively write them up as tutorials

Makes sense. Here are a few data points to consider:

  1. Right now, it takes a person on average between 4-6 months to go from "I just learned about Temporal" to "I built my first POC using it." That is an awfully long time to get over the suck threshold.
  2. During both discussions internally (with PMM, SAs), as well as externally (with customers + users at Replay), a lack of examples to start from was widely cited as the top reason this tends to happen.
  3. If you do a Google search for "temporal examples," https://learn.temporal.io/examples/ is the top result (nicely done!) so providing people with a strong first impression here feels quite important.

If we link directly to repos as a starting point, we can easily change those links over to tutorials as they become available. But in the meantime, all 3 of the above points are improved.

axfelix commented 3 weeks ago

@napcs For your consideration next week while I'm out

napcs commented 2 weeks ago

This is the right first step and I appreciate @webchick for taking the time to make this happen.