Update reference docs to detail universal deletion policy#17445
Conversation
|
Hi there, I'm the Modular magician. I've detected the following information about your changes for commit b06d0a1: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
melinath
left a comment
melinath
left a comment
There was a problem hiding this comment.
I've left some general stylistic / organizational feedback. I haven't tried actually building the docs & viewing them - I can do that in another round.
|
|
||
| # Deletion behaviors | ||
| > [!NOTE] | ||
| > **Note:** The guidance on this page has largely been superceded by the implementation of [Universal Deletion Policy]({{< ref "/reference/universal-deletion-policy" >}}). Please refer to that page for details on how to modify the standard implementation of these fields going forward. Any new specifically `deletion_protection` fields should be handled on a case by case basis. |
There was a problem hiding this comment.
rather than having this comment, we should remove this page (or merge it with the deletion policy page as discussed in another comment)
| ##Supporting a custom value for deletion_policy | ||
| If implementing support for additional values such as "FORCE", the following steps can be taken. | ||
| A `pre_delete` constant should be added to the `custom_code` block in the resource YAML file, that performs the logic with the corresponding value. Example implemention here: [#1](https://github.com/GoogleCloudPlatform/magic-modules/FEATURE-BRANCH-universal-deletion-policy/mmv1/products/datastream/PrivateConnection.yaml#L44), [#2](https://github.com/GoogleCloudPlatform/magic-modules/blob/FEATURE-BRANCH-universal-deletion-policy/mmv1/templates/terraform/pre_delete/private_connection.go.tmpl) | ||
|
|
There was a problem hiding this comment.
Maybe it's obvious, but it's important that custom deletion policies should be specifically tested. Since the expectation is that the non-custom ones won't be usually.
|
Hi there, I'm the Modular magician. I've detected the following information about your changes for commit f70ff14: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
|
Hi there, I'm the Modular magician. I've detected the following information about your changes for commit 0dec976: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
|
@melinath This PR has been waiting for review for 3 weekdays. Please take a look! Use the label |
melinath
left a comment
melinath
left a comment
There was a problem hiding this comment.
Sorry for the delayed review! There are a couple major formatting issues and then some style nits. Could you follow https://github.com/GoogleCloudPlatform/magic-modules/tree/main/docs#readme to generate locally & confirm everything looks as you expect? LMK if you run into any problems.
| ``` | ||
| {{< /tab >}} | ||
| {{< tab "Handwritten" >}} | ||
| All handwritten resources need to support `deletion_policy` unless deemed incompatible. The following code snippets need to be included in a resource to support this. If following steps under [Add Resource]({{< ref "/develop/add-resource/#handwritten" >}}), they should be included in your resource go file already. |
There was a problem hiding this comment.
for the rest of this section - could you evaluate usages of "should" per https://developers.google.com/style/prescriptive-documentation#word-choice
|
@NickElliot, this PR is waiting for action from you. If no action is taken, this PR will be closed in 28 days. Please address any comments or change requests, or re-request review from a core reviewer if no action is required. This notification can be disabled with the |
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com> Co-authored-by: Nick Elliot <nickelliot@google.com>
|
Hi there, I'm the Modular magician. I've detected the following information about your changes for commit cd674a4: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
|
tested locally and it renders correctly, updated all usages of should and other minor rewordings |
c983bee
4 participants
Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.