Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Dapr .NET SDK documentation #1409

Merged
merged 50 commits into from
Dec 12, 2024
Merged

Conversation

WhitWaldo
Copy link
Contributor

@WhitWaldo WhitWaldo commented Nov 20, 2024

Description

As I go through the Dapr docs, this is a catch-all documentation PR that's applying updates that capture the changes made in the various accepted PRs for the 1.15 release. I'll update this list as I go, but here's what's covered so far:

  • Dependency injection changes
  • Clarified where the port is sourced from when both the endpoint and port env vars are specified.
  • Documented DaprClientBuilder options and how to configure it from different sources
  • Added documentation for Jobs client
  • Added documentation for Messaging client
  • Added documentation for Conversation client
  • Updated contribution guide
  • Added Aspire documentation for local development

Issue reference

We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation.

Please reference the issue this PR will close: #1322

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • [N/A] Code compiles correctly
  • [N/A] Created/updated tests
  • Extended the documentation

@WhitWaldo WhitWaldo added the documentation Improvements or additions to documentation label Nov 20, 2024
@WhitWaldo WhitWaldo added this to the v1.15 milestone Nov 20, 2024
@WhitWaldo WhitWaldo self-assigned this Nov 20, 2024
…as well as DAPR_GRPC_ENDPOINT and DAPR_GRPC_PORT.

Signed-off-by: Whit Waldo <[email protected]>
…of 1.15 and provided more information/example around sourcing from IConfiguration.

Signed-off-by: Whit Waldo <[email protected]>
philliphoff
philliphoff previously approved these changes Dec 10, 2024
@WhitWaldo WhitWaldo mentioned this pull request Dec 10, 2024
3 tasks
Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: Whit Waldo <[email protected]>
@WhitWaldo WhitWaldo marked this pull request as ready for review December 11, 2024 21:15
@WhitWaldo WhitWaldo requested review from a team as code owners December 11, 2024 21:15
Copy link
Collaborator

@philliphoff philliphoff left a comment

Choose a reason for hiding this comment

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

Thanks for all the new content! :shipit:

@WhitWaldo WhitWaldo merged commit 1454043 into dapr:master Dec 12, 2024
12 checks passed
@WhitWaldo WhitWaldo deleted the daprclient-docs branch December 12, 2024 17:07
jev-e pushed a commit to jev-e/jev-dotnet-sdk that referenced this pull request Dec 26, 2024
* Updated documentation to reflect new DaprClient DI injection capabilities

Signed-off-by: Whit Waldo <[email protected]>

* Clarified relationship between DAPR_HTTP_ENDPOINT and DAPR_HTTP_PORT as well as DAPR_GRPC_ENDPOINT and DAPR_GRPC_PORT.

Signed-off-by: Whit Waldo <[email protected]>

* Clarified configuration prioritization order on DaprClientBuilder as of 1.15 and provided more information/example around sourcing from IConfiguration.

Signed-off-by: Whit Waldo <[email protected]>

* Fixed typo - great catch Philip!

Signed-off-by: Whit Waldo <[email protected]>

* Added information about using Dapr.Jobs favoring dependency injection

Signed-off-by: Whit Waldo <[email protected]>

* Building out .NET AI docs

Signed-off-by: Whit Waldo <[email protected]>

* Building out .NET AI docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Reordered the weighting of the development docs to reflect investment level

Signed-off-by: Whit Waldo <[email protected]>

* Updated .NET SDK links to point to a better endpoint

Signed-off-by: Whit Waldo <[email protected]>

* Updated more of the .NET SDK links

Signed-off-by: Whit Waldo <[email protected]>

* Reweighted document order

Signed-off-by: Whit Waldo <[email protected]>

* Building out pubsub docs

Signed-off-by: Whit Waldo <[email protected]>

* Tweak to clarify use of the Dapr SDK

Signed-off-by: Whit Waldo <[email protected]>

* Added missing whitespace for clarity

Signed-off-by: Whit Waldo <[email protected]>

* Simplified alert about .NET versioning

Signed-off-by: Whit Waldo <[email protected]>

* Added Dapr.Jobs as a prereq

Signed-off-by: Whit Waldo <[email protected]>

* Added some minor formatting tweaks

Signed-off-by: Whit Waldo <[email protected]>

* Added body of the pubsub how to documentation

Signed-off-by: Whit Waldo <[email protected]>

* Updated table layout + reformatted

Signed-off-by: Whit Waldo <[email protected]>

* Added note about using DI functionality in best practices

Signed-off-by: Whit Waldo <[email protected]>

* Fixed several typos

Signed-off-by: Whit Waldo <[email protected]>

* Corrected updated overload

Signed-off-by: Whit Waldo <[email protected]>

* Added best practices documentation for PubSub functionality

Signed-off-by: Whit Waldo <[email protected]>

* Updated contribution guide

Signed-off-by: Whit Waldo <[email protected]>

* Added current .NET version support to contributor guide

Signed-off-by: Whit Waldo <[email protected]>

* Minor word addition

Signed-off-by: Whit Waldo <[email protected]>

* Renamed for consistency

Signed-off-by: Whit Waldo <[email protected]>

* Tweaks to introduction text

Signed-off-by: Whit Waldo <[email protected]>

* Added Conversation usage documentation

Signed-off-by: Whit Waldo <[email protected]>

* Updated to reflect updated extension method name following merge of dapr#1423

Signed-off-by: Whit Waldo <[email protected]>

* Built out Jobs introduction

Signed-off-by: Whit Waldo <[email protected]>

* Updated support message for Dapr.Workflows

Signed-off-by: Whit Waldo <[email protected]>

---------

Signed-off-by: Whit Waldo <[email protected]>
jev-e pushed a commit to jev-e/jev-dotnet-sdk that referenced this pull request Dec 26, 2024
* Updated documentation to reflect new DaprClient DI injection capabilities

Signed-off-by: Whit Waldo <[email protected]>

* Clarified relationship between DAPR_HTTP_ENDPOINT and DAPR_HTTP_PORT as well as DAPR_GRPC_ENDPOINT and DAPR_GRPC_PORT.

Signed-off-by: Whit Waldo <[email protected]>

* Clarified configuration prioritization order on DaprClientBuilder as of 1.15 and provided more information/example around sourcing from IConfiguration.

Signed-off-by: Whit Waldo <[email protected]>

* Fixed typo - great catch Philip!

Signed-off-by: Whit Waldo <[email protected]>

* Added information about using Dapr.Jobs favoring dependency injection

Signed-off-by: Whit Waldo <[email protected]>

* Building out .NET AI docs

Signed-off-by: Whit Waldo <[email protected]>

* Building out .NET AI docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Added first-draft of .NET Aspire docs

Signed-off-by: Whit Waldo <[email protected]>

* Reordered the weighting of the development docs to reflect investment level

Signed-off-by: Whit Waldo <[email protected]>

* Updated .NET SDK links to point to a better endpoint

Signed-off-by: Whit Waldo <[email protected]>

* Updated more of the .NET SDK links

Signed-off-by: Whit Waldo <[email protected]>

* Reweighted document order

Signed-off-by: Whit Waldo <[email protected]>

* Building out pubsub docs

Signed-off-by: Whit Waldo <[email protected]>

* Tweak to clarify use of the Dapr SDK

Signed-off-by: Whit Waldo <[email protected]>

* Added missing whitespace for clarity

Signed-off-by: Whit Waldo <[email protected]>

* Simplified alert about .NET versioning

Signed-off-by: Whit Waldo <[email protected]>

* Added Dapr.Jobs as a prereq

Signed-off-by: Whit Waldo <[email protected]>

* Added some minor formatting tweaks

Signed-off-by: Whit Waldo <[email protected]>

* Added body of the pubsub how to documentation

Signed-off-by: Whit Waldo <[email protected]>

* Updated table layout + reformatted

Signed-off-by: Whit Waldo <[email protected]>

* Added note about using DI functionality in best practices

Signed-off-by: Whit Waldo <[email protected]>

* Fixed several typos

Signed-off-by: Whit Waldo <[email protected]>

* Corrected updated overload

Signed-off-by: Whit Waldo <[email protected]>

* Added best practices documentation for PubSub functionality

Signed-off-by: Whit Waldo <[email protected]>

* Updated contribution guide

Signed-off-by: Whit Waldo <[email protected]>

* Added current .NET version support to contributor guide

Signed-off-by: Whit Waldo <[email protected]>

* Minor word addition

Signed-off-by: Whit Waldo <[email protected]>

* Renamed for consistency

Signed-off-by: Whit Waldo <[email protected]>

* Tweaks to introduction text

Signed-off-by: Whit Waldo <[email protected]>

* Added Conversation usage documentation

Signed-off-by: Whit Waldo <[email protected]>

* Updated to reflect updated extension method name following merge of dapr#1423

Signed-off-by: Whit Waldo <[email protected]>

* Built out Jobs introduction

Signed-off-by: Whit Waldo <[email protected]>

* Updated support message for Dapr.Workflows

Signed-off-by: Whit Waldo <[email protected]>

---------

Signed-off-by: Whit Waldo <[email protected]>
Signed-off-by: jev <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Add Jobs API .NET client example to doc
2 participants