From e78589bbc98ab1fbdd6d683504a250d6182d4c89 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 22 Sep 2026 10:11:02 +0000 Subject: [PATCH 1/2] docs: close reader gaps on CI, go-live checklist, and deployments --- deploy/ci.mdx | 2 +- deploy/deployments.mdx | 8 ++++++-- migration-services/go-live-checklist.mdx | 2 ++ 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/deploy/ci.mdx b/deploy/ci.mdx index 7c5be74c46..c8b5aa5266 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "CI checks" -description: "Automate documentation quality checks in your CI/CD pipeline with broken link detection, linting, grammar validation, and build previews." +description: "Automate documentation quality checks in your CI/CD pipeline with broken link detection and Vale prose linting." keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index c188e8a0a2..49f76b43f8 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -7,9 +7,13 @@ boost: 3 Your documentation site automatically deploys when you push changes to your connected repository. If your repository is on GitHub, you must install and connect the Mintlify GitHub App. If your repository is on GitLab or Bitbucket, see [GitLab](/deploy/gitlab) or [Bitbucket](/deploy/bitbucket) for connection setup. -If your latest changes are not appearing on your live site and your repository is on GitHub, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. For more information, see [GitHub troubleshooting](/deploy/github#troubleshooting). +If your latest changes are not appearing on your live site, work through these checks in order: -If your repository is connected, but changes are still not deploying, manually trigger a deployment from your dashboard. +1. Open the [activity](https://app.mintlify.com/activity) page in your dashboard and confirm a build was triggered for your latest commit. If the build failed, expand it to see the error. +2. Verify that you pushed to the branch configured as your deployment branch in [Git Settings](https://app.mintlify.com/settings/deployment/git-settings). Pushes to other branches don't deploy. +3. If your repository is on GitHub, confirm the GitHub account or organization that owns the docs repository still has the Mintlify GitHub App installed. See [GitHub troubleshooting](/deploy/github#troubleshooting) for the full reset flow. + +If your repository is connected and the deployment branch is correct but no build was triggered, manually trigger a deployment from your dashboard. ## Manually trigger a deployment diff --git a/migration-services/go-live-checklist.mdx b/migration-services/go-live-checklist.mdx index e5fc696d06..cd44a657f2 100644 --- a/migration-services/go-live-checklist.mdx +++ b/migration-services/go-live-checklist.mdx @@ -22,12 +22,14 @@ Use this checklist to set up configurations and validate settings before going l - Review your Mintlify site access. - If you restrict your site to certain users, set up [authentication](/deploy/authentication-setup). - Review which groups have access to pages and which pages are public. + - **Test authenticated access before launch.** Sign in as a test user in each user group and confirm they can only reach the pages you expect. Verify that a signed-out visitor is redirected or blocked from private pages. ## 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 information is up-to-date.** Are all recent content changes reflected on your site? - If required, set up [redirects](/create/redirects). + - **Test your redirects before launch.** Redirects apply on [preview deployments](/deploy/preview-deployments), so open a preview and visit each source path to confirm it lands on the expected destination. You can also test locally by running `mint dev` and visiting the source paths in your browser. - **Configure SEO settings.** Set your site description, meta tags, and indexing preferences in `docs.json`. See [SEO and search settings](/organize/settings-seo). - **Review page-level SEO.** Configure meta tags, Open Graph properties, and canonical URLs where needed. See [SEO](/optimize/seo). From 18b61a43bf1f5fd526ab5545c124fa43d30ed8bc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 22 Sep 2026 10:14:34 +0000 Subject: [PATCH 2/2] docs: translate CI, deployments, and go-live checklist updates (es, fr, zh) --- es/deploy/ci.mdx | 2 +- es/deploy/deployments.mdx | 8 ++++++-- es/migration-services/go-live-checklist.mdx | 2 ++ fr/deploy/ci.mdx | 2 +- fr/deploy/deployments.mdx | 8 ++++++-- fr/migration-services/go-live-checklist.mdx | 2 ++ zh/deploy/ci.mdx | 2 +- zh/deploy/deployments.mdx | 8 ++++++-- zh/migration-services/go-live-checklist.mdx | 2 ++ 9 files changed, 27 insertions(+), 9 deletions(-) diff --git a/es/deploy/ci.mdx b/es/deploy/ci.mdx index 69c923270c..ec699fc88b 100644 --- a/es/deploy/ci.mdx +++ b/es/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "Verificaciones de CI" -description: "Automatiza verificaciones de calidad de la documentación en tu pipeline de CI/CD con detección de enlaces rotos, linting y vistas previas de build." +description: "Automatiza verificaciones de calidad de la documentación en tu pipeline de CI/CD con detección de enlaces rotos y linting de prosa con Vale." keywords: ["integración continua", "CI/CD", "verificaciones", "Vale", "linter"] --- diff --git a/es/deploy/deployments.mdx b/es/deploy/deployments.mdx index 59147ac374..f005f614ee 100644 --- a/es/deploy/deployments.mdx +++ b/es/deploy/deployments.mdx @@ -7,9 +7,13 @@ boost: 3 Tu sitio de documentación se implementa automáticamente cuando haces push de cambios a tu repositorio conectado. Si tu repositorio está en GitHub, debes instalar y conectar la Aplicación de GitHub de Mintlify. Si tu repositorio está en GitLab o Bitbucket, consulta [GitLab](/es/deploy/gitlab) o [Bitbucket](/es/deploy/bitbucket) para configurar la conexión. -Si tus últimos cambios no aparecen en tu sitio en producción y tu repositorio está en GitHub, primero verifica que la cuenta u organización de GitHub propietaria de tu repositorio de documentación tenga instalada la Aplicación de GitHub. Consulta [Solución de problemas de GitHub](/es/deploy/github#troubleshooting) para más información. +Si tus últimos cambios no aparecen en tu sitio en producción, revisa estas comprobaciones en orden: -Si tu repositorio está conectado, pero los cambios aún no se implementan, activa manualmente una implementación desde tu dashboard. +1. Abre la página de [actividad](https://app.mintlify.com/activity) en tu dashboard y confirma que se activó una compilación para tu confirmación más reciente. Si la compilación falló, expándela para ver el error. +2. Verifica que hiciste push a la rama configurada como tu rama de implementación en [Configuración de Git](https://app.mintlify.com/settings/deployment/git-settings). Los push a otras ramas no se implementan. +3. Si tu repositorio está en GitHub, confirma que la cuenta u organización de GitHub propietaria del repositorio de documentación todavía tiene instalada la Aplicación de GitHub de Mintlify. Consulta [Solución de problemas de GitHub](/es/deploy/github#troubleshooting) para el proceso completo de restablecimiento. + +Si tu repositorio está conectado y la rama de implementación es correcta pero no se activó ninguna compilación, activa manualmente una implementación desde tu dashboard.
## Activar una implementación manualmente diff --git a/es/migration-services/go-live-checklist.mdx b/es/migration-services/go-live-checklist.mdx index c512d9ffea..337c0aa47e 100644 --- a/es/migration-services/go-live-checklist.mdx +++ b/es/migration-services/go-live-checklist.mdx @@ -26,6 +26,7 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que - Revisa el acceso a tu sitio de Mintlify. - Si restringes tu sitio a determinados usuarios, configura la [autenticación](/es/deploy/authentication-setup). - Revisa qué grupos tienen acceso a las páginas y qué páginas son públicas. + - **Prueba el acceso autenticado antes del lanzamiento.** Inicia sesión como usuario de prueba en cada grupo de usuarios y confirma que solo pueden acceder a las páginas que esperas. Verifica que un visitante sin sesión iniciada sea redirigido o bloqueado de las páginas privadas.
## Validación del contenido @@ -34,6 +35,7 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que - **Verifica tu arquitectura de la información.** ¿Es esta la estructura de navegación adecuada? ¿Faltan secciones? Consulta [tipos de contenido](/es/guides/content-types) como referencia. - **Verifica que tu información esté actualizada.** ¿Se reflejan todos los cambios de contenido recientes en tu sitio? - Si es necesario, configura [redirecciones](/es/create/redirects). + - **Prueba tus redirecciones antes del lanzamiento.** Las redirecciones se aplican en las [implementaciones de vista previa](/es/deploy/preview-deployments), así que abre una vista previa y visita cada ruta de origen para confirmar que aterriza en el destino esperado. También puedes probar localmente ejecutando `mint dev` y visitando las rutas de origen en tu navegador. - **Configura los ajustes de SEO.** Define la descripción del sitio, las metaetiquetas y las preferencias de indexación en `docs.json`. Consulta [Ajustes de SEO y búsqueda](/es/organize/settings-seo). - **Revisa el SEO a nivel de página.** Configura las metaetiquetas, las propiedades de Open Graph y las URL canónicas cuando sea necesario. Consulta [SEO](/es/optimize/seo). diff --git a/fr/deploy/ci.mdx b/fr/deploy/ci.mdx index e17d3cc73a..a74a12ca65 100644 --- a/fr/deploy/ci.mdx +++ b/fr/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "Vérifications CI" -description: "Automatisez les contrôles qualité de la documentation dans votre pipeline CI/CD avec détection de liens brisés, linting, grammaire et aperçus de build." +description: "Automatisez les contrôles qualité de la documentation dans votre pipeline CI/CD avec détection de liens brisés et linting de prose avec Vale." keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- diff --git a/fr/deploy/deployments.mdx b/fr/deploy/deployments.mdx index 82bcdd4397..bf8b519644 100644 --- a/fr/deploy/deployments.mdx +++ b/fr/deploy/deployments.mdx @@ -7,9 +7,13 @@ boost: 3 Votre site de documentation est automatiquement déployé lorsque vous poussez des modifications vers votre référentiel connecté. Si votre référentiel se trouve sur GitHub, vous devez installer et connecter la GitHub App Mintlify. Si votre référentiel se trouve sur GitLab ou Bitbucket, consultez [GitLab](/fr/deploy/gitlab) ou [Bitbucket](/fr/deploy/bitbucket) pour la configuration de la connexion. -Si vos dernières modifications n’apparaissent pas sur votre site en production et que votre référentiel se trouve sur GitHub, vérifiez d’abord que le compte ou l’organisation GitHub propriétaire de votre référentiel de documentation a bien installé la GitHub App. Pour en savoir plus, consultez [Dépannage GitHub](/fr/deploy/github#troubleshooting). +Si vos dernières modifications n’apparaissent pas sur votre site en production, effectuez ces vérifications dans l’ordre : -Si votre référentiel est connecté, mais que les modifications ne se déploient toujours pas, déclenchez manuellement un déploiement depuis votre Dashboard. +1. Ouvrez la page [activité](https://app.mintlify.com/activity) dans votre Dashboard et confirmez qu’une compilation a été déclenchée pour votre dernier commit. Si la compilation a échoué, développez-la pour voir l’erreur. +2. Vérifiez que vous avez poussé vers la branche configurée comme branche de déploiement dans les [Paramètres Git](https://app.mintlify.com/settings/deployment/git-settings). Les pushes vers d’autres branches ne déclenchent pas de déploiement. +3. Si votre référentiel se trouve sur GitHub, confirmez que le compte ou l’organisation GitHub propriétaire du référentiel de documentation a toujours la GitHub App Mintlify installée. Consultez [Dépannage GitHub](/fr/deploy/github#troubleshooting) pour la procédure complète de réinitialisation. + +Si votre référentiel est connecté et que la branche de déploiement est correcte mais qu’aucune compilation n’a été déclenchée, déclenchez manuellement un déploiement depuis votre Dashboard.
## Déclencher manuellement un déploiement diff --git a/fr/migration-services/go-live-checklist.mdx b/fr/migration-services/go-live-checklist.mdx index e5faf77085..ae0f4f6ac2 100644 --- a/fr/migration-services/go-live-checklist.mdx +++ b/fr/migration-services/go-live-checklist.mdx @@ -26,6 +26,7 @@ Cette liste récapitule les configurations à mettre en place et les paramètres - Vérifiez l'accès à votre site Mintlify. - Si vous limitez l'accès à votre site à certains utilisateurs, configurez l'[authentification](/fr/deploy/authentication-setup). - Vérifiez quels groupes peuvent accéder aux pages et quelles pages sont publiques. + - **Testez l'accès authentifié avant le lancement.** Connectez-vous en tant qu'utilisateur test dans chaque groupe d'utilisateurs et confirmez qu'ils ne peuvent atteindre que les pages attendues. Vérifiez qu'un visiteur non connecté est redirigé ou bloqué des pages privées.
## Validation du contenu @@ -34,6 +35,7 @@ Cette liste récapitule les configurations à mettre en place et les paramètres - **Vérifiez votre architecture de l'information.** La structure de navigation est-elle adaptée ? Certaines sections manquent-elles ? Consultez les [types de contenu](/fr/guides/content-types) pour référence. - **Vérifiez que vos informations sont à jour.** Toutes les modifications récentes du contenu apparaissent-elles sur votre site ? - Si nécessaire, configurez les [redirections](/fr/create/redirects). + - **Testez vos redirections avant le lancement.** Les redirections s'appliquent sur les [déploiements d'aperçu](/fr/deploy/preview-deployments) : ouvrez un aperçu et visitez chaque chemin source pour confirmer qu'il aboutit à la destination attendue. Vous pouvez aussi tester localement en exécutant `mint dev` et en visitant les chemins sources dans votre navigateur. - **Configurez les paramètres SEO.** Définissez la description de votre site, les balises meta et les préférences d'indexation dans `docs.json`. Consultez les [paramètres SEO et de recherche](/fr/organize/settings-seo). - **Vérifiez le SEO au niveau des pages.** Configurez les balises meta, les propriétés Open Graph et les URL canoniques si nécessaire. Consultez la page [SEO](/fr/optimize/seo). diff --git a/zh/deploy/ci.mdx b/zh/deploy/ci.mdx index 5d52500aa2..ad53f98d20 100644 --- a/zh/deploy/ci.mdx +++ b/zh/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "CI 检查" -description: "在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。" +description: "在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测和 Vale 文本检查。" keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- diff --git a/zh/deploy/deployments.mdx b/zh/deploy/deployments.mdx index 1538a5d54e..071d8de221 100644 --- a/zh/deploy/deployments.mdx +++ b/zh/deploy/deployments.mdx @@ -7,9 +7,13 @@ boost: 3 当你将更改推送到已连接的存储库时，你的文档站点会自动部署。如果你的存储库位于 GitHub 上，你必须安装并连接 Mintlify GitHub 应用。如果你的存储库位于 GitLab 或 Bitbucket 上，请参阅 [GitLab](/zh/deploy/gitlab) 或 [Bitbucket](/zh/deploy/bitbucket) 了解连接设置。 -如果你的最新更改没有显示在在线站点上，且你的存储库位于 GitHub 上，首先检查拥有你文档存储库的 GitHub 账户或组织是否已安装该 GitHub 应用。参见 [GitHub 故障排查](/zh/deploy/github#troubleshooting) 以获取更多信息。 +如果你的最新更改没有显示在在线站点上，请按顺序检查以下项： -如果你的存储库已连接，但更改仍未部署，请在控制台手动触发一次部署。 +1. 在控制台中打开[活动](https://app.mintlify.com/activity)页面，确认已针对你最近的提交触发了构建。如果构建失败，请展开它以查看错误信息。 +2. 确认你推送到了在 [Git 设置](https://app.mintlify.com/settings/deployment/git-settings) 中配置为部署分支的分支。推送到其他分支不会触发部署。 +3. 如果你的存储库位于 GitHub 上，请确认拥有文档存储库的 GitHub 账户或组织仍然安装了 Mintlify GitHub 应用。参见 [GitHub 故障排查](/zh/deploy/github#troubleshooting) 了解完整的重置流程。 + +如果你的存储库已连接、部署分支正确，但仍未触发任何构建，请在控制台手动触发一次部署。
## 手动触发部署 diff --git a/zh/migration-services/go-live-checklist.mdx b/zh/migration-services/go-live-checklist.mdx index 1a9e966f2b..5f4e38224e 100644 --- a/zh/migration-services/go-live-checklist.mdx +++ b/zh/migration-services/go-live-checklist.mdx @@ -26,6 +26,7 @@ noindex: true - 查看 Mintlify 网站的访问权限。 - 如果将网站限制为特定用户，请设置[身份验证](/zh/deploy/authentication-setup)。 - 查看哪些群组可以访问页面，以及哪些页面是公开的。 + - **在上线前测试已认证的访问权限。** 使用每个用户组中的测试账号登录，确认他们只能访问预期的页面。验证未登录访客会被重定向或被拦截，无法访问私有页面。
## 内容验证 @@ -34,6 +35,7 @@ noindex: true - **验证信息架构。** 这是合适的导航结构吗？是否缺少某些部分？请参阅[内容类型](/zh/guides/content-types)作为参考。 - **验证信息是否为最新。** 网站是否反映了所有近期的内容更改？ - 如有需要，请设置[重定向](/zh/create/redirects)。 + - **在上线前测试重定向。** 重定向会在[预览部署](/zh/deploy/preview-deployments)中生效，因此请打开一个预览并访问每个源路径，确认其跳转到预期的目标。你也可以在本地运行 `mint dev`，并在浏览器中访问源路径进行测试。 - **配置 SEO 设置。** 在 `docs.json` 中设置网站描述、元标签和索引偏好设置。请参阅 [SEO 和搜索设置](/zh/organize/settings-seo)。 - **检查页面级 SEO。** 根据需要配置元标签、Open Graph 属性和规范 URL。请参阅 [SEO](/zh/optimize/seo)。