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

Added Crypto API reference documentation #3952

Merged
merged 12 commits into from
Jan 23, 2024

Conversation

WhitWaldo
Copy link
Contributor

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • 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

Provides missing Crypto API documentation following the style of the Actors and State API pages. I also updated the weight of the Error Codes reference page so it continues to show last in the reference docs list.

Issue reference

Please reference the issue this PR will close: #3945

…so it's last in list.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Jan 19, 2024
…so it's last in list.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

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

@WhitWaldo Thanks for jumping on this. Added a few minor comments. Could you also add a link to this reference API into the Related links section on the Crypto overview here https://docs.dapr.io/developing-applications/building-blocks/cryptography/cryptography-overview/#related-links

daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/cryptography_api.md Outdated Show resolved Hide resolved
@msfussell msfussell removed the stale label Jan 22, 2024
WhitWaldo and others added 9 commits January 22, 2024 07:55
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
…ference

# Conflicts:
#	daprdocs/content/en/reference/api/cryptography_api.md
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
@WhitWaldo
Copy link
Contributor Author

@WhitWaldo Thanks for jumping on this. Added a few minor comments. Could you also add a link to this reference API into the Related links section on the Crypto overview here https://docs.dapr.io/developing-applications/building-blocks/cryptography/cryptography-overview/#related-links

Done in #3952

Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

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

Thank you greatly for this contribution!! Approved

@msfussell msfussell added this to the 1.13 milestone Jan 23, 2024
@msfussell msfussell added P1 content/missing-information More information requested or needed labels Jan 23, 2024
@msfussell msfussell merged commit 3dc5218 into dapr:v1.12 Jan 23, 2024
6 of 7 checks passed
@WhitWaldo WhitWaldo deleted the crypto-reference branch January 23, 2024 12:19
@WhitWaldo WhitWaldo restored the crypto-reference branch January 23, 2024 20:44
@WhitWaldo WhitWaldo deleted the crypto-reference branch January 23, 2024 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cryptography content/missing-information More information requested or needed P1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing: The Crypto API is not documented in the API reference
3 participants