Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ For more examples and patterns, see [Use automations](/guides/use-automations).
Review the output of your custom automations to confirm they work as expected. Update your instructions to improve the results.
</Tip>

## Test your automation

Trigger a manual run before relying on a schedule or event to catch issues early. Manual runs use the automation's current configuration and appear in the run history alongside scheduled runs. See [Run an automation manually](/automations/manage#run-an-automation-manually) for the steps.

Open the run in the [Automations](https://app.mintlify.com/products/automations?tab=runs) page to review the prompt, the files the agent read or changed, and any pull request it opened. If the result isn't what you expected, edit the instructions and run it again.

<GitlabAutomationSetup />

## Edit a custom automation
Expand Down
4 changes: 4 additions & 0 deletions dashboard/network-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
- **Individual IP address**: Allow a single address, such as `203.0.113.7` or `2001:db8::1`.
- **CIDR range**: Allow a block of addresses, such as `10.0.0.0/8` or `2001:db8::/48`. Use CIDR notation to grant access to an entire office or VPN network without listing each address individually.

Both IPv4 and IPv6 addresses are supported.

Check warning on line 27 in dashboard/network-access.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/network-access.mdx#L27

In general, use active voice instead of passive voice ('are supported').

### Configure the IP allowlist

Expand All @@ -38,12 +38,16 @@
4. Repeat for each address or range you want to allow.
5. Enable the allowlist to begin enforcing it.

### Recover from a lockout

If every admin is locked out of the dashboard by the allowlist, contact [support@mintlify.com](mailto:support@mintlify.com) from an email address associated with your organization. Include your organization name and the IP address you need added. Mintlify's support team can add an address or disable the allowlist so you can regain access.

Check warning on line 43 in dashboard/network-access.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/network-access.mdx#L43

In general, use active voice instead of passive voice ('is locked').

## Session lifetimes

Control how long dashboard sessions stay valid before members must sign in again. You can set two independent limits:

- **Maximum session lifetime**: Members must sign in again once a session reaches this age, regardless of activity. When off, sessions have no maximum age.
- **Idle session timeout**: Members are signed out after this period of inactivity. When off, sessions time out after 14 days of inactivity.

Check warning on line 50 in dashboard/network-access.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/network-access.mdx#L50

In general, use active voice instead of passive voice ('are signed').

Both limits accept values from 5 minutes to 14 days.

Expand Down
6 changes: 6 additions & 0 deletions editor/tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ keywords: ["editor", "tutorial", "branch", "publish"]

This tutorial walks you through a complete content update using the editor. You'll create a branch, make a change, share a preview for review, and publish your changes.

## Prerequisites

- A Mintlify project connected to a GitHub, GitLab, or Bitbucket repository. See [Connect a repository](/deploy/github) for setup.
- An account with editor access to the project. If you can't sign in, ask an admin to invite you from the [Members](https://app.mintlify.com/settings/organization/members) page.
- Permission to open pull requests in the connected repository through your Git provider.

<Steps>
<Step title="Create a branch">
A branch is a temporary copy of your content. It's where you make your changes without affecting your live site. You can merge a branch into your live site or safely discard it if you choose not to make the changes.
Expand Down
8 changes: 8 additions & 0 deletions es/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u
Revisa la salida de tus automatizaciones personalizadas para confirmar que funcionan como esperabas. Actualiza tus instrucciones para mejorar los resultados.
</Tip>

<div id="test-your-automation">
## Prueba tu automatización
</div>

Ejecuta manualmente una automatización antes de depender de un calendario o un evento para detectar problemas con antelación. Las ejecuciones manuales utilizan la configuración actual de la automatización y aparecen en el historial de ejecuciones junto con las ejecuciones programadas. Consulta [Ejecutar una automatización manualmente](/es/automations/manage#run-an-automation-manually) para conocer los pasos.

Abre la ejecución en la página [Automatizaciones](https://app.mintlify.com/products/automations?tab=runs) para revisar el prompt, los archivos que el agente leyó o modificó, y cualquier pull request que haya abierto. Si el resultado no es el que esperabas, edita las instrucciones y vuelve a ejecutarla.

<GitlabAutomationSetup />

<div id="edit-a-custom-automation">
Expand Down
6 changes: 6 additions & 0 deletions es/dashboard/network-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ Se admiten direcciones IPv4 e IPv6.
4. Repite el proceso para cada dirección o rango que quieras permitir.
5. Activa la lista de IP permitidas para empezar a aplicarla.

<div id="recover-from-a-lockout">
### Recuperarse de un bloqueo
</div>

Si todos los administradores quedan bloqueados fuera del dashboard debido a la lista de IP permitidas, ponte en contacto con [support@mintlify.com](mailto:support@mintlify.com) desde una dirección de correo electrónico asociada a tu organización. Incluye el nombre de tu organización y la dirección IP que necesitas añadir. El equipo de soporte de Mintlify puede añadir una dirección o desactivar la lista de IP permitidas para que puedas recuperar el acceso.

<div id="session-lifetimes">
## Duración de las sesiones
</div>
Expand Down
8 changes: 8 additions & 0 deletions es/editor/tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ keywords: ["editor", "tutorial", "branch", "publish"]

Este tutorial le guía a través de una actualización completa de contenido usando el editor. Creará una branch, hará un cambio, compartirá una vista previa para su revisión y publicará sus cambios.

<div id="prerequisites">
## Requisitos previos
</div>

- Un proyecto de Mintlify conectado a un repositorio de GitHub, GitLab o Bitbucket. Consulte [Conectar un repositorio](/es/deploy/github) para la configuración.
- Una cuenta con acceso de editor al proyecto. Si no puede iniciar sesión, pida a un administrador que le invite desde la página [Members](https://app.mintlify.com/settings/organization/members).
- Permiso para abrir pull requests en el repositorio conectado a través de su proveedor de Git.

<Steps>
<Step title="Crear una branch">
Una branch es una copia temporal de su contenido. Es donde realiza sus cambios sin afectar a su sitio en producción. Puede fusionarla con su sitio en producción o descartarla de forma segura si decide no aplicar los cambios.
Expand Down
8 changes: 8 additions & 0 deletions es/integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ Crea un archivo `osano.js` en cualquier ubicación dentro de tu directorio de co

Reemplaza `OSANO_SCRIPT_URL` con la URL de tu script de Osano. La URL de tu script es el valor de `src` en el fragmento de código que genera Osano. La URL de tu script siempre comienza con `https://cmp.osano.com/` y termina con `/osano.js`.

Mintlify incluye automáticamente cualquier archivo `.js` de tu directorio de contenido en todas las páginas de tu sitio. No necesitas registrar `osano.js` en `docs.json`. Consulta [JavaScript personalizado](/es/customize/custom-scripts#custom-javascript) para más detalles.

<div id="verify-the-banner">
## Verificar el banner
</div>

Después de desplegar, abre tu sitio en una ventana privada o de incógnito y confirma que el banner de consentimiento de Osano aparece. Si no aparece, revisa la consola del navegador en busca de errores al cargar `osano.js` y confirma que la URL del script coincide con la de tu dashboard de Osano.

<div id="troubleshooting">
## Solución de problemas
</div>
Expand Down
9 changes: 9 additions & 0 deletions es/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que
- **Configura las automatizaciones.** Consulta [cómo habilitar una automatización](/es/automations/manage#enable-an-automation).
- **Instala los complementos de analíticas pertinentes.** Consulta la [lista de integraciones de analíticas](/es/integrations/analytics/overview).

<div id="pre-launch-validation">
## Validación previa al lanzamiento
</div>

- **Previsualiza el sitio en tu subdominio `.mintlify.site`.** Cada despliegue obtiene una URL alojada por Mintlify como `example.mintlify.site`. Recorre el sitio como lo haría un lector antes de apuntar tu dominio personalizado hacia él.
- **Ejecuta `mint broken-links` localmente.** Consulta la [referencia de la CLI](/es/cli/commands) para la configuración. Corrige los enlaces rotos que reporte.
- **Verifica que las redirecciones resuelvan a los destinos correctos.** Prueba cada ruta de origen contra tu URL de vista previa.
- **Confirma la autenticación y el acceso a nivel de página.** Si has configurado la autenticación, inicia sesión como un usuario de cada grupo de acceso para verificar que ven las páginas correctas.

<div id="go-live">
## Publicar el sitio
</div>
Expand Down
8 changes: 8 additions & 0 deletions fr/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ Pour plus d'exemples et de modèles, consultez [Utiliser les automatisations](/f
Vérifiez les résultats de vos automatisations personnalisées pour confirmer qu'elles fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats.
</Tip>

<div id="test-your-automation">
## Tester votre automatisation
</div>

Déclenchez une exécution manuelle avant de vous fier à un calendrier ou à un événement afin de détecter les problèmes en amont. Les exécutions manuelles utilisent la configuration actuelle de l'automatisation et apparaissent dans l'historique des exécutions aux côtés des exécutions planifiées. Consultez [Exécuter une automatisation manuellement](/fr/automations/manage#run-an-automation-manually) pour les étapes.

Ouvrez l'exécution dans la page [Automations](https://app.mintlify.com/products/automations?tab=runs) pour examiner le prompt, les fichiers que l'agent a lus ou modifiés, ainsi que toute pull request qu'il a ouverte. Si le résultat ne correspond pas à ce que vous attendiez, modifiez les instructions et relancez l'automatisation.

<GitlabAutomationSetup />

<div id="edit-a-custom-automation">
Expand Down
6 changes: 6 additions & 0 deletions fr/dashboard/network-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ Les adresses IPv4 et IPv6 sont toutes deux prises en charge.
4. Répétez pour chaque adresse ou plage que vous souhaitez autoriser.
5. Activez la liste d'autorisation pour commencer à l'appliquer.

<div id="recover-from-a-lockout">
### Récupérer l'accès après un verrouillage
</div>

Si tous les administrateurs sont verrouillés hors du dashboard par la liste d'autorisation, contactez [support@mintlify.com](mailto:support@mintlify.com) depuis une adresse e-mail associée à votre organisation. Indiquez le nom de votre organisation et l'adresse IP à ajouter. L'équipe de support de Mintlify peut ajouter une adresse ou désactiver la liste d'autorisation pour vous permettre de retrouver l'accès.

<div id="session-lifetimes">
## Durées de session
</div>
Expand Down
8 changes: 8 additions & 0 deletions fr/editor/tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ keywords: ["editor", "tutorial", "branch", "publish"]

Ce tutoriel vous guide à travers une mise à jour de contenu complète avec l'éditeur. Vous allez créer une branche, faire une modification, partager un aperçu pour relecture et publier vos modifications.

<div id="prerequisites">
## Prérequis
</div>

- Un projet Mintlify connecté à un dépôt GitHub, GitLab ou Bitbucket. Consultez [Connecter un dépôt](/fr/deploy/github) pour la configuration.
- Un compte disposant d'un accès éditeur au projet. Si vous ne parvenez pas à vous connecter, demandez à un administrateur de vous inviter depuis la page [Members](https://app.mintlify.com/settings/organization/members).
- L'autorisation d'ouvrir des pull requests dans le dépôt connecté via votre fournisseur Git.

<Steps>
<Step title="Créer une branche">
Une branche est une copie temporaire de votre contenu. C'est là que vous effectuez vos modifications sans affecter votre site en production. Vous pouvez fusionner une branche dans votre site en production ou l'abandonner en toute sécurité si vous choisissez de ne pas appliquer les modifications.
Expand Down
8 changes: 8 additions & 0 deletions fr/integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ Créez un fichier `osano.js` n'importe où dans votre répertoire de contenu ave

Remplacez `OSANO_SCRIPT_URL` par l’URL de votre script Osano. Cette URL de script correspond à la valeur `src` dans l’extrait de code généré par Osano. Votre URL de script commence toujours par `https://cmp.osano.com/` et se termine par `/osano.js`.

Mintlify inclut automatiquement tout fichier `.js` de votre répertoire de contenu sur chaque page de votre site. Vous n'avez pas besoin d'enregistrer `osano.js` dans `docs.json`. Consultez [JavaScript personnalisé](/fr/customize/custom-scripts#custom-javascript) pour plus de détails.

<div id="verify-the-banner">
## Vérifier la bannière
</div>

Après le déploiement, ouvrez votre site dans une fenêtre privée ou de navigation incognito et confirmez que la bannière de consentement Osano s'affiche. Si ce n'est pas le cas, vérifiez la console du navigateur pour repérer les erreurs de chargement de `osano.js` et confirmez que l'URL du script correspond à celle indiquée dans votre dashboard Osano.

<div id="troubleshooting">
## Dépannage
</div>
Expand Down
9 changes: 9 additions & 0 deletions fr/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ Cette liste récapitule les configurations à mettre en place et les paramètres
- **Configurez les automatisations.** Consultez [comment activer une automatisation](/fr/automations/manage#enable-an-automation).
- **Installez les modules d'analyse pertinents.** Consultez la [liste des intégrations d'analyse](/fr/integrations/analytics/overview).

<div id="pre-launch-validation">
## Validation avant lancement
</div>

- **Prévisualisez le site sur votre sous-domaine `.mintlify.site`.** Chaque déploiement bénéficie d'une URL hébergée par Mintlify, comme `example.mintlify.site`. Parcourez le site comme le ferait un lecteur avant d'y faire pointer votre domaine personnalisé.
- **Exécutez `mint broken-links` localement.** Consultez la [référence CLI](/fr/cli/commands) pour la configuration. Corrigez tous les liens rompus qu'il signale.
- **Vérifiez que les redirections mènent aux bonnes destinations.** Testez chaque chemin source par rapport à votre URL de prévisualisation.
- **Confirmez l'authentification et l'accès au niveau des pages.** Si vous avez configuré l'authentification, connectez-vous en tant qu'utilisateur de chaque groupe d'accès pour vérifier qu'ils voient les bonnes pages.

<div id="go-live">
## Mise en ligne
</div>
Expand Down
6 changes: 6 additions & 0 deletions integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ document.head.appendChild(script);

Replace `OSANO_SCRIPT_URL` with your Osano script URL. Your script URL is the `src` value in the code snippet that Osano generates. Your script URL always starts with `https://cmp.osano.com/` and ends with `/osano.js`.

Mintlify automatically includes any `.js` file inside your content directory on every page of your site. You don't need to register `osano.js` in `docs.json`. See [Custom JavaScript](/customize/custom-scripts#custom-javascript) for details.

## Verify the banner

After you deploy, open your site in a private or incognito window and confirm the Osano consent banner appears. If it doesn't, check the browser console for errors loading `osano.js` and confirm the script URL matches the one from your Osano dashboard.

## Troubleshooting

<Accordion
Expand Down
7 changes: 7 additions & 0 deletions migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ This is a comprehensive list of configurations to set up and settings to validat
- **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).

## Pre-launch validation

- **Preview the site on your `.mintlify.site` subdomain.** Every deployment gets a Mintlify-hosted URL like `example.mintlify.site`. Walk through the site as a reader would before you point your custom domain at it.
- **Run `mint broken-links` locally.** See the [CLI reference](/cli/commands) for setup. Fix any broken links it reports.
- **Verify redirects resolve to the correct destinations.** Test each source path against your preview URL.
- **Confirm authentication and page-level access.** If you set up authentication, sign in as a user in each access group to verify they see the right pages.

## Go live

- **Set your custom domain.** See the [custom domain guide](/customize/custom-domain).
8 changes: 8 additions & 0 deletions zh/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx';
审查你自定义自动化的输出,以确认它们按预期运行。更新你的指令以改进结果。
</Tip>

<div id="test-your-automation">
## 测试你的自动化
</div>

在依赖计划或事件触发之前先手动运行一次,可以尽早发现问题。手动运行会使用自动化的当前配置,并与计划运行一同显示在运行历史中。有关步骤,请参见[手动运行自动化](/zh/automations/manage#run-an-automation-manually)。

在 [Automations](https://app.mintlify.com/products/automations?tab=runs) 页面打开该次运行,查看提示词、agent 读取或更改的文件,以及它打开的任何拉取请求。如果结果与预期不符,请编辑指令并再次运行。

<GitlabAutomationSetup />

<div id="edit-a-custom-automation">
Expand Down
6 changes: 6 additions & 0 deletions zh/dashboard/network-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ IP 允许列表适用于你的 Mintlify dashboard 和编辑器,包括 SSO 和
4. 对你想要允许的每个地址或范围重复此操作。
5. 启用允许列表以开始执行。

<div id="recover-from-a-lockout">
### 从锁定中恢复
</div>

如果允许列表将所有管理员都锁定在 dashboard 之外,请使用与你组织关联的邮箱地址联系 [support@mintlify.com](mailto:support@mintlify.com)。请注明你的组织名称以及需要添加的 IP 地址。Mintlify 的支持团队可以添加该地址或禁用允许列表,以便你重新获得访问权限。

<div id="session-lifetimes">
## 会话有效期
</div>
Expand Down
8 changes: 8 additions & 0 deletions zh/editor/tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ keywords: ["编辑器", "教程", "分支", "发布"]

本教程将引导你使用编辑器完成一次完整的内容更新。你将创建一个分支、进行更改、分享预览以供审查,然后发布你的更改。

<div id="prerequisites">
## 前置条件
</div>

- 一个已连接到 GitHub、GitLab 或 Bitbucket 仓库的 Mintlify 项目。相关设置请参见[连接仓库](/zh/deploy/github)。
- 一个对项目具有编辑器访问权限的账户。如果你无法登录,请让管理员从[成员](https://app.mintlify.com/settings/organization/members)页面邀请你。
- 通过你的 Git 提供商在已连接的仓库中打开拉取请求的权限。

<Steps>
<Step title="Create a branch">
分支是你内容的临时副本。这是你在不影响线上站点的情况下进行更改的地方。你可以将分支合并到线上站点,或在选择不进行更改时安全地丢弃它。
Expand Down
8 changes: 8 additions & 0 deletions zh/integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ boost: 3

将 `OSANO_SCRIPT_URL` 替换为你的 Osano 脚本 URL。你的脚本 URL 是 Osano 生成的代码片段中 `src` 的值。你的脚本 URL 始终以 `https://cmp.osano.com/` 开头,并以 `/osano.js` 结尾。

Mintlify 会自动在你站点的每个页面上包含内容目录中的任何 `.js` 文件。你无需在 `docs.json` 中注册 `osano.js`。详情请参见[自定义 JavaScript](/zh/customize/custom-scripts#custom-javascript)。

<div id="verify-the-banner">
## 验证横幅
</div>

部署后,在隐私或无痕窗口中打开你的站点,确认 Osano 同意横幅是否出现。如果没有出现,请检查浏览器控制台是否有加载 `osano.js` 的错误,并确认脚本 URL 与 Osano 控制台中的一致。

<div id="troubleshooting">
## 故障排查
</div>
Expand Down
9 changes: 9 additions & 0 deletions zh/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ noindex: true
- **设置自动化。** 请参阅[如何启用自动化](/zh/automations/manage#enable-an-automation)。
- **安装相关分析插件。** 请参阅[分析集成列表](/zh/integrations/analytics/overview)。

<div id="pre-launch-validation">
## 上线前验证
</div>

- **在你的 `.mintlify.site` 子域上预览网站。** 每次部署都会获得一个 Mintlify 托管的 URL,例如 `example.mintlify.site`。在将自定义域名指向该网站之前,请以读者的视角浏览一遍。
- **在本地运行 `mint broken-links`。** 相关设置请参见 [CLI 参考](/zh/cli/commands)。修复它报告的任何失效链接。
- **验证重定向是否解析到正确的目标。** 针对你的预览 URL 测试每个源路径。
- **确认身份验证和页面级访问权限。** 如果你设置了身份验证,请以每个访问组中用户的身份登录,验证他们看到的是正确的页面。

<div id="go-live">
## 上线
</div>
Expand Down