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

KeyVault Documentation #3400

Merged
merged 5 commits into from
Oct 15, 2023
Merged

KeyVault Documentation #3400

merged 5 commits into from
Oct 15, 2023

Conversation

theunrepentantgeek
Copy link
Member

@theunrepentantgeek theunrepentantgeek commented Oct 10, 2023

What this PR does / why we need it:

Add documentation for the new KeyVault createMode options.

How does this PR make you feel:
gif

Prerequisites

If applicable:

  • this PR contains documentation

@theunrepentantgeek theunrepentantgeek self-assigned this Oct 11, 2023
@theunrepentantgeek theunrepentantgeek added the documentation Improvements or additions to documentation label Oct 11, 2023
@theunrepentantgeek theunrepentantgeek added this to the v2.4.0 milestone Oct 11, 2023
Copy link
Collaborator

@super-harsh super-harsh left a comment

Choose a reason for hiding this comment

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

Looks good. I think we should also do something about adding the documentation for new CreateMode options in API docs


* `createOrRecover` - create a new key KeyVault. If an existing soft-deleted KeyVault has the same name, recover and reuse it.

* `purgeThenCreate` - If an existing soft-deleted KeyVault has the same name, purge it first; then create a brand new one. **Dangerous**
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd suggest to elaborate more about the danger here and remove Dangerous

Copy link
Member Author

Choose a reason for hiding this comment

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

There's elaboration about the dangers in the next paragraph. I've made that more explicit.

@theunrepentantgeek theunrepentantgeek merged commit dafb526 into main Oct 15, 2023
9 checks passed
@theunrepentantgeek theunrepentantgeek deleted the doc/keyvaults branch October 15, 2023 20:06
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
Development

Successfully merging this pull request may close these issues.

2 participants