diff --git a/migration-services/go-live-checklist.mdx b/migration-services/go-live-checklist.mdx new file mode 100644 index 0000000000..5d11005daf --- /dev/null +++ b/migration-services/go-live-checklist.mdx @@ -0,0 +1,42 @@ +--- +title: "Go-live checklist" +description: "Verify your Mintlify site is ready before going live." +noindex: true +--- + +This is a comprehensive list of configurations to set up and settings to validate before going live. Some steps may not apply to your specific deployment and are fine to skip. + +## Core setup + +- **Connect your docs repo to Mintlify.** Install the [GitHub app](/deploy/github) or connect your [GitLab repository](/deploy/gitlab). + - If you already installed the GitHub app, uninstall and re-install it. To verify this step, make a change to your documentation locally, push to GitHub, and check that your site redeploys. + - If your documentation lives in more than one repository, configure a [multi-repository structure](/deploy/multi-repo) to build your site from multiple repos. If all of your content is in a single repository, skip this step. +- **Invite team members.** Invite anyone who needs access from the [Members](https://app.mintlify.com/settings/organization/members) page in your dashboard. See [Roles](/dashboard/roles) for more information. + +## Security + +- Review who can access your dashboard. + - Set up [dashboard SSO](/dashboard/sso) for your team to access your dashboard and editor. + - Set up [dashboard access policies](/dashboard/network-access). + - Set up [SCIM provisioning](/dashboard/scim). +- Review your Mintlify site access. + - If your site is restricted to certain users, set up [authentication](/deploy/authentication-setup). + - Review which groups have access to pages and which pages are public. + +## Content validation + +- **Verify your information architecture.** Is this the proper navigation structure? Are there missing sections? See [content types](/guides/content-types) for reference. +- **Verify your content.** Has all of your content been ported into Mintlify correctly? +- If required, set up [redirects](/create/redirects). + +## Dashboard features + +- **Turn on and configure the assistant.** See [Configure the assistant](/assistant/configure) and [Add assistant skills](/assistant/skills). +- **Enable add-ons.** Go to the [Add-ons](https://app.mintlify.com/settings/deployment/addons) page in your dashboard. Enable relevant add-ons such as agent feedback, [CI checks](/deploy/ci), related topics, and more. +- **Set up the Slack agent.** This lets you make changes to your content directly in Slack. See [Add the agent to Slack](/agent/slack#add-the-agent-to-slack). +- **Set up automations.** See [how to enable an automation](/automations/manage#enable-an-automation). +- **Install relevant analytics plugins.** See the [list of analytics integrations](/integrations/analytics/overview). + +## Go live + +- **Set your custom domain.** See the [custom domain guide](/customize/custom-domain).