|
| 1 | +--- |
| 2 | +title: "Custom plan migrations" |
| 3 | +description: "Overview of the full-service migration process, delivery timelines, and our quality assurance approach for Custom plans." |
| 4 | +--- |
| 5 | + |
| 6 | +You can choose our migration services to transfer your documentation to Mintlify. This guide covers the migration process, delivery timelines, and our quality assurance approach. |
| 7 | + |
| 8 | +## What to expect for your migration |
| 9 | + |
| 10 | +A migration is a point-in-time transfer of your documentation that requires a code freeze. We migrate your documentation, API reference pages, branding (logos, colors, and fonts), and navigation structure. Migration services also include design or information architecture consultation and custom component development such as landing pages or custom integrations. |
| 11 | + |
| 12 | +Your migration includes a staging link to review progress and a 7-day feedback window after delivery to address any issues with content, assets, or branding. |
| 13 | + |
| 14 | +## Migration process |
| 15 | + |
| 16 | +The migration process is highly collaborative. We work closely with your team to implement custom solutions and builds that work for you! |
| 17 | + |
| 18 | +<Steps> |
| 19 | +<Step title="Submit the migration form"> |
| 20 | +Submit the [migration form](https://mintlify.typeform.com/pro-migrations). |
| 21 | + |
| 22 | +Provide your documentation source, brand assets (logos, color codes, fonts), OpenAPI specs, go-live date, and preferred delivery method (GitHub PR or zip file). |
| 23 | +</Step> |
| 24 | + |
| 25 | +<Step title="Kick-off call"> |
| 26 | +We review your submission and lead a kick-off call with our migration team to walk through your current setup, understand any limitations, and address any questions your team might have. |
| 27 | +</Step> |
| 28 | + |
| 29 | +<Step title="Receive scoping and timeline (1-2 business days)"> |
| 30 | +We review and analyze the context from the call and provide an estimated delivery timeline within 24-48 hours. We'll flag any custom components or areas of your migration that need discussion. |
| 31 | +</Step> |
| 32 | + |
| 33 | +<Step title="Review progress during the migration"> |
| 34 | +We start the migration and share a staging link so you can monitor progress in real-time. |
| 35 | +</Step> |
| 36 | + |
| 37 | +<Step title="Receive final delivery"> |
| 38 | +We deliver your migration via GitHub PR or zip file based on your preference. |
| 39 | +</Step> |
| 40 | + |
| 41 | +<Step title="Feedback window (seven business days)"> |
| 42 | +Submit any feedback on content, assets, or branding. We address all in-scope issues within the same timeframe. |
| 43 | +</Step> |
| 44 | + |
| 45 | +<Step title="Go-live support"> |
| 46 | +We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain. |
| 47 | +</Step> |
| 48 | +</Steps> |
| 49 | + |
| 50 | +## Quality assurance |
| 51 | + |
| 52 | +We work with vetted third-party vendors and conduct an internal quality audit before delivery. Here's what we check for: |
| 53 | + |
| 54 | +<Card title="Content completeness" icon="file-check"> |
| 55 | +- All documentation from your source has been migrated. |
| 56 | +- Content is properly formatted with Mintlify components. |
| 57 | +- Navigation structure matches your specifications. |
| 58 | +</Card> |
| 59 | + |
| 60 | +<Card title="Visual elements" icon="palette"> |
| 61 | +- Images and videos display correctly. |
| 62 | +- Custom fonts are applied throughout. |
| 63 | +- Light and dark mode logos are used appropriately. |
| 64 | +- Color schemes meet contrast requirements in both modes. |
| 65 | +</Card> |
| 66 | + |
| 67 | +<Card title="Functionality" icon="rocket"> |
| 68 | +- All links work correctly (no broken links). |
| 69 | +- Table of contents renders properly. |
| 70 | +- React components function as expected. |
| 71 | +- No performance issues. |
| 72 | +</Card> |
| 73 | + |
| 74 | +## After your migration |
| 75 | + |
| 76 | +Once we deliver your migration, you'll need to complete the following steps to launch your documentation: |
| 77 | + |
| 78 | +1. [Connect your GitHub repository and get setup](/quickstart#install-the-github-app). |
| 79 | +2. [Set up redirects, if required](/create/redirects). |
| 80 | +3. [Configure your custom domain](/customize/custom-domain). |
| 81 | +4. **Test before going live** - Before switching over from your old documentation: |
| 82 | + - Review all pages on your staging link. |
| 83 | + - Test navigation and search functionality. |
| 84 | + - Verify all images and videos load correctly. |
| 85 | + - Check that code blocks render properly. |
| 86 | + - Test on mobile and desktop. |
| 87 | +5. **Launch!** Your documentation is ready to go live! |
| 88 | + |
| 89 | +<Note> |
| 90 | +**Need help? ** Our migration team is available to guide you through these steps. Reach out via your dedicated Slack channel or [[email protected]](mailto:[email protected]). |
| 91 | +</Note> |
| 92 | + |
| 93 | +## Frequently asked questions |
| 94 | + |
| 95 | +<AccordionGroup> |
| 96 | +<Accordion title="How long does a migration take?"> |
| 97 | +We typically deliver migrations within 2-6 weeks, depending on complexity. You'll receive a specific timeline after the kick-off call. |
| 98 | +</Accordion> |
| 99 | + |
| 100 | +<Accordion title="Can I request changes after delivery?"> |
| 101 | +Yes. You have a 7-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same timeframe and work with you right until you are ready to go live. |
| 102 | +</Accordion> |
| 103 | + |
| 104 | +<Accordion title="What do I need to do after the migration is complete?"> |
| 105 | +The migration transfers your content, but you'll need to: |
| 106 | +- Connect your documentation repository to your Mintlify dashboard. |
| 107 | +- Set up redirects from your old documentation URLs. |
| 108 | +- Configure your custom domain. |
| 109 | + |
| 110 | +We provide step-by-step documentation and support for each of these steps. |
| 111 | +</Accordion> |
| 112 | + |
| 113 | +<Accordion title="Can I customize the navigation structure?"> |
| 114 | +Yes. You can provide a custom information architecture and we will implement it. We also work with you on custom component development if that is needed and supported by the platform. |
| 115 | +</Accordion> |
| 116 | + |
| 117 | +<Accordion title="What happens if my documentation changes during the migration?"> |
| 118 | +Since migrations require a code freeze, any changes made to your source documentation after submission won't be included. We recommend completing all updates before starting the migration. |
| 119 | + |
| 120 | +If this is not possible, our team will work with you to set short sprints to migrate certain sections or reserve dedicated time post the first sprint to migrate the delta changes made during the migration. |
| 121 | +</Accordion> |
| 122 | +</AccordionGroup> |
0 commit comments