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

V1.2 python SDKDocs update - client #1553

Merged
merged 10 commits into from
Jun 29, 2021
Merged

V1.2 python SDKDocs update - client #1553

merged 10 commits into from
Jun 29, 2021

Conversation

paulyuk
Copy link
Contributor

@paulyuk paulyuk commented Jun 12, 2021

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

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

Description

Updates Python SDK client documentation:

  • fixes to match v1.2 Dapr release
  • fixes links to point to main/1.2 branches
  • adds Subscribe example

Note this is the matching PR to pair with python-SDK submodule PR:
dapr/python-sdk#224

Issue reference

Fixes #1551

@paulyuk paulyuk requested a review from a team as a code owner June 12, 2021 20:55
@paulyuk paulyuk changed the title V1.2 paulyuk sd kupdate V1.2 python SDKDocs update - client Jun 12, 2021
@paulyuk paulyuk added the waiting-on-code-pr The code PR needs to be merged before the docs are updated label Jun 12, 2021
@paulyuk
Copy link
Contributor Author

paulyuk commented Jun 12, 2021

@wcs1only @berndverst advise and see if branching technique and separate PR is correct in this case.
dapr/python-sdk#224

@paulyuk
Copy link
Contributor Author

paulyuk commented Jun 14, 2021

Let's hold for the pythonSDK change, and then I'll be about to use the upstream merged files

@paulyuk paulyuk added do-not-merge and removed waiting-on-code-pr The code PR needs to be merged before the docs are updated labels Jun 14, 2021
@paulyuk
Copy link
Contributor Author

paulyuk commented Jun 14, 2021

Let's wait on PR in Python SDKDocs to merge upstream, and I'll re-sync this change to submodule..

@AaronCrawfis AaronCrawfis linked an issue Jun 14, 2021 that may be closed by this pull request
@paulyuk
Copy link
Contributor Author

paulyuk commented Jun 29, 2021

@AaronCrawfis could you please take a look? This is simply a merge of Python SDK changes in sub module so we can release them to docs.dapr.io.

Note this is the matching PR to pair with python-SDK submodule PR:
dapr/python-sdk#224

Fixes #1551

@greenie-msft greenie-msft added waiting-on-code-pr The code PR needs to be merged before the docs are updated and removed do-not-merge labels Jun 29, 2021
@AaronCrawfis AaronCrawfis merged commit fc677ac into dapr:v1.2 Jun 29, 2021
AaronCrawfis added a commit that referenced this pull request Jul 8, 2021
* Supported Release Info and Upgrade Path for v1.2 (#1494)

* Supported Release Info and Upgrade Path for v1.2

* Update support-release-policy.md

* Update daprdocs/content/en/operations/support/support-release-policy.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Adding K8s versions table (#1521)

* Adding table of kubernetes versions

* Updating intro

* Fix incorrect postgresql connection string example (#1524)

Co-authored-by: Aaron Crawfis <[email protected]>

* Update docs on using Codespaces with Dapr repos (#1522)

* Update docs on using Codespaces with Dapr repos

* Move codespaces.md under the Contributing topic

* Update daprdocs/content/en/contributing/codespaces.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix two typos (#1526)

Co-authored-by: Aaron Crawfis <[email protected]>

* Update chinese content (#1527)

Co-authored-by: Aaron Crawfis <[email protected]>

* Updated to fix deprecated helm chart location (#1528)

The `https://kubernetes-charts.storage.googleapis.com/` location is no longer used, so this change updates this, the command to install, and the missing update step that will cause the install to fail if an update was never done after adding the location.

Co-authored-by: Aaron Crawfis <[email protected]>

* nr_consul_typo fixed malformed yaml (#1532)

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix typo in azure-keyvault-managed-identity.md (#1541)

* Fix custom middleware sample code interface implementation error (#1539)

Fix custom middleware sample code interface implementation error, interface function declare error.

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix the file name of secrets json (#1546)

* Tech writing touch-ups (#1555)

* Tech writing touch-ups (#1556)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (#1557)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (#1558)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (#1560)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (#1559)

Co-authored-by: Aaron Crawfis <[email protected]>

* Ignore intellij link that isn't resolvable (#1564)

* Update issue templates (#1563)

* Update issue templates

* Add needs-triage

* Updating PubSub documentation to remove slave wording (#1565)

* Updating PubSub documentation to remove slave

Bitnami has updated their Redis Helm chart to change redis-slave to redis-replicas. I am updating the documentation for PubSub to reflect this change and avoid confusion for any readers.

* Removing more instances of Redis slave naming

Co-authored-by: Aaron Crawfis <[email protected]>

* Actor Runtime Configuration Docs (#1495)

* Actor Runtime Configuration Docs

Addresses #1470

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* add configuration examples

* configuration examples

* Fix syntax

* Add dotnet sample

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Fixed GCP Pub/Sub Binding required fields (#1578)

* aacrawfi/middlware (#1567)

* Move and update middleware components

* Update middleware docs structure

* Combine middleware pages

* Update middleware references

* Update middleware image

* Fix incorrect curl syntax in Actors API examples (#1577)

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix link at api-allowlist.md (#1574)

Fix link at api-allowlist.md to Dapr Configuration overview

Co-authored-by: Aaron Crawfis <[email protected]>

* Add language that only a single state store component can be used for actors state mangement (#1579)

Co-authored-by: Aaron Crawfis <[email protected]>

* fix: cron format (#1581)

* Updated name resolution docs (#1576)

* Add consul references

* Fix typo

Add a missing word

* Clarify state management examples

* Added table to show Kubernetes options

When I read this doc it was unclear that the cert could be provided as a secret. The only table on the original version showed `spnCertificateFile` as a required option. I added a second table to make it clear that in Kubernetes there is a `spnCertificate` option that does not require a file on disk.

* incorporating feedback

* Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md

* Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md

* Fix self-hosted docs

* Remove name-resolution reference

* Add other name resolution providers

* Update service invocation docs

* Remove whitespace

* Update service-invocation-overview.md

Fixed typo and added a sentence on Consul

* Update setup-nr-consul.md

Minor updates

* Address comments

* Fix code formatting

Co-authored-by: Esteban Luchsinger <[email protected]>
Co-authored-by: Donovan Brown <[email protected]>
Co-authored-by: Mark Fussell <[email protected]>

* Fix broken url in docs (#1599)

## Summary

Easy navigation and easy reading for others

* Dapr roadmap page (#1593)

* Add Dapr Roadmap doc

* Change format of project column to use cards

* Update docsy theme

* Use card codes for Roadmap page

* Update toc issue

* Update packages

* Update image and switch to page bundle

* Move into contributing

* Add note on v1.2

Co-authored-by: Nick Greenfield <[email protected]>

* Add shortcode to embed sections of code files (#1596)

* Add code snippet shortcode

* Add docs on shortcode

* V1.2 python SDKDocs update - client (#1553)

* Committing lock file for active doc changes

* Revert "Committing lock file for active doc changes"

This reverts commit 4fee3a4.

* Subproject commit to SDK files

* Updated Examples link to point to current branch

* Fixes #1551 python sdk examples

* Merging changes with branch

* Syncing python SDKdocs with daprdocs

* updating submodule commit with correct synced hash

Co-authored-by: Yaron Schneider <[email protected]>

* Remove visible <b> (#1602)

Signed-off-by: Long Dai <[email protected]>

* Comment out all optional destructive parameters (#1604)

* Remove "http" code type from health_api.md (#1610)

Looking at this page, this line was highlighted.

Co-authored-by: Aaron Crawfis <[email protected]>

* Remove "http" code type from metadata_api.md (#1611)

Looking at this page, this line was highlighted.

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix typo of "the" (#1616)

the the -> the

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix a link to "Next steps" (#1617)

A link description was broken.

Co-authored-by: Aaron Crawfis <[email protected]>

* Bump glob-parent from 5.1.1 to 5.1.2 in /daprdocs (#1618)

Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2.
- [Release notes](https://github.com/gulpjs/glob-parent/releases)
- [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md)
- [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2)

---
updated-dependencies:
- dependency-name: glob-parent
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Aaron Crawfis <[email protected]>

* Clarify shared access policy (#1621)

Co-authored-by: Bernd Verst <[email protected]>
Co-authored-by: Mark Fussell <[email protected]>
Co-authored-by: Zonciu Liang <[email protected]>
Co-authored-by: Simon Leet <[email protected]>
Co-authored-by: Maarten Mulders <[email protected]>
Co-authored-by: Newbe36524 <[email protected]>
Co-authored-by: Steven Jenkins De Haro <[email protected]>
Co-authored-by: Abdulaziz Elsheikh <[email protected]>
Co-authored-by: Antonio Fiumanò <[email protected]>
Co-authored-by: li1234yun <[email protected]>
Co-authored-by: greenie-msft <[email protected]>
Co-authored-by: voipengineer <[email protected]>
Co-authored-by: Evan Simkowitz <[email protected]>
Co-authored-by: Ricardo Niepel <[email protected]>
Co-authored-by: Abhith Rajan <[email protected]>
Co-authored-by: Esteban Luchsinger <[email protected]>
Co-authored-by: Donovan Brown <[email protected]>
Co-authored-by: SaintMalik <[email protected]>
Co-authored-by: Nick Greenfield <[email protected]>
Co-authored-by: Paul Yuknewicz <[email protected]>
Co-authored-by: Yaron Schneider <[email protected]>
Co-authored-by: Long Dai <[email protected]>
Co-authored-by: Ryuji Iwata <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
sk593 pushed a commit to sk593/docs that referenced this pull request Jul 20, 2021
* Supported Release Info and Upgrade Path for v1.2 (dapr#1494)

* Supported Release Info and Upgrade Path for v1.2

* Update support-release-policy.md

* Update daprdocs/content/en/operations/support/support-release-policy.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Adding K8s versions table (dapr#1521)

* Adding table of kubernetes versions

* Updating intro

* Fix incorrect postgresql connection string example (dapr#1524)

Co-authored-by: Aaron Crawfis <[email protected]>

* Update docs on using Codespaces with Dapr repos (dapr#1522)

* Update docs on using Codespaces with Dapr repos

* Move codespaces.md under the Contributing topic

* Update daprdocs/content/en/contributing/codespaces.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix two typos (dapr#1526)

Co-authored-by: Aaron Crawfis <[email protected]>

* Update chinese content (dapr#1527)

Co-authored-by: Aaron Crawfis <[email protected]>

* Updated to fix deprecated helm chart location (dapr#1528)

The `https://kubernetes-charts.storage.googleapis.com/` location is no longer used, so this change updates this, the command to install, and the missing update step that will cause the install to fail if an update was never done after adding the location.

Co-authored-by: Aaron Crawfis <[email protected]>

* nr_consul_typo fixed malformed yaml (dapr#1532)

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix typo in azure-keyvault-managed-identity.md (dapr#1541)

* Fix custom middleware sample code interface implementation error (dapr#1539)

Fix custom middleware sample code interface implementation error, interface function declare error.

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix the file name of secrets json (dapr#1546)

* Tech writing touch-ups (dapr#1555)

* Tech writing touch-ups (dapr#1556)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (dapr#1557)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (dapr#1558)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (dapr#1560)

Co-authored-by: Aaron Crawfis <[email protected]>

* Tech writing touch-ups (dapr#1559)

Co-authored-by: Aaron Crawfis <[email protected]>

* Ignore intellij link that isn't resolvable (dapr#1564)

* Update issue templates (dapr#1563)

* Update issue templates

* Add needs-triage

* Updating PubSub documentation to remove slave wording (dapr#1565)

* Updating PubSub documentation to remove slave

Bitnami has updated their Redis Helm chart to change redis-slave to redis-replicas. I am updating the documentation for PubSub to reflect this change and avoid confusion for any readers.

* Removing more instances of Redis slave naming

Co-authored-by: Aaron Crawfis <[email protected]>

* Actor Runtime Configuration Docs (dapr#1495)

* Actor Runtime Configuration Docs

Addresses dapr#1470

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* add configuration examples

* configuration examples

* Fix syntax

* Add dotnet sample

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <[email protected]>

* Fixed GCP Pub/Sub Binding required fields (dapr#1578)

* aacrawfi/middlware (dapr#1567)

* Move and update middleware components

* Update middleware docs structure

* Combine middleware pages

* Update middleware references

* Update middleware image

* Fix incorrect curl syntax in Actors API examples (dapr#1577)

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix link at api-allowlist.md (dapr#1574)

Fix link at api-allowlist.md to Dapr Configuration overview

Co-authored-by: Aaron Crawfis <[email protected]>

* Add language that only a single state store component can be used for actors state mangement (dapr#1579)

Co-authored-by: Aaron Crawfis <[email protected]>

* fix: cron format (dapr#1581)

* Updated name resolution docs (dapr#1576)

* Add consul references

* Fix typo

Add a missing word

* Clarify state management examples

* Added table to show Kubernetes options

When I read this doc it was unclear that the cert could be provided as a secret. The only table on the original version showed `spnCertificateFile` as a required option. I added a second table to make it clear that in Kubernetes there is a `spnCertificate` option that does not require a file on disk.

* incorporating feedback

* Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md

* Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md

* Fix self-hosted docs

* Remove name-resolution reference

* Add other name resolution providers

* Update service invocation docs

* Remove whitespace

* Update service-invocation-overview.md

Fixed typo and added a sentence on Consul

* Update setup-nr-consul.md

Minor updates

* Address comments

* Fix code formatting

Co-authored-by: Esteban Luchsinger <[email protected]>
Co-authored-by: Donovan Brown <[email protected]>
Co-authored-by: Mark Fussell <[email protected]>

* Fix broken url in docs (dapr#1599)

Easy navigation and easy reading for others

* Dapr roadmap page (dapr#1593)

* Add Dapr Roadmap doc

* Change format of project column to use cards

* Update docsy theme

* Use card codes for Roadmap page

* Update toc issue

* Update packages

* Update image and switch to page bundle

* Move into contributing

* Add note on v1.2

Co-authored-by: Nick Greenfield <[email protected]>

* Add shortcode to embed sections of code files (dapr#1596)

* Add code snippet shortcode

* Add docs on shortcode

* V1.2 python SDKDocs update - client (dapr#1553)

* Committing lock file for active doc changes

* Revert "Committing lock file for active doc changes"

This reverts commit 4fee3a4.

* Subproject commit to SDK files

* Updated Examples link to point to current branch

* Fixes dapr#1551 python sdk examples

* Merging changes with branch

* Syncing python SDKdocs with daprdocs

* updating submodule commit with correct synced hash

Co-authored-by: Yaron Schneider <[email protected]>

* Remove visible <b> (dapr#1602)

Signed-off-by: Long Dai <[email protected]>

* Comment out all optional destructive parameters (dapr#1604)

* Remove "http" code type from health_api.md (dapr#1610)

Looking at this page, this line was highlighted.

Co-authored-by: Aaron Crawfis <[email protected]>

* Remove "http" code type from metadata_api.md (dapr#1611)

Looking at this page, this line was highlighted.

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix typo of "the" (dapr#1616)

the the -> the

Co-authored-by: Aaron Crawfis <[email protected]>

* Fix a link to "Next steps" (dapr#1617)

A link description was broken.

Co-authored-by: Aaron Crawfis <[email protected]>

* Bump glob-parent from 5.1.1 to 5.1.2 in /daprdocs (dapr#1618)

Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2.
- [Release notes](https://github.com/gulpjs/glob-parent/releases)
- [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md)
- [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2)

---
updated-dependencies:
- dependency-name: glob-parent
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Aaron Crawfis <[email protected]>

* Clarify shared access policy (dapr#1621)

Co-authored-by: Bernd Verst <[email protected]>
Co-authored-by: Mark Fussell <[email protected]>
Co-authored-by: Zonciu Liang <[email protected]>
Co-authored-by: Simon Leet <[email protected]>
Co-authored-by: Maarten Mulders <[email protected]>
Co-authored-by: Newbe36524 <[email protected]>
Co-authored-by: Steven Jenkins De Haro <[email protected]>
Co-authored-by: Abdulaziz Elsheikh <[email protected]>
Co-authored-by: Antonio Fiumanò <[email protected]>
Co-authored-by: li1234yun <[email protected]>
Co-authored-by: greenie-msft <[email protected]>
Co-authored-by: voipengineer <[email protected]>
Co-authored-by: Evan Simkowitz <[email protected]>
Co-authored-by: Ricardo Niepel <[email protected]>
Co-authored-by: Abhith Rajan <[email protected]>
Co-authored-by: Esteban Luchsinger <[email protected]>
Co-authored-by: Donovan Brown <[email protected]>
Co-authored-by: SaintMalik <[email protected]>
Co-authored-by: Nick Greenfield <[email protected]>
Co-authored-by: Paul Yuknewicz <[email protected]>
Co-authored-by: Yaron Schneider <[email protected]>
Co-authored-by: Long Dai <[email protected]>
Co-authored-by: Ryuji Iwata <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting-on-code-pr The code PR needs to be merged before the docs are updated
Projects
None yet
6 participants