diff --git a/es/api-playground/troubleshooting.mdx b/es/api-playground/troubleshooting.mdx index b23b954a7..c2945eb78 100644 --- a/es/api-playground/troubleshooting.mdx +++ b/es/api-playground/troubleshooting.mdx @@ -7,32 +7,33 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c - En este caso, es probable que Mintlify no pueda encontrar tu documento de OpenAPI + En este escenario, es probable que Mintlify no pueda encontrar tu documento de OpenAPI o que tu documento de OpenAPI no sea válido. - Ejecutar `mint dev` de forma local debería revelar algunos de estos problemas. + Ejecutar `mint dev` localmente debería revelar algunos de estos problemas. - Para comprobar que tu documento de OpenAPI supere la validación: + Para comprobar que tu documento de OpenAPI supera la validación: 1. Visita [este validador](https://editor.swagger.io/) 2. Cambia a la pestaña "Validate text" 3. Pega tu documento de OpenAPI 4. Haz clic en "Validate it!" - Si el cuadro de texto que aparece abajo tiene un borde verde, tu documento ha pasado la validación. - Este es exactamente el mismo paquete de validación que usa Mintlify para validar documentos de OpenAPI, así que si tu documento - pasa la validación aquí, es muy probable que el problema esté en otra parte. + Si el cuadro de texto que aparece abajo tiene un borde verde, tu documento ha superado la validación. + Este es exactamente el mismo paquete de validación que utiliza Mintlify para validar documentos de OpenAPI, así que si tu documento + pasa la validación aquí, hay muchas probabilidades de que el problema esté en otra parte. Además, Mintlify no es compatible con OpenAPI 2.0. Si tu documento usa esta versión de la especificación, podrías encontrarte con este problema. Puedes convertir tu documento en [editor.swagger.io](https://editor.swagger.io/) (en Edit > Convert to OpenAPI 3): - ![](/images/convert-oas-3.png) + ![Captura de pantalla de Swagger Editor con el menú Edit desplegado y el elemento de menú "Convert to OpenAPI 3" resaltado.](/images/convert-oas-3.png) - - Esto suele deberse a un campo `openapi` mal escrito en la metadata de la página. Asegúrate de que el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta del documento de OpenAPI. + + Esto suele deberse a un campo `openapi` mal escrito en la metadata de la página. Asegúrate de que + el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta del documento de OpenAPI. Aquí tienes un ejemplo de cómo puede salir mal: @@ -50,7 +51,7 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c Observa que la ruta en el campo `openapi` tiene una barra al final, mientras que la ruta en el documento de OpenAPI no la tiene. - Otro problema común es un nombre de archivo mal escrito. Si especificas un documento de OpenAPI en particular en el campo `openapi`, asegúrate de que el nombre del archivo sea correcto. Por ejemplo, si tienes dos documentos de OpenAPI, `openapi/v1.json` y `openapi/v2.json`, tu metadata podría verse así: + Otro problema común es un nombre de archivo mal escrito. Si especificas un documento de OpenAPI en particular en el campo `openapi`, asegúrate de que el nombre del archivo sea correcto. Por ejemplo, si tienes dos documentos de OpenAPI `openapi/v1.json` y `openapi/v2.json`, tu metadata podría verse así: ```mdx api-reference/v1/users/get-user.mdx --- @@ -60,15 +61,15 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c - Si tienes un domain personalizado configurado, esto podría deberse a tu proxy inverso. De forma predeterminada, las solicitudes realizadas a través del área de pruebas de la API comienzan con una solicitud `POST` a la ruta `/_mintlify/api/request` en el sitio de documentación. Si tu proxy inverso está configurado para permitir únicamente solicitudes `GET`, todas estas solicitudes fallarán. Para solucionarlo, configura tu proxy inverso para permitir solicitudes `POST` a la ruta `/_mintlify/api/request`. + Si tienes un domain personalizado configurado, esto podría deberse a un problema con tu proxy inverso. De forma predeterminada, las solicitudes realizadas a través del área de pruebas de la API comienzan con una solicitud `POST` a la ruta `/_mintlify/api/request` en el sitio de documentación. Si tu proxy inverso está configurado para permitir únicamente solicitudes `GET`, entonces todas estas solicitudes fallarán. Para solucionarlo, configura tu proxy inverso para permitir solicitudes `POST` a la ruta `/_mintlify/api/request`. - Como alternativa, si tu proxy inverso impide aceptar solicitudes `POST`, puedes configurar Mintlify para enviar solicitudes directamente a tu backend con la opción `api.playground.proxy` en `docs.json`, como se describe en la [documentación de configuración](/es/organize/settings#param-proxy). Al usar esta configuración, deberás configurar CORS en tu servidor, ya que las solicitudes vendrán directamente desde los navegadores de los usuarios en lugar de pasar por tu proxy. + Como alternativa, si tu proxy inverso impide aceptar solicitudes `POST`, puedes configurar Mintlify para enviar solicitudes directamente a tu backend con el ajuste `api.playground.proxy` en el `docs.json`, como se describe en la [documentación de configuración](/es/organize/settings#param-proxy). Al usar esta configuración, deberás configurar CORS en tu servidor, ya que las solicitudes llegarán directamente desde los navegadores de los usuarios en lugar de pasar por tu proxy. - Si estás usando una configuración de navigation de OpenAPI, pero las páginas no se generan, revisa estos problemas comunes: + Si usas una configuración de navigation de OpenAPI, pero las páginas no se generan, revisa estos problemas comunes: - 1. **Falta la especificación predeterminada de OpenAPI**: Asegúrate de tener definido un campo `openapi` para el elemento de navigation: + 1. **Falta la especificación de OpenAPI predeterminada**: Asegúrate de tener definido un campo `openapi` en el elemento de navigation: ```json {5} "navigation": { @@ -85,7 +86,7 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c } ``` - 2. **Herencia de la especificación OpenAPI**: Si usas navegación anidada, asegúrate de que los grupos hijos hereden la especificación OpenAPI correcta o definan la suya propia. + 2. **Herencia de la especificación OpenAPI**: Si usas navigation anidada, asegúrate de que los grupos hijos hereden la especificación OpenAPI correcta o definan la suya propia. 3. **Problemas de validación**: Usa `mint openapi-check ` para verificar que tu documento OpenAPI sea válido. @@ -93,14 +94,14 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c 1. **Operaciones ocultas**: Las operaciones marcadas con `x-hidden: true` en tu especificación de OpenAPI no aparecerán en la navigation generada automáticamente. 2. **Operaciones no válidas**: Las operaciones con errores de validación en la especificación de OpenAPI pueden omitirse. Revisa tu documento de OpenAPI para detectar errores de sintaxis. - 3. **Inclusión manual vs. automática**: Si haces referencia a endpoints desde una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecerán en la navigation. No se añadirá ninguna otra página automáticamente. Esto incluye las operaciones referenciadas en elementos secundarios de la navigation. + 3. **Inclusión manual vs. automática**: Si haces referencia a endpoints de una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecerán en la navigation. No se agregarán otras páginas automáticamente. Esto incluye operaciones referenciadas en elementos secundarios de la navigation. - Al combinar operaciones de OpenAPI con páginas de documentación regulares en navigation: + Al combinar operaciones de OpenAPI con páginas de documentación estándar en navigation: 1. **Conflictos de archivos**: No puedes tener a la vez un archivo `MDX` y una entrada en navigation para la misma operación. Por ejemplo, si tienes `get-users.mdx`, no incluyas también "GET /users" en tu navigation. Si necesitas un archivo que comparta nombre con una operación, usa la extensión `x-mint` del endpoint para que el href apunte a otra ubicación. - 2. **Resolución de rutas**: Las entradas de navigation que no coincidan con operaciones de OpenAPI se tratarán como rutas de archivos. Asegúrate de que tus archivos `MDX` existan en las ubicaciones previstas. + 2. **Resolución de rutas**: Las entradas en navigation que no coincidan con operaciones de OpenAPI se tratarán como rutas de archivo. Asegúrate de que tus archivos `MDX` existan en las ubicaciones esperadas. 3. **Distinción entre mayúsculas y minúsculas**: La coincidencia de operaciones de OpenAPI distingue mayúsculas y minúsculas. Asegúrate de que los métodos HTTP estén en mayúsculas en las entradas de navigation. \ No newline at end of file diff --git a/es/components/update.mdx b/es/components/update.mdx index af5019e3b..071f64cdd 100644 --- a/es/components/update.mdx +++ b/es/components/update.mdx @@ -1,24 +1,24 @@ --- title: "Update" -description: "Haz un seguimiento de los cambios y las actualizaciones" +description: "Lleva un registro de cambios y actualizaciones" --- -Usa el componente `Update` para mostrar entradas del registro de cambios, actualizaciones de versión y notas de lanzamiento con un formato coherente. +Usa el componente `Update` para mostrar entradas del changelog, actualizaciones de versión y notas de lanzamiento con un formato consistente. - ## Ejemplo de actualización + ## Actualización de ejemplo - Aquí puedes agregar cualquier cosa, como una captura de pantalla, un fragmento de código o una lista de cambios. + Puedes añadir aquí cualquier contenido, como una captura de pantalla, un fragmento de código o una lista de cambios. - + Captura de la página de introducción de PearsDB como ejemplo de una imagen en un componente Update. ### Novedades - * Diseño adaptable + * Diseño responsivo * Ancla para cada actualización - * Entrada de RSS generada para cada actualización + * Entrada del feed RSS generada para cada actualización
diff --git a/es/dashboard/sso.mdx b/es/dashboard/sso.mdx index 266ef8603..075a468d1 100644 --- a/es/dashboard/sso.mdx +++ b/es/dashboard/sso.mdx @@ -63,13 +63,13 @@ Usa el inicio de sesión único en tu dashboard mediante SAML y OIDC. Si usas Ok En `Web and mobile apps`, selecciona `Add custom SAML app` en el menú desplegable `Add app`. - ![](/images/gsuite-add-custom-saml-app.png) + ![Captura de pantalla de la página de creación de la aplicación SAML de Google Workspace con el elemento del menú "Add custom SAML app" resaltado](/images/gsuite-add-custom-saml-app.png) Copia la SSO URL, el Entity ID y el certificado x509 proporcionados y envíalos al equipo de Mintlify. - ![](/images/gsuite-saml-metadata.png) + ![Captura de pantalla de la página de la aplicación SAML de Google Workspace con la SSO URL, el Entity ID y el certificado x509 resaltados. Los valores específicos de cada uno están difuminados.](/images/gsuite-saml-metadata.png) @@ -80,16 +80,16 @@ Usa el inicio de sesión único en tu dashboard mediante SAML y OIDC. Si usas Ok * Name ID: `Basic Information > Primary email` - ![](/images/gsuite-sp-details.png) + ![Captura de pantalla de la página Service provider details con los campos de entrada ACS URL y Entity ID resaltados.](/images/gsuite-sp-details.png) - En la siguiente página, introduce las siguientes declaraciones de atributos: + En la página siguiente, introduce las siguientes declaraciones de atributos: | Google Directory Attribute | App Attribute | | -------------------------- | ------------- | | `First name` | `firstName` | | `Last name` | `lastName` | - Una vez completado este paso y asignados los usuarios a la aplicación, avísanos y habilitaremos el SSO en tu cuenta. + Cuando completes este paso y los usuarios estén asignados a la aplicación, avísanos y habilitaremos el SSO para tu cuenta. diff --git a/es/deploy/gitlab.mdx b/es/deploy/gitlab.mdx index 8a8c7ecc8..cec27b8a4 100644 --- a/es/deploy/gitlab.mdx +++ b/es/deploy/gitlab.mdx @@ -57,41 +57,41 @@ Usamos tokens de acceso y webhooks para autenticar y sincronizar cambios entre G ## Crear el webhook
-Los webhooks nos permiten recibir eventos cuando se realizan cambios para +Los webhooks nos permiten recibir eventos cuando se realizan cambios y así activar implementaciones automáticamente. - + Captura de pantalla de la página de Webhooks en el dashboard de GitLab. - En el campo "URL", introduce el endpoint `https://leaves.mintlify.com/gitlab-webhook` y asigna el nombre "Mintlify" al webhook. + En el campo "URL", ingresa el endpoint `https://leaves.mintlify.com/gitlab-webhook` y asigna al webhook el nombre "Mintlify". Pega el token del webhook generado después de configurar la conexión. - + Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify. El botón Show Webtoken está resaltado. - + Selecciona estos eventos para activar el webhook: - **Push events** (All branches) - **Merge requests events** Cuando termines, debería verse así: - La página de Webhook en el dashboard de GitLab. Se resaltan los ajustes que hay que configurar para Mintlify. + La página de Webhook en el dashboard de GitLab. Los ajustes para configurar Mintlify están resaltados. - Después de crear el webhook, haz clic en el menú desplegable "Test" y selecciona "Push events" para enviar un payload de muestra y asegurarte de que esté configurado correctamente. Verás "Hook executed successfully: HTTP 200" si todo está configurado correctamente. + Después de crear el webhook, haz clic en el menú desplegable "Test" y selecciona "Push events" para enviar una carga de ejemplo y asegurarte de que esté configurado correctamente. Verás el mensaje "Hook executed successfully: HTTP 200" si todo está bien. - Esto te ayudará a verificar que todo funciona correctamente y que tu documentación se sincroniza adecuadamente con tu repositorio de GitLab. + Esto te ayudará a verificar que todo funcione correctamente y que tu documentación se sincronice correctamente con tu repositorio de GitLab. - + Captura de pantalla de la página de Webhooks de GitLab. El elemento de menú 'Push events' está resaltado en el menú 'Test'. diff --git a/fr/api-playground/troubleshooting.mdx b/fr/api-playground/troubleshooting.mdx index 536bb4d41..887c64726 100644 --- a/fr/api-playground/troubleshooting.mdx +++ b/fr/api-playground/troubleshooting.mdx @@ -10,29 +10,29 @@ Si vos pages d’API ne s’affichent pas correctement, vérifiez d’abord ces Dans ce scénario, il est probable que Mintlify ne trouve pas votre document OpenAPI ou que votre document OpenAPI soit invalide. - L’exécution de `mint dev` en local devrait révéler certains de ces problèmes. + L’exécution de `mint dev` en local devrait révéler une partie de ces problèmes. Pour vérifier que votre document OpenAPI passe la validation : - 1. Rendez-vous sur [ce validateur](https://editor.swagger.io/) - 2. Sélectionnez l’onglet « Validate text » + 1. Rendez-vous sur [cet outil de validation](https://editor.swagger.io/) + 2. Passez à l’onglet « Validate text » 3. Collez votre document OpenAPI 4. Cliquez sur « Validate it! » - Si la zone de texte qui apparaît en dessous a une bordure verte, votre document a passé la validation. - C’est exactement le package de validation que Mintlify utilise pour valider les documents OpenAPI ; si votre document - passe la validation ici, il y a de fortes chances que le problème se situe ailleurs. + Si la zone de texte qui apparaît en dessous a une bordure verte, votre document a bien été validé. + C’est exactement le paquet de validation que Mintlify utilise pour valider les documents OpenAPI ; si votre document + est validé ici, il y a de fortes chances que le problème se situe ailleurs. Par ailleurs, Mintlify ne prend pas en charge OpenAPI 2.0. Si votre document utilise cette version de la spécification, vous pourriez rencontrer ce problème. Vous pouvez convertir votre document sur [editor.swagger.io](https://editor.swagger.io/) (dans Edit > Convert to OpenAPI 3) : - ![](/images/convert-oas-3.png) + ![Capture d’écran de Swagger Editor avec le menu Edit développé et l’élément « Convert to OpenAPI 3 » mis en évidence.](/images/convert-oas-3.png) - - Cela est généralement dû à une faute d’orthographe du champ `openapi` dans les métadonnées de la page. Assurez-vous que la méthode HTTP et le chemin correspondent exactement à la méthode HTTP et au chemin du document OpenAPI. + + Ceci est généralement dû à une faute d’orthographe du champ `openapi` dans la metadata de la page. Assurez-vous que la méthode HTTP et le chemin correspondent exactement à la méthode HTTP et au chemin dans le document OpenAPI. Voici un exemple de la façon dont cela peut mal tourner : @@ -48,9 +48,9 @@ Si vos pages d’API ne s’affichent pas correctement, vérifiez d’abord ces get: ... ``` - Notez que le chemin dans le champ `openapi` se termine par une barre oblique, tandis que celui dans le document OpenAPI n’en a pas. + Notez que le chemin dans le champ `openapi` se termine par une barre oblique, alors que le chemin dans le document OpenAPI n’en a pas. - Un autre problème fréquent est une erreur dans le nom de fichier. Si vous indiquez un document OpenAPI précis dans le champ `openapi`, assurez-vous que le nom de fichier est correct. Par exemple, si vous avez deux documents OpenAPI `openapi/v1.json` et `openapi/v2.json`, vos metadata pourraient ressembler à ceci : + Un autre problème fréquent est une faute dans le nom de fichier. Si vous indiquez un document OpenAPI précis dans le champ `openapi`, assurez-vous que le nom de fichier est correct. Par exemple, si vous avez deux documents OpenAPI `openapi/v1.json` et `openapi/v2.json`, vos metadata pourraient ressembler à ceci : ```mdx api-reference/v1/users/get-user.mdx --- @@ -60,15 +60,15 @@ Si vos pages d’API ne s’affichent pas correctement, vérifiez d’abord ces - Si vous avez configuré un domain personnalisé, il peut s’agir d’un problème avec votre proxy inverse. Par défaut, les requêtes effectuées via le bac à sable d’API commencent par une requête `POST` vers le chemin `/_mintlify/api/request` sur le site de documentation. Si votre proxy inverse est configuré pour n’autoriser que les requêtes `GET`, toutes ces requêtes échoueront. Pour résoudre ce problème, configurez votre proxy inverse afin d’autoriser les requêtes `POST` vers le chemin `/_mintlify/api/request`. + Si vous avez configuré un domain personnalisé, le problème peut venir de votre reverse proxy. Par défaut, les requêtes effectuées via le bac à sable d’API commencent par une requête `POST` vers le chemin `/_mintlify/api/request` sur le site de documentation. Si votre reverse proxy est configuré pour n’autoriser que les requêtes `GET`, alors toutes ces requêtes échoueront. Pour corriger cela, configurez votre reverse proxy pour autoriser les requêtes `POST` vers le chemin `/_mintlify/api/request`. - Sinon, si votre proxy inverse vous empêche d’accepter des requêtes `POST`, vous pouvez configurer Mintlify pour envoyer les requêtes directement à votre backend avec le paramètre `api.playground.proxy` dans le `docs.json`, comme décrit dans la [documentation des paramètres](/fr/organize/settings#param-proxy). Lorsque vous utilisez cette configuration, vous devrez configurer CORS sur votre serveur, car les requêtes proviendront directement des navigateurs des utilisateurs plutôt que de passer par votre proxy. + Sinon, si votre reverse proxy empêche l’acceptation des requêtes `POST`, vous pouvez configurer Mintlify pour envoyer les requêtes directement à votre backend avec le paramètre `api.playground.proxy` dans le `docs.json`, comme décrit dans la [documentation des paramètres](/fr/organize/settings#param-proxy). Avec cette configuration, vous devrez activer CORS sur votre serveur, car les requêtes proviendront directement des navigateurs des utilisateurs plutôt que de passer par votre proxy. - Si vous utilisez une configuration de navigation OpenAPI mais que les pages ne se génèrent pas, vérifiez ces problèmes courants : + Si vous utilisez une configuration de navigation OpenAPI, mais que les pages ne sont pas générées, vérifiez ces problèmes courants : - 1. **Spécification OpenAPI par défaut manquante** : assurez-vous d’avoir un champ `openapi` défini pour l’élément navigation : + 1. **Spécification OpenAPI par défaut manquante** : assurez-vous d’avoir un champ `openapi` défini pour l’élément de navigation : ```json {5} "navigation": { @@ -92,15 +92,15 @@ Si vos pages d’API ne s’affichent pas correctement, vérifiez d’abord ces 1. **Opérations masquées** : Les opérations marquées `x-hidden: true` dans votre spécification OpenAPI n’apparaîtront pas dans la navigation générée automatiquement. - 2. **Opérations invalides** : Les opérations présentant des erreurs de validation dans la spécification OpenAPI peuvent être ignorées. Vérifiez votre document OpenAPI pour détecter d’éventuelles erreurs de syntaxe. - 3. **Inclusion manuelle vs automatique** : Si vous faites référence à des endpoints à partir d’une spécification OpenAPI, seules les opérations explicitement référencées apparaîtront dans la navigation. Aucune autre page ne sera ajoutée automatiquement. Cela inclut les opérations référencées dans des éléments enfants de la navigation. + 2. **Opérations invalides** : Les opérations comportant des erreurs de validation dans la spécification OpenAPI peuvent être ignorées. Vérifiez votre document OpenAPI pour détecter les erreurs de syntaxe. + 3. **Inclusion manuelle vs automatique** : Si vous faites référence à des endpoints depuis une spécification OpenAPI, seules les opérations explicitement référencées apparaîtront dans la navigation. Aucune autre page ne sera ajoutée automatiquement. Cela inclut les opérations référencées dans des éléments enfants de la navigation. - Lors de la combinaison d’opérations OpenAPI avec des pages de documentation classiques dans la navigation : + Lorsqu’on combine des opérations OpenAPI avec des pages de documentation classiques dans navigation : - 1. **Conflits de fichiers** : Vous ne pouvez pas avoir à la fois un fichier `MDX` et une entrée de navigation pour la même opération. Par exemple, si vous avez `get-users.mdx`, n’incluez pas aussi "GET /users" dans votre navigation. Si vous devez avoir un fichier qui partage un nom avec une opération, utilisez l’extension `x-mint` pour l’endpoint afin que le href pointe vers un autre emplacement. - 2. **Résolution des chemins** : Les entrées de navigation qui ne correspondent pas à des opérations OpenAPI seront traitées comme des chemins de fichiers. Assurez-vous que vos fichiers `MDX` existent aux emplacements attendus. + 1. **Conflits de fichiers** : Vous ne pouvez pas avoir à la fois un fichier `MDX` et une entrée de navigation pour la même opération. Par exemple, si vous avez `get-users.mdx`, n’incluez pas aussi "GET /users" dans votre navigation. Si vous devez avoir un fichier qui partage un nom avec une opération, utilisez l’extension `x-mint` pour le point de terminaison afin que le href pointe vers un autre emplacement. + 2. **Résolution des chemins** : Les entrées de navigation qui ne correspondent pas aux opérations OpenAPI seront traitées comme des chemins de fichiers. Assurez-vous que vos fichiers `MDX` existent aux emplacements attendus. 3. **Sensibilité à la casse** : La correspondance des opérations OpenAPI est sensible à la casse. Assurez-vous que les méthodes HTTP sont en majuscules dans les entrées de navigation. \ No newline at end of file diff --git a/fr/components/update.mdx b/fr/components/update.mdx index 42d19af79..3b49847d8 100644 --- a/fr/components/update.mdx +++ b/fr/components/update.mdx @@ -3,20 +3,20 @@ title: "Update" description: "Suivez les changements et les mises à jour" --- -Utilisez le composant `Update` pour afficher des entrées de journal des modifications, des mises à jour de version et des notes de publication avec une mise en forme cohérente. +Utilisez le composant `Update` pour afficher des entrées de journal des modifications, des mises à jour de version et des notes de publication avec un formatage cohérent. ## Exemple de mise à jour - Vous pouvez ajouter n’importe quoi ici, comme une capture d’écran, un extrait de code ou une liste de modifications. + Vous pouvez ajouter ici tout ce que vous voulez, comme une capture d’écran, un extrait de code ou une liste de modifications. - + Capture d’écran de la page d’introduction de PearsDB, en exemple d’image dans un composant Update. ### Fonctionnalités - * Design réactif + * Design responsive * Ancre pour chaque mise à jour * Entrée de flux RSS générée pour chaque mise à jour diff --git a/fr/dashboard/sso.mdx b/fr/dashboard/sso.mdx index 48cd6561a..92dabf1cf 100644 --- a/fr/dashboard/sso.mdx +++ b/fr/dashboard/sso.mdx @@ -60,19 +60,19 @@ Utilisez l’authentification unique pour accéder à votre Dashboard via SAML e - + Sous `Web and mobile apps`, sélectionnez `Add custom SAML app` dans le menu déroulant `Add app`. - ![](/images/gsuite-add-custom-saml-app.png) + ![Capture d’écran de la page de création d’application SAML de Google Workspace avec l’élément de menu « Add custom SAML app » mis en évidence](/images/gsuite-add-custom-saml-app.png) - + Copiez l’URL SSO, l’Entity ID et le certificat x509 fournis, puis envoyez-les à l’équipe Mintlify. - ![](/images/gsuite-saml-metadata.png) + ![Capture d’écran de la page d’application SAML de Google Workspace avec l’URL SSO, l’Entity ID et le certificat x509 mis en évidence. Les valeurs spécifiques de chacun sont floutées.](/images/gsuite-saml-metadata.png) - + Sur la page Service provider details, saisissez les éléments suivants : * ACS URL (fournie par Mintlify) * Entity ID (fourni par Mintlify) @@ -80,16 +80,16 @@ Utilisez l’authentification unique pour accéder à votre Dashboard via SAML e * Name ID : `Basic Information > Primary email` - ![](/images/gsuite-sp-details.png) + ![Capture d’écran de la page Service provider details avec les champs de saisie ACS URL et Entity ID mis en évidence.](/images/gsuite-sp-details.png) - Sur la page suivante, saisissez les déclarations d’attribut suivantes : + À la page suivante, ajoutez les déclarations d’attribut suivantes : | Google Directory Attribute | App Attribute | | -------------------------- | ------------- | | `First name` | `firstName` | | `Last name` | `lastName` | - Une fois cette étape terminée et les utilisateurs attribués à l’application, informez notre équipe et nous activerons le SSO pour votre compte ! + Une fois cette étape terminée et les utilisateurs attribués à l’application, informez notre équipe et nous activerons le SSO pour votre compte. diff --git a/fr/deploy/gitlab.mdx b/fr/deploy/gitlab.mdx index b8b000b8b..914daed98 100644 --- a/fr/deploy/gitlab.mdx +++ b/fr/deploy/gitlab.mdx @@ -57,21 +57,22 @@ Nous utilisons des jetons d’accès et des webhooks pour authentifier et synchr ## Créer le webhook -Les webhooks nous permettent de recevoir des événements lorsque des modifications sont effectuées afin de pouvoir déclencher automatiquement des déploiements. +Les webhooks nous permettent de recevoir des événements lorsque des modifications sont effectuées, afin de déclencher automatiquement des déploiements. - + Capture d’écran de la page Webhooks dans le tableau de bord GitLab. - + Dans le champ « URL », saisissez l’endpoint `https://leaves.mintlify.com/gitlab-webhook` et nommez le webhook « Mintlify ». + Collez le jeton de webhook généré après la configuration de la connexion. - + Capture d’écran de la connexion GitLab dans le Tableau de bord Mintlify. Le bouton Show Webtoken est mis en évidence. @@ -79,17 +80,18 @@ Les webhooks nous permettent de recevoir des événements lorsque des modificati - **Push events** (toutes les branches) - **Merge requests events** - Une fois terminé, vous devriez obtenir quelque chose comme ceci : + Une fois terminé, cela devrait ressembler à ceci : - La page Webhook dans le Dashboard GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence. + La page Webhooks dans le tableau de bord GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence. - Après avoir créé le webhook, cliquez sur le menu déroulant « Test » et sélectionnez « Push events » pour envoyer une charge utile d’exemple et vérifier que la configuration est correcte. Un message « Hook executed successfully: HTTP 200 » s’affichera si tout est bon. + Après avoir créé le webhook, cliquez sur le menu déroulant « Test » et sélectionnez « Push events » pour envoyer une charge utile d’exemple et vérifier qu’il est correctement configuré. Un message « Hook executed successfully: HTTP 200 » s’affichera si tout est correctement configuré. - Cela vous permettra de confirmer que tout fonctionne et que votre documentation se synchronisera correctement avec votre référentiel GitLab. + Cela vous aidera à vérifier que tout fonctionne correctement et que votre documentation se synchronise correctement avec votre référentiel GitLab. - + Capture d’écran de la page GitLab Webhooks. L’élément de menu « Push events » est mis en évidence dans le menu « Test ». + \ No newline at end of file diff --git a/zh/api-playground/troubleshooting.mdx b/zh/api-playground/troubleshooting.mdx index 158ace4cd..cd4bea0dd 100644 --- a/zh/api-playground/troubleshooting.mdx +++ b/zh/api-playground/troubleshooting.mdx @@ -7,34 +7,32 @@ description: "API 参考的常见问题" - 在这种情况下，很可能是 Mintlify 无法找到你的 OpenAPI 文档，或者你的 OpenAPI 文档无效。 + 在这种情况下，很可能是 Mintlify 找不到你的 OpenAPI 文档，或者你的 OpenAPI 文档无效。 - 在本地运行 `mint dev` 应该能暴露出其中一些问题。 + 在本地运行 `mint dev` 通常能暴露出其中一些问题。 要验证你的 OpenAPI 文档是否能通过校验： - 1. 访问[此验证器](https://editor.swagger.io/) + 1. 访问[此校验器](https://editor.swagger.io/) 2. 切换到“Validate text”标签页 3. 粘贴你的 OpenAPI 文档 4. 点击“Validate it!” 如果下方出现的文本框带有绿色边框，说明你的文档已通过校验。 - 这是 Mintlify 用于验证 OpenAPI 文档的同一套验证包，因此如果你的文档 - 在这里通过了校验，那么很有可能问题出在其他地方。 + 这是 Mintlify 用于校验 OpenAPI 文档的同一套校验包，因此如果你的文档在这里通过校验，很大概率问题出在其他地方。 - 此外，Mintlify 不支持 OpenAPI 2.0。如果你的文档使用该版本的规范， - 你可能会遇到此问题。你可以在 [editor.swagger.io](https://editor.swagger.io/) 将文档转换（路径：Edit > Convert to OpenAPI 3）： + 此外，Mintlify 不支持 OpenAPI 2.0。如果你的文档使用该版本规范，可能会遇到此问题。你可以在 [editor.swagger.io](https://editor.swagger.io/) 上转换文档（Edit > Convert to OpenAPI 3）： - ![](/images/convert-oas-3.png) + ![展开 Edit 菜单并高亮“Convert to OpenAPI 3”菜单项的 Swagger Editor 截图。](/images/convert-oas-3.png) - - 这通常是由于页面 metadata 中的 `openapi` 字段拼写有误导致的。请确保 + + 这通常是由于页面 metadata 中的 `openapi` 字段拼写错误导致的。请确保 HTTP 方法和路径与 OpenAPI 文档中的 HTTP 方法和路径完全一致。 - 以下是一个可能出现问题的示例： + 下面是一个可能出错的示例： ```mdx get-user.mdx --- @@ -48,9 +46,9 @@ description: "API 参考的常见问题" get: ... ``` - 请注意，`openapi` 字段中的路径带有末尾斜杠，而 OpenAPI 文档中的路径没有。 + 请注意，`openapi` 字段中的路径以斜杠结尾，而 OpenAPI 文档中的路径没有。 - 另一个常见问题是文件名拼写错误。如果你在 `openapi` 字段中指定了某个特定的 OpenAPI 文档，请确保文件名正确。例如，如果你有两个 OpenAPI 文档 `openapi/v1.json` 和 `openapi/v2.json`，你的 metadata 可能如下所示： + 另一个常见问题是文件名拼写错误。如果你在 `openapi` 字段中指定了某个特定的 OpenAPI 文档，请确保文件名正确。比如说，如果你有两个 OpenAPI 文档 `openapi/v1.json` 和 `openapi/v2.json`，你的 metadata 可能如下所示： ```mdx api-reference/v1/users/get-user.mdx --- @@ -59,16 +57,16 @@ description: "API 参考的常见问题" ``` - - 如果你已配置自定义 domain，问题可能出在你的反向代理上。默认情况下，通过 API 操作台 发起的请求会首先向文档站点的 `/_mintlify/api/request` 路径发送一个 `POST` 请求。如果你的反向代理仅允许 `GET` 请求，这些请求都会失败。要解决此问题，请将反向代理配置为允许对 `/_mintlify/api/request` 路径的 `POST` 请求。 + + 如果你配置了自定义 domain，这可能与反向代理有关。默认情况下，通过 API 操作台发起的请求会先向文档站点的 `/_mintlify/api/request` 路径发送一个 `POST` 请求。如果你的反向代理被配置为只允许 `GET` 请求，那么这些请求都会失败。要解决此问题，请将反向代理配置为允许对 `/_mintlify/api/request` 路径的 `POST` 请求。 - 或者，如果你的反向代理无法接受 `POST` 请求，你可以按照[设置文档](/zh/organize/settings#param-proxy)中的说明，在 `docs.json` 里使用 `api.playground.proxy` 配置，让 Mintlify 直接将请求发送到你的后端。使用此配置时，你需要在服务器上配置 CORS，因为请求将直接来自用户的浏览器，而不是经过你的代理。 + 或者，如果你的反向代理禁止接受 `POST` 请求，你可以在 `docs.json` 中通过 `api.playground.proxy` 设置，让 Mintlify 直接将请求发送到你的后端，具体参见[设置文档](/zh/organize/settings#param-proxy)。使用此配置时，你需要在服务器上配置 CORS，因为请求将直接来自用户的浏览器，而不是通过你的代理。 如果你使用的是 OpenAPI 导航配置，但页面未生成，请检查以下常见问题： - 1. **缺少默认 OpenAPI 规范**：请确保在该导航元素中设置了 `openapi` 字段： + 1. **缺少默认 OpenAPI 规范**：请确保在该导航元素上设置了 `openapi` 字段： ```json {5} "navigation": { @@ -85,22 +83,22 @@ description: "API 参考的常见问题" } ``` - 2. **OpenAPI 规范继承**：如果使用嵌套导航，确保子 groups 继承正确的 OpenAPI 规范，或为其单独指定规范。 + 2. **OpenAPI 规范继承**：如果使用嵌套导航，确保子 groups 继承正确的 OpenAPI 规范，或为其分别指定自己的规范。 - 3. **验证问题**：使用 `mint openapi-check ` 来验证你的 OpenAPI 文档是否有效。 + 3. **验证问题**：使用 `mint openapi-check ` 验证你的 OpenAPI 文档是否有效。 - + 1. **隐藏操作**：在你的 OpenAPI 规范中标记为 `x-hidden: true` 的操作不会出现在自动生成的导航中。 - 2. **无效操作**：在 OpenAPI 规范中存在校验错误的操作可能会被跳过。请检查你的 OpenAPI 文档是否存在语法错误。 - 3. **手动与自动包含**：如果你从某个 OpenAPI 规范中引用了任何端点，只有被显式引用的操作会显示在导航中。不会自动添加其他页面。这也包括在子导航元素中被引用的操作。 + 2. **无效操作**：OpenAPI 规范中存在校验错误的操作可能会被跳过。请检查你的 OpenAPI 文档是否有语法错误。 + 3. **手动与自动包含**：如果你从某个 OpenAPI 规范中引用了任意端点，只有被明确引用的操作会显示在导航中，其他页面不会自动添加。这也包括在子导航元素中被引用的操作。 - 在导航中将 OpenAPI 操作与常规文档页面一起使用时： + 在导航中将 OpenAPI 操作与常规文档页面结合使用时： - 1. **文件冲突**：同一操作不能同时存在一个 `MDX` 文件和一个导航条目。例如，如果你有 `get-users.mdx`，请不要在导航中同时包含 `"GET /users"`。如果确实需要创建与某个操作同名的文件，请为该端点使用 `x-mint` 扩展，让 href 指向其他位置。 - 2. **路径解析**：与 OpenAPI 操作不匹配的导航条目将被视为文件路径。请确保你的 `MDX` 文件位于预期位置。 - 3. **大小写敏感**：OpenAPI 操作匹配区分大小写。请确保在导航条目中将 HTTP 方法写为大写。 + 1. **文件冲突**：同一操作不能同时存在 `MDX` 文件和导航条目。比如，如果你有 `get-users.mdx`，就不要在导航中再包含 `"GET /users"`。如果你需要一个与该操作同名的文件，请为该端点使用 `x-mint` 扩展，让 href 指向其他位置。 + 2. **路径解析**：与 OpenAPI 操作不匹配的导航条目将被视为文件路径。请确保你的 `MDX` 文件位于预期的位置。 + 3. **大小写敏感**：OpenAPI 操作匹配区分大小写。请确保在导航条目中 HTTP 方法使用大写。 \ No newline at end of file diff --git a/zh/components/update.mdx b/zh/components/update.mdx index 2207468c0..4609aac12 100644 --- a/zh/components/update.mdx +++ b/zh/components/update.mdx @@ -3,21 +3,21 @@ title: "Update" description: "跟踪变更与更新" --- -使用 `Update` 组件以统一格式展示更新日志条目、版本更新和发行说明。 +使用 `Update` 组件以一致的格式展示更新日志、版本更新和发行说明。 ## 示例更新 - 你可以在这里添加任何内容，比如截图、代码片段或变更列表。 + 你可以在此添加任何内容，比如截图、代码片段或变更列表。 - + PearsDB 介绍页面的截图，作为在 Update 组件中插入图像的示例。 - ### 新功能 + ### 功能 - * 响应式设计 - * 为每次更新提供锚点 + * 自适应设计 + * 每次更新都有锚点 * 为每次更新生成 RSS 源条目 diff --git a/zh/dashboard/sso.mdx b/zh/dashboard/sso.mdx index c8e7ac10a..25ab9c6b5 100644 --- a/zh/dashboard/sso.mdx +++ b/zh/dashboard/sso.mdx @@ -60,36 +60,36 @@ description: "自定义团队登录管理控制台的方式" - + 在 `Web and mobile apps` 下，从 `Add app` 下拉菜单中选择 `Add custom SAML app`。 - ![](/images/gsuite-add-custom-saml-app.png) + ![Google Workspace SAML 应用创建页面的截图，其中高亮显示了“Add custom SAML app”菜单项](/images/gsuite-add-custom-saml-app.png) - - 复制提供的 SSO URL、Entity ID 和 x509 certificate，并将其发送给 Mintlify 团队。 + + 复制提供的 SSO URL、Entity ID 和 x509 证书，并发送给 Mintlify 团队。 - ![](/images/gsuite-saml-metadata.png) + ![Google Workspace SAML 应用页面的截图，其中高亮显示了 SSO URL、Entity ID 和 x509 证书。每项的具体值均已模糊处理。](/images/gsuite-saml-metadata.png) - - 在 Service provider details 页面，输入以下内容： + + 在 Service provider details 页面中，填写以下内容： * ACS URL（由 Mintlify 提供） * Entity ID（由 Mintlify 提供） - * Name ID format：`EMAIL` - * Name ID：`Basic Information > Primary email` + * Name ID format: `EMAIL` + * Name ID: `Basic Information > Primary email` - ![](/images/gsuite-sp-details.png) + ![Service provider details 页面截图，其中高亮显示了 ACS URL 和 Entity ID 输入字段。](/images/gsuite-sp-details.png) - 在下一页，输入以下属性声明（attribute statements）： + 在下一页，输入以下属性声明： | Google Directory Attribute | App Attribute | | -------------------------- | ------------- | | `First name` | `firstName` | | `Last name` | `lastName` | - 完成此步骤并将用户分配到该应用后，请告知我们的团队，我们会为你的账户启用 SSO！ + 完成此步骤并将用户分配到该应用后，请告知我们的团队，我们将为您的账号启用 SSO！ diff --git a/zh/deploy/gitlab.mdx b/zh/deploy/gitlab.mdx index 56ed2a72a..6ef6717e4 100644 --- a/zh/deploy/gitlab.mdx +++ b/zh/deploy/gitlab.mdx @@ -54,43 +54,43 @@ description: "将文档与 GitLab 仓库同步"
- ## 创建 Webhook + ## 创建 webhook
-Webhook 可让我们在发生更改时接收事件，从而自动触发部署。 +Webhooks 可在发生更改时向我们发送事件，从而自动触发部署。 - + - + GitLab 控制台中 Webhooks 页面截图。 - - 在“URL”字段中输入端点 `https://leaves.mintlify.com/gitlab-webhook`，并将该 Webhook 命名为 “Mintlify”。 + + 在“URL”字段中，输入端点 `https://leaves.mintlify.com/gitlab-webhook`，并将 webhook 命名为“Mintlify”。 粘贴在完成连接设置后生成的 Webhook 令牌。 - + Mintlify 控制台中的 GitLab 连接截图。已高亮显示 Show Webtoken 按钮。 - 选择以下事件以触发该 Webhook： + 选择以下事件以触发 webhook： - **Push events**（所有 branch） - **Merge requests events** 完成后应如下所示： - GitLab 控制台中的 Webhook 页面。需要为 Mintlify 配置的设置已高亮显示。 + GitLab 控制台中的 Webhook 页面。为 Mintlify 配置的设置已高亮显示。 - 创建 Webhook 后，点击 “Test” 下拉菜单并选择 “Push events” 以发送示例负载，确保配置正确。若配置无误，将显示 “Hook executed successfully: HTTP 200”。 + 创建 Webhook 后，点击“Test”下拉菜单并选择“Push events”，发送示例负载以确保配置正确。若配置无误，将显示“Hook executed successfully: HTTP 200”。 - 这有助于你验证一切正常，并确保文档能与 GitLab 存储库正确同步。 + 这将帮助你验证一切正常工作，并确保你的文档能与 GitLab 存储库正确同步。 - + GitLab Webhooks 页面截图。在“Test”菜单中已高亮显示“Push events”菜单项。