Skip to content

DOCS-777: document undo pending deletion flow for encryption keys#266

Open
harrison-akeyless wants to merge 3 commits into
v1.0from
v1.0_docs-777-undo-pending-deletion
Open

DOCS-777: document undo pending deletion flow for encryption keys#266
harrison-akeyless wants to merge 3 commits into
v1.0from
v1.0_docs-777-undo-pending-deletion

Conversation

@harrison-akeyless
Copy link
Copy Markdown
Collaborator

@harrison-akeyless harrison-akeyless commented May 22, 2026

Summary

  • document the console flow to undo scheduled deletion for classic keys and DFC keys
  • clarify that changing State to Disabled removes Pending Deletion
  • note that users can re-enable the key afterward when active use should resume

Context

  • DOCS-777
  • ASM-18185

Validation

  • markdownlint passed on the edited page
  • cspell passed on the edited page
  • lychee passed on the edited page

Summary by CodeRabbit

  • Documentation
    • Updated encryption key management instructions with clarified deletion flows (immediate or scheduled) and revised guidance for undoing scheduled deletions.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 22, 2026

📝 Walkthrough

Walkthrough

This PR updates console instructions for managing encryption key deletion workflows. The delete key procedure and undo scheduled deletion steps are revised with new step descriptions, and obsolete prerequisite guidance is removed.

Changes

Encryption Key Management Documentation

Layer / File(s) Summary
Key Deletion and Undo Instructions
docs/Encryption & KMS/encryption-keys/index.md
Console instructions for deleting encryption keys are rewritten to describe selecting the trash icon and choosing between immediate deletion or scheduled deletion. Undo scheduled deletion instructions are updated to guide changing State to Disabled, then back to Enabled. Previous guidance about prerequisites and cancellation methods is removed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A key now deletes with a swish and a swash,
No need for the disable—just one final flash!
Undo with a toggle, from Disabled back bright,
These docs hop along making deletion just right. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The PR title clearly and specifically describes the primary change: documenting the undo pending deletion flow for encryption keys, which aligns perfectly with the main objectives and file changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_docs-777-undo-pending-deletion

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless marked this pull request as ready for review May 22, 2026 16:32
@harrison-akeyless harrison-akeyless changed the title docs: document undo pending deletion flow for encryption keys DOCS-777: document undo pending deletion flow for encryption keys May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant