quickstarts icon indicating copy to clipboard operation
quickstarts copied to clipboard

Published 20 hours ago • verified publisher icon dapr

Cleaning up Coming Soon placeholders

Open paulyuk opened this issue 2 years ago • 3 comments

I'd like to get opinions from the community and maintainers @msfussell @amulyavarote here.

Right now we have have a coming soon in the table for quickstarts for every API in Dapr. I think now that we have critical mass with APIs, this looks silly to have these coming soons, and I propose we track work here vs have Coming Soon on the website/docs.

I also think given cost to write and maintain these, and really support well, I'm not sure we want a quickstart for every single API forever. It would help to know where this is most useful to the community.

More specifically:

  • Configuration - I believe we SHOULD do this based on high relevance to most apps and users. It is also a good API for this format.
  • Observability - i believe we SHOULD NOT do this. I could be convinced however to configure the observability component to work well for all other quickstarts, and have a step that guides users to look at the Zipkin dashboard.
  • Actors - I'm on the fence but currently believe we SHOULD do this since we see interest in actors and it may be harder to get going in a practical use case.
  • Distributed Lock - right now this feels very narrow and not widely applicable, so I think we SHOULD NOT do a quickstart until we hear more interest. Dapr Docs? certainly.

Thoughts?

paulyuk avatar Sep 22 '22 19:09 paulyuk

BTW, this is the symptom I'm talking about on https://docs.dapr.io/getting-started/quickstarts/

image

paulyuk avatar Sep 22 '22 19:09 paulyuk

@paulyuk I also think the priority should be given to configuration API. We can take out Observability from the list as an example is already included in the tutorials section.

amulyavarote avatar Sep 26 '22 18:09 amulyavarote

should we PR a change then, only leaving Configuration for now?

paulyuk avatar Sep 29 '22 19:09 paulyuk

#keepalive to @msfussell @amulyavarote so we can move forward!

paulyuk avatar Oct 17 '22 23:10 paulyuk

Actors and configuration for certain. None of the quickstarts are practical, so actors does not need to be. However there is a large gap in having actor samples currently. All the APIs should have examples in my opinion including lock.
The observability tutorial needs updating to include OTEL, although what OTEL observer can be used locally is an open issue and the ZipKin containers can remaining.

msfussell avatar Oct 19 '22 16:10 msfussell

Hi @paulyuk and @msfussell, Sarthak from IDC has picked up the configuration one. Waiting for the update or waiting for the PR to review.

amulyavarote avatar Oct 21 '22 20:10 amulyavarote

Issue resolved

msfussell avatar May 20 '23 00:05 msfussell