Skip to content
Docs-as-Code Primer
Esc
navigateopen⌘Jpreview
On this page

Migration guide: [Version / feature name]

> A migration guide tells someone what changed, why, and exactly what they need to do. If they skip the window, they break.

Migration guide: [Version / feature name]

A migration guide tells someone what changed, why, and exactly what they need to do. If they skip the window, they break.

Overview

From
To
Effective date
Deadline
Action required Yes / No

Why

Brief context on why this change exists.

What changed

Before After

Migration steps

If you are [role / persona]

  1. Before the deadline: [prepare / review / test]
  2. During the window: [exact actions]
  3. After the deadline: [confirm / verify]

Rollback

If something goes wrong:

Verification

  • How to confirm migration succeeded
  • Health check command or dashboard to watch

Timeline

Date Milestone
Announcement
Migration window opens
Migration window closes
Old version decommissioned

Was this page helpful?