search

dapr / docs

Dapr user documentation, used to build docs.dapr.io
https://docs.dapr.io
Creative Commons Attribution 4.0 International
987 stars 715 forks source link

Initial Dapr Shared Docs #4121

Closed salaboy closed 1 week ago

salaboy commented 2 months ago

Please follow this checklist before submitting:

In addition, please fill out the following to help reviewers understand this pull request:

Description

This is an initial version of the Dapr Shared docs. Now that Dapr Shared is out of Sandbox, a new set of docs are needed for new users to understand how to use it and get started with Dapr Shared. I would appreciate feedback on the location of these docs and what other sections to include.

Issue reference

hhunter-ms commented 1 month ago

@salaboy - @msfussell suggested I update the diagrams and send you the slides in case you wanted to tweak. Here's the pptx link:

Suggested-Dapr-Share-diagrams.pptx

salaboy commented 1 month ago

@salaboy - @msfussell suggested I update the diagrams and send you the slides in case you wanted to tweak. Here's the pptx link:

Suggested-Dapr-Share-diagrams.pptx

Thanks a lot for doing this @hhunter-ms ! the diagrams look amazing

salaboy commented 1 month ago

@hhunter-ms there are a few things that I need to manually change.. but the rest looks good.. I will tackle these changes in the next few days.

github-actions[bot] commented 1 month ago

Stale PR, paging all reviewers

github-actions[bot] commented 1 month ago

Stale PR, paging all reviewers

github-actions[bot] commented 1 month ago

Stale PR, paging all reviewers

msfussell commented 1 month ago

@salaboy - Tell me when you have time to review these comments to that we can get the PR merged. Suggest getting changes to the Dapr-Shared repo at the same time

github-actions[bot] commented 1 month ago

Stale PR, paging all reviewers

salaboy commented 1 month ago

bump.. working on this now

salaboy commented 4 weeks ago

Ok, quick update here. To get this done, I needed to change the hello-kubernetes quickstart applications to support the SDK supported environment variables: https://github.com/dapr/quickstarts/issues/1029 and https://github.com/dapr/quickstarts/pull/1030

Once these changes are done, I am submitting a PR to the dapr-shared repository with a new tutorial expanding on the hello-kubernetes tutorial to use Dapr Shared.

Finally, I will align this PR to link to that tutorial and maybe use the diagrams shown there.

salaboy commented 1 week ago

@msfussell @hhunter-ms I think the daemonset diagram is fine, as the note explicitly says one per cluster node..

salaboy commented 1 week ago

quick grammar review

Thanks a lot @hhunter-ms !

salaboy commented 1 week ago

@msfussell diagrams updated.. I tried to answer all your comments but can we please not change the terminology and use Deployment and DaemonSet strategies? I think we will confuse people

msfussell commented 1 week ago

@msfussell diagrams updated.. I tried to answer all your comments but can we please not change the terminology and use Deployment and DaemonSet strategies? I think we will confuse people

@salaboy - Diagram look good. Where is the source for the diagrams? Can you provide these? And one ask on the diagrams is to add the Kubernetes logo to show the boundary of the cluster. Like this example https://docs.dapr.io/concepts/overview/#kubernetes

salaboy commented 1 week ago

New diagrams here: Dapr-Shared-diagrams.pptx based on what @hhunter-ms shared with me

salaboy commented 1 week ago

Done

On Thu, 27 Jun 2024 at 16:55, Hannah Hunter @.***> wrote:

@.**** commented on this pull request.

@salaboy https://github.com/salaboy - could you "Ignore all" the spelling error in the daemonset.png diagram to remove the red squiggly lines? other than that, lgtm!

— Reply to this email directly, view it on GitHub https://github.com/dapr/docs/pull/4121#pullrequestreview-2145835699, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACCMXVCF4WMEAFQN7OYJG3ZJQYX3AVCNFSM6AAAAABG6LU66CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDCNBVHAZTKNRZHE . You are receiving this because you were mentioned.Message ID: @.***>