From 4fa6b5b1779edd512b334007a4061f991231ee38 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Aug 2026 16:17:31 +0000 Subject: [PATCH 1/2] docs: add help center articles for the OSS Program --- docs.json | 4 +- help-center/oss-program-plan-and-billing.mdx | 36 +++++++++++++++ .../remove-auto-generated-oss-docs.mdx | 46 +++++++++++++++++++ 3 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 help-center/oss-program-plan-and-billing.mdx create mode 100644 help-center/remove-auto-generated-oss-docs.mdx diff --git a/docs.json b/docs.json index a171c7f3d..12da32bd0 100644 --- a/docs.json +++ b/docs.json @@ -484,7 +484,9 @@ "pages": [ "help-center/openapi-url-fetch-fails-during-build", "help-center/domain-already-claimed-by-another-organization", - "help-center/configure-oauth-with-auth0" + "help-center/configure-oauth-with-auth0", + "help-center/oss-program-plan-and-billing", + "help-center/remove-auto-generated-oss-docs" ] } ] diff --git a/help-center/oss-program-plan-and-billing.mdx b/help-center/oss-program-plan-and-billing.mdx new file mode 100644 index 000000000..15d3b0c80 --- /dev/null +++ b/help-center/oss-program-plan-and-billing.mdx @@ -0,0 +1,36 @@ +--- +title: "About the Mintlify OSS Program" +description: "How the OSS Program sponsors documentation for open-source projects, what plan enrolled projects run on, and what to do if billing looks wrong." +keywords: ["OSS Program", "open source program", "OSS plan", "sponsored plan", "open-source docs", "MINT-OSS", "OSS billing", "trial ended OSS", "OSS refund"] +--- + +The Mintlify OSS Program sponsors documentation hosting for qualifying open-source projects. This article explains what an enrolled project runs on, what to do when billing does not match your expectations, and how to reach the team about eligibility. + +## What an enrolled project runs on + +An enrolled deployment runs on the [Pro plan](https://mintlify.com/pricing?ref=oss-program) with a 100% sponsorship discount applied at the organization level, so the recurring cost is $0. Enrolled deployments keep every Pro feature — including the [assistant](/assistant/index), [analytics](/analytics/index), and [custom domain](/customize/custom-domain) — for the duration of the sponsorship. + +The OSS Program is not a separate plan in the dashboard. Enrollment is tracked as a discount on the Pro plan, so the billing page shows the Pro plan with a `MINT-OSS` discount that brings the total to zero. + +## When billing does not match what you expected + +The most common situations that require support intervention: + +- **Your project dropped to the Hobby plan after a paid trial ended.** Starting a paid trial on top of an OSS-enrolled deployment can end the sponsorship when the trial expires, leaving the deployment on Hobby instead of returning it to Pro. Contact support@mintlify.com from an email associated with the organization and reference the deployment. Support can re-apply the OSS sponsorship. +- **You were charged while expecting to be on the OSS Program.** Sponsorship is applied per organization and per plan. If the discount is missing — for example, after switching plans, changing organizations, or completing a trial — the Pro plan bills at its normal price. Contact support@mintlify.com with the organization name and the affected invoices; support can re-apply the sponsorship and review past charges. +- **You received a "You're in! Mintlify's OSS Program" email but do not see a change on your deployment.** Reply to that email or contact support@mintlify.com so support can confirm which organization and deployment the sponsorship was applied to. + +Include this information when you contact support: + +- The organization and deployment, formatted as `app.mintlify.com//`. +- The public repository URL for the open-source project. +- The email address associated with your Mintlify account. +- The invoice IDs or dates for any charges you want reviewed. + +## Apply for the program or ask about eligibility + +The Mintlify team reviews eligibility case by case. To apply or ask whether a project qualifies, email support@mintlify.com with the repository URL, a short description of the project, and the Mintlify organization you want the sponsorship applied to. + +## Auto-generated docs for open-source projects + +Mintlify sometimes generates a docs site directly from a public repository as part of outreach for the OSS Program. If a site was generated for a project you maintain and you want it taken down, hidden from search, or transferred to your organization, see [Remove or hide an auto-generated OSS docs site](/help-center/remove-auto-generated-oss-docs). diff --git a/help-center/remove-auto-generated-oss-docs.mdx b/help-center/remove-auto-generated-oss-docs.mdx new file mode 100644 index 000000000..5702122b1 --- /dev/null +++ b/help-center/remove-auto-generated-oss-docs.mdx @@ -0,0 +1,46 @@ +--- +title: "Remove or hide an auto-generated OSS docs site" +description: "Take down a Mintlify-generated docs site for an open-source project, or hide it from search engines and AI tools without deleting it." +keywords: ["auto-generated docs", "OSS docs removal", "remove open source docs", "hide open-source docs", "noindex open source", "unpublish OSS site", "auto-generated wiki"] +--- + +Mintlify sometimes generates a documentation site directly from a public open-source repository as part of the [OSS Program](/help-center/oss-program-plan-and-billing). If a site was generated for a project you maintain and you want to remove it or hide it from search, choose the option that matches what you need. + +## Take the site down entirely + +If you want the auto-generated site unpublished so it is no longer reachable, email support@mintlify.com with: + +- The URL of the auto-generated docs site. +- The public repository the site was generated from. +- Confirmation that you maintain or represent the project. A message from an email associated with the repository (for example, a maintainer address published in the repo) helps support verify ownership. + +Support unpublishes the deployment. This removes the site from `mintlify.app` and stops any custom domain that was pointing to it. + +## Hide the site from search engines and AI tools + +If you want to keep the site online but stop it from appearing in search results or being picked up by AI crawlers, add `noindex: true` to the frontmatter of each page you want hidden: + +```mdx +--- +title: "Page title" +noindex: true +--- +``` + +Pages with `noindex: true` are rendered with `noindex, nofollow` robots meta tags and are excluded from `llms.txt` and `llms-full.txt`. See [Disable indexing](/optimize/seo#disable-indexing) for the full behavior. + +To hide every page at once, set the project-level robots metatag in `docs.json`: + +```json +{ + "metatags": { + "robots": "noindex" + } +} +``` + +Applying `noindex` on an auto-generated site removes its pages from both the site's own search and public search engine results after the next deploy. + +## Take over the site instead of removing it + +If you would rather keep the auto-generated site and maintain it yourself, email support@mintlify.com and ask for the deployment to be transferred to your Mintlify organization. Once transferred, you can edit the content, connect it to your own Git repository, or apply for the [OSS Program](/help-center/oss-program-plan-and-billing) so the deployment runs on a sponsored Pro plan. From 0a7c2b6f2067772964fb6f8b26d87b9695a7b244 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 21 Aug 2026 16:22:01 +0000 Subject: [PATCH 2/2] docs: translate OSS Program help center articles to es, fr, zh --- es.json | 4 +- .../oss-program-plan-and-billing.mdx | 36 +++++++++++++++ .../remove-auto-generated-oss-docs.mdx | 46 +++++++++++++++++++ fr.json | 4 +- .../oss-program-plan-and-billing.mdx | 36 +++++++++++++++ .../remove-auto-generated-oss-docs.mdx | 46 +++++++++++++++++++ help-center/oss-program-plan-and-billing.mdx | 4 +- zh.json | 4 +- .../oss-program-plan-and-billing.mdx | 36 +++++++++++++++ .../remove-auto-generated-oss-docs.mdx | 46 +++++++++++++++++++ 10 files changed, 257 insertions(+), 5 deletions(-) create mode 100644 es/help-center/oss-program-plan-and-billing.mdx create mode 100644 es/help-center/remove-auto-generated-oss-docs.mdx create mode 100644 fr/help-center/oss-program-plan-and-billing.mdx create mode 100644 fr/help-center/remove-auto-generated-oss-docs.mdx create mode 100644 zh/help-center/oss-program-plan-and-billing.mdx create mode 100644 zh/help-center/remove-auto-generated-oss-docs.mdx diff --git a/es.json b/es.json index 20eb86a0d..d96b9c93a 100644 --- a/es.json +++ b/es.json @@ -462,7 +462,9 @@ "pages": [ "es/help-center/openapi-url-fetch-fails-during-build", "es/help-center/domain-already-claimed-by-another-organization", - "es/help-center/configure-oauth-with-auth0" + "es/help-center/configure-oauth-with-auth0", + "es/help-center/oss-program-plan-and-billing", + "es/help-center/remove-auto-generated-oss-docs" ] } ] diff --git a/es/help-center/oss-program-plan-and-billing.mdx b/es/help-center/oss-program-plan-and-billing.mdx new file mode 100644 index 000000000..84a094a2c --- /dev/null +++ b/es/help-center/oss-program-plan-and-billing.mdx @@ -0,0 +1,36 @@ +--- +title: "Acerca del Mintlify OSS Program" +description: "Cómo el OSS Program patrocina la documentación de proyectos de código abierto, en qué plan se ejecutan los proyectos inscritos y qué hacer si la facturación no coincide." +keywords: ["OSS Program", "open source program", "OSS plan", "sponsored plan", "open-source docs", "MINT-OSS", "OSS billing", "trial ended OSS", "OSS refund"] +--- + +El Mintlify OSS Program patrocina el alojamiento de la documentación para proyectos de código abierto que reúnan los requisitos. Este artículo explica en qué se ejecuta un proyecto inscrito, qué hacer cuando la facturación no coincide con lo esperado y cómo contactar al equipo para preguntar sobre la elegibilidad. + +## En qué se ejecuta un proyecto inscrito + +Una implementación inscrita se ejecuta en el [plan Pro](https://mintlify.com/pricing?ref=oss-program) con un descuento de patrocinio del 100% aplicado a nivel de organización, por lo que el coste recurrente es de $0. Las implementaciones inscritas conservan todas las funciones de Pro durante la vigencia del patrocinio, incluidos el [asistente](/es/assistant/index), la [analítica](/es/analytics/index) y los [dominios personalizados](/es/customize/custom-domain). + +El OSS Program no es un plan independiente en el panel. La inscripción se registra como un descuento sobre el plan Pro, por lo que la página de facturación muestra el plan Pro con un descuento `MINT-OSS` que lleva el total a cero. + +## Cuando la facturación no coincide con lo que esperabas + +Las situaciones más comunes que requieren la intervención del soporte: + +- **Tu proyecto pasó al plan Hobby después de que finalizara una prueba de pago.** Iniciar una prueba de pago sobre una implementación inscrita en el OSS puede finalizar el patrocinio cuando expire la prueba, dejando la implementación en Hobby en lugar de devolverla a Pro. Contacta a support@mintlify.com desde un correo asociado a la organización e indica la implementación. El soporte puede volver a aplicar el patrocinio del OSS. +- **Se te cobró cuando esperabas estar en el OSS Program.** El patrocinio se aplica por organización y por plan. Si falta el descuento, por ejemplo tras cambiar de plan, cambiar de organización o completar una prueba, el plan Pro se factura a su precio normal. Contacta a support@mintlify.com con el nombre de la organización y las facturas afectadas; el soporte puede volver a aplicar el patrocinio y revisar los cargos anteriores. +- **Recibiste un correo "You're in! Mintlify's OSS Program" pero no ves ningún cambio en tu implementación.** Responde a ese correo o contacta a support@mintlify.com para que el soporte pueda confirmar a qué organización e implementación se aplicó el patrocinio. + +Incluye esta información cuando contactes al soporte: + +- La organización y la implementación, con el formato `app.mintlify.com//`. +- La URL del repositorio público del proyecto de código abierto. +- La dirección de correo asociada a tu cuenta de Mintlify. +- Los IDs o las fechas de las facturas de cualquier cargo que quieras revisar. + +## Solicitar el programa o preguntar sobre la elegibilidad + +El equipo de Mintlify revisa la elegibilidad caso por caso. Para postularte o preguntar si un proyecto reúne los requisitos, envía un correo a support@mintlify.com con la URL del repositorio, una breve descripción del proyecto y la organización de Mintlify a la que quieres que se aplique el patrocinio. + +## Documentación autogenerada para proyectos de código abierto + +A veces Mintlify genera un sitio de documentación directamente desde un repositorio público como parte de la difusión del OSS Program. Si se generó un sitio para un proyecto que mantienes y quieres retirarlo, ocultarlo de los buscadores o transferirlo a tu organización, consulta [Eliminar u ocultar un sitio de documentación de OSS autogenerado](/es/help-center/remove-auto-generated-oss-docs). diff --git a/es/help-center/remove-auto-generated-oss-docs.mdx b/es/help-center/remove-auto-generated-oss-docs.mdx new file mode 100644 index 000000000..32eb184a6 --- /dev/null +++ b/es/help-center/remove-auto-generated-oss-docs.mdx @@ -0,0 +1,46 @@ +--- +title: "Eliminar u ocultar un sitio de documentación de OSS autogenerado" +description: "Retira un sitio de documentación generado por Mintlify para un proyecto de código abierto, u ocúltalo de los buscadores y herramientas de IA sin eliminarlo." +keywords: ["auto-generated docs", "OSS docs removal", "remove open source docs", "hide open-source docs", "noindex open source", "unpublish OSS site", "auto-generated wiki"] +--- + +A veces Mintlify genera un sitio de documentación directamente desde un repositorio público de código abierto como parte del [OSS Program](/es/help-center/oss-program-plan-and-billing). Si se generó un sitio para un proyecto que mantienes y quieres eliminarlo u ocultarlo de las búsquedas, elige la opción que se ajuste a lo que necesitas. + +## Retirar el sitio por completo + +Si quieres que el sitio autogenerado se despublique para que ya no sea accesible, envía un correo a support@mintlify.com con: + +- La URL del sitio de documentación autogenerado. +- El repositorio público desde el que se generó el sitio. +- Una confirmación de que mantienes o representas el proyecto. Un mensaje desde un correo asociado al repositorio (por ejemplo, una dirección de mantenedor publicada en el repo) ayuda al soporte a verificar la propiedad. + +El soporte despublica la implementación. Esto elimina el sitio de `mintlify.app` y detiene cualquier dominio personalizado que apuntara a él. + +## Ocultar el sitio de los buscadores y las herramientas de IA + +Si quieres mantener el sitio en línea pero evitar que aparezca en los resultados de búsqueda o que sea recogido por rastreadores de IA, añade `noindex: true` al frontmatter de cada página que quieras ocultar: + +```mdx +--- +title: "Page title" +noindex: true +--- +``` + +Las páginas con `noindex: true` se renderizan con las metaetiquetas `noindex, nofollow` de robots y se excluyen de `llms.txt` y `llms-full.txt`. Consulta [Deshabilitar la indexación](/es/optimize/seo#disable-indexing) para conocer el comportamiento completo. + +Para ocultar todas las páginas de una vez, define la metaetiqueta `robots` a nivel de proyecto en `docs.json`: + +```json +{ + "metatags": { + "robots": "noindex" + } +} +``` + +Aplicar `noindex` en un sitio autogenerado elimina sus páginas tanto de la búsqueda propia del sitio como de los resultados de los buscadores públicos tras el siguiente despliegue. + +## Hacerse cargo del sitio en lugar de eliminarlo + +Si prefieres conservar el sitio autogenerado y mantenerlo tú mismo, envía un correo a support@mintlify.com y solicita que la implementación se transfiera a tu organización de Mintlify. Una vez transferida, puedes editar el contenido, conectarla a tu propio repositorio de Git o postularte al [OSS Program](/es/help-center/oss-program-plan-and-billing) para que la implementación se ejecute con un plan Pro patrocinado. diff --git a/fr.json b/fr.json index 3d04b880e..4ed092fd3 100644 --- a/fr.json +++ b/fr.json @@ -462,7 +462,9 @@ "pages": [ "fr/help-center/openapi-url-fetch-fails-during-build", "fr/help-center/domain-already-claimed-by-another-organization", - "fr/help-center/configure-oauth-with-auth0" + "fr/help-center/configure-oauth-with-auth0", + "fr/help-center/oss-program-plan-and-billing", + "fr/help-center/remove-auto-generated-oss-docs" ] } ] diff --git a/fr/help-center/oss-program-plan-and-billing.mdx b/fr/help-center/oss-program-plan-and-billing.mdx new file mode 100644 index 000000000..19dcba624 --- /dev/null +++ b/fr/help-center/oss-program-plan-and-billing.mdx @@ -0,0 +1,36 @@ +--- +title: "À propos du programme OSS de Mintlify" +description: "Comment le programme OSS sponsorise la documentation des projets open source, sur quelle formule les projets inscrits fonctionnent, et que faire si la facturation semble incorrecte." +keywords: ["OSS Program", "open source program", "OSS plan", "sponsored plan", "open-source docs", "MINT-OSS", "OSS billing", "trial ended OSS", "OSS refund"] +--- + +Le programme OSS de Mintlify sponsorise l'hébergement de la documentation des projets open source éligibles. Cet article explique sur quoi fonctionne un projet inscrit, que faire lorsque la facturation ne correspond pas à vos attentes, et comment contacter l'équipe au sujet de l'éligibilité. + +## Sur quoi fonctionne un projet inscrit + +Un déploiement inscrit fonctionne sur la [formule Pro](https://mintlify.com/pricing?ref=oss-program) avec une remise de parrainage de 100% appliquée au niveau de l'organisation, de sorte que le coût récurrent est de $0. Les déploiements inscrits conservent toutes les fonctionnalités Pro pendant la durée du parrainage, notamment l'[assistant](/fr/assistant/index), l'[analytique](/fr/analytics/index) et les [domaines personnalisés](/fr/customize/custom-domain). + +Le programme OSS n'est pas une formule distincte dans le tableau de bord. L'inscription est suivie comme une remise sur la formule Pro, donc la page de facturation affiche la formule Pro avec une remise `MINT-OSS` qui ramène le total à zéro. + +## Quand la facturation ne correspond pas à ce que vous attendiez + +Les situations les plus courantes qui nécessitent l'intervention du support : + +- **Votre projet est passé à la formule Hobby après la fin d'un essai payant.** Démarrer un essai payant par-dessus un déploiement inscrit au programme OSS peut mettre fin au parrainage lorsque l'essai expire, laissant le déploiement sur Hobby au lieu de le remettre sur Pro. Contactez support@mintlify.com depuis une adresse e-mail associée à l'organisation et mentionnez le déploiement. Le support peut réappliquer le parrainage OSS. +- **Vous avez été facturé alors que vous vous attendiez à être inscrit au programme OSS.** Le parrainage est appliqué par organisation et par formule. Si la remise manque, par exemple après un changement de formule, un changement d'organisation ou la fin d'un essai, la formule Pro est facturée à son tarif normal. Contactez support@mintlify.com avec le nom de l'organisation et les factures concernées ; le support peut réappliquer le parrainage et examiner les frais passés. +- **Vous avez reçu un e-mail « You're in! Mintlify's OSS Program » mais ne voyez aucun changement sur votre déploiement.** Répondez à cet e-mail ou contactez support@mintlify.com afin que le support puisse confirmer à quelle organisation et à quel déploiement le parrainage a été appliqué. + +Incluez ces informations lorsque vous contactez le support : + +- L'organisation et le déploiement, sous la forme `app.mintlify.com//`. +- L'URL du dépôt public du projet open source. +- L'adresse e-mail associée à votre compte Mintlify. +- Les identifiants ou dates des factures que vous souhaitez faire examiner. + +## Postuler au programme ou vérifier l'éligibilité + +L'équipe Mintlify examine l'éligibilité au cas par cas. Pour postuler ou demander si un projet est éligible, envoyez un e-mail à support@mintlify.com avec l'URL du dépôt, une brève description du projet, et l'organisation Mintlify à laquelle vous souhaitez appliquer le parrainage. + +## Documentation générée automatiquement pour les projets open source + +Mintlify génère parfois un site de documentation directement à partir d'un dépôt public dans le cadre de la démarche du programme OSS. Si un site a été généré pour un projet que vous maintenez et que vous souhaitez le retirer, le masquer aux moteurs de recherche ou le transférer à votre organisation, consultez [Supprimer ou masquer un site de documentation OSS généré automatiquement](/fr/help-center/remove-auto-generated-oss-docs). diff --git a/fr/help-center/remove-auto-generated-oss-docs.mdx b/fr/help-center/remove-auto-generated-oss-docs.mdx new file mode 100644 index 000000000..dad010652 --- /dev/null +++ b/fr/help-center/remove-auto-generated-oss-docs.mdx @@ -0,0 +1,46 @@ +--- +title: "Supprimer ou masquer un site de documentation OSS généré automatiquement" +description: "Retirez un site de documentation généré par Mintlify pour un projet open source, ou masquez-le aux moteurs de recherche et aux outils d'IA sans le supprimer." +keywords: ["auto-generated docs", "OSS docs removal", "remove open source docs", "hide open-source docs", "noindex open source", "unpublish OSS site", "auto-generated wiki"] +--- + +Mintlify génère parfois un site de documentation directement à partir d'un dépôt open source public dans le cadre du [programme OSS](/fr/help-center/oss-program-plan-and-billing). Si un site a été généré pour un projet que vous maintenez et que vous souhaitez le supprimer ou le masquer aux moteurs de recherche, choisissez l'option qui correspond à votre besoin. + +## Retirer complètement le site + +Si vous souhaitez que le site généré automatiquement soit dépublié afin qu'il ne soit plus accessible, envoyez un e-mail à support@mintlify.com avec : + +- L'URL du site de documentation généré automatiquement. +- Le dépôt public à partir duquel le site a été généré. +- La confirmation que vous maintenez ou représentez le projet. Un message envoyé depuis une adresse e-mail associée au dépôt (par exemple, une adresse de mainteneur publiée dans le dépôt) aide le support à vérifier la propriété. + +Le support dépublie le déploiement. Cela retire le site de `mintlify.app` et arrête tout domaine personnalisé qui pointait vers lui. + +## Masquer le site aux moteurs de recherche et aux outils d'IA + +Si vous souhaitez garder le site en ligne mais l'empêcher d'apparaître dans les résultats de recherche ou d'être récupéré par les robots d'IA, ajoutez `noindex: true` au frontmatter de chaque page à masquer : + +```mdx +--- +title: "Page title" +noindex: true +--- +``` + +Les pages avec `noindex: true` sont rendues avec les balises meta robots `noindex, nofollow` et sont exclues de `llms.txt` et `llms-full.txt`. Consultez [Désactiver l'indexation](/fr/optimize/seo#disable-indexing) pour le comportement complet. + +Pour masquer toutes les pages en une seule fois, définissez la balise meta robots au niveau du projet dans `docs.json` : + +```json +{ + "metatags": { + "robots": "noindex" + } +} +``` + +Appliquer `noindex` sur un site généré automatiquement retire ses pages à la fois de la recherche interne du site et des résultats des moteurs de recherche publics après le prochain déploiement. + +## Reprendre le site au lieu de le supprimer + +Si vous préférez conserver le site généré automatiquement et le maintenir vous-même, envoyez un e-mail à support@mintlify.com et demandez que le déploiement soit transféré à votre organisation Mintlify. Une fois transféré, vous pouvez modifier le contenu, le connecter à votre propre dépôt Git, ou postuler au [programme OSS](/fr/help-center/oss-program-plan-and-billing) pour que le déploiement fonctionne sur une formule Pro sponsorisée. diff --git a/help-center/oss-program-plan-and-billing.mdx b/help-center/oss-program-plan-and-billing.mdx index 15d3b0c80..e1fb539f1 100644 --- a/help-center/oss-program-plan-and-billing.mdx +++ b/help-center/oss-program-plan-and-billing.mdx @@ -8,7 +8,7 @@ The Mintlify OSS Program sponsors documentation hosting for qualifying open-sour ## What an enrolled project runs on -An enrolled deployment runs on the [Pro plan](https://mintlify.com/pricing?ref=oss-program) with a 100% sponsorship discount applied at the organization level, so the recurring cost is $0. Enrolled deployments keep every Pro feature — including the [assistant](/assistant/index), [analytics](/analytics/index), and [custom domain](/customize/custom-domain) — for the duration of the sponsorship. +An enrolled deployment runs on the [Pro plan](https://mintlify.com/pricing?ref=oss-program) with a 100% sponsorship discount applied at the organization level, so the recurring cost is $0. Enrolled deployments keep every Pro feature for the duration of the sponsorship, including the [assistant](/assistant/index), [analytics](/analytics/index), and [custom domains](/customize/custom-domain). The OSS Program is not a separate plan in the dashboard. Enrollment is tracked as a discount on the Pro plan, so the billing page shows the Pro plan with a `MINT-OSS` discount that brings the total to zero. @@ -17,7 +17,7 @@ The OSS Program is not a separate plan in the dashboard. Enrollment is tracked a The most common situations that require support intervention: - **Your project dropped to the Hobby plan after a paid trial ended.** Starting a paid trial on top of an OSS-enrolled deployment can end the sponsorship when the trial expires, leaving the deployment on Hobby instead of returning it to Pro. Contact support@mintlify.com from an email associated with the organization and reference the deployment. Support can re-apply the OSS sponsorship. -- **You were charged while expecting to be on the OSS Program.** Sponsorship is applied per organization and per plan. If the discount is missing — for example, after switching plans, changing organizations, or completing a trial — the Pro plan bills at its normal price. Contact support@mintlify.com with the organization name and the affected invoices; support can re-apply the sponsorship and review past charges. +- **You were charged while expecting to be on the OSS Program.** Sponsorship is applied per organization and per plan. If the discount is missing, for example after switching plans, changing organizations, or completing a trial, the Pro plan bills at its normal price. Contact support@mintlify.com with the organization name and the affected invoices; support can re-apply the sponsorship and review past charges. - **You received a "You're in! Mintlify's OSS Program" email but do not see a change on your deployment.** Reply to that email or contact support@mintlify.com so support can confirm which organization and deployment the sponsorship was applied to. Include this information when you contact support: diff --git a/zh.json b/zh.json index 40df645b9..2817c45d9 100644 --- a/zh.json +++ b/zh.json @@ -462,7 +462,9 @@ "pages": [ "zh/help-center/openapi-url-fetch-fails-during-build", "zh/help-center/domain-already-claimed-by-another-organization", - "zh/help-center/configure-oauth-with-auth0" + "zh/help-center/configure-oauth-with-auth0", + "zh/help-center/oss-program-plan-and-billing", + "zh/help-center/remove-auto-generated-oss-docs" ] } ] diff --git a/zh/help-center/oss-program-plan-and-billing.mdx b/zh/help-center/oss-program-plan-and-billing.mdx new file mode 100644 index 000000000..d34c107f9 --- /dev/null +++ b/zh/help-center/oss-program-plan-and-billing.mdx @@ -0,0 +1,36 @@ +--- +title: "关于 Mintlify OSS 计划" +description: "OSS 计划如何为开源项目赞助文档托管、已加入项目所运行的方案，以及在账单看起来有误时应如何处理。" +keywords: ["OSS Program", "open source program", "OSS plan", "sponsored plan", "open-source docs", "MINT-OSS", "OSS billing", "trial ended OSS", "OSS refund"] +--- + +Mintlify OSS 计划为符合条件的开源项目赞助文档托管。本文介绍已加入的项目所运行的方案、账单与预期不符时应如何处理，以及如何就资格问题联系团队。 + +## 已加入项目所运行的方案 + +已加入的部署运行在 [Pro plan](https://mintlify.com/pricing?ref=oss-program) 上，并在组织级别应用 100% 的赞助折扣，因此定期费用为 $0。在赞助有效期内，已加入的部署保留所有 Pro 功能，包括[助手](/zh/assistant/index)、[分析](/zh/analytics/index)和[自定义域名](/zh/customize/custom-domain)。 + +OSS 计划在控制台中不是单独的方案。加入状态以 Pro 方案的一项折扣来记录，因此账单页面会显示 Pro 方案并附带一个 `MINT-OSS` 折扣，将总额降为零。 + +## 当账单与预期不符时 + +以下是最常见需要支持团队介入的情况： + +- **付费试用结束后，你的项目被降级到 Hobby plan。** 在已加入 OSS 的部署上启动付费试用，可能会在试用到期时终止赞助，使部署停留在 Hobby 方案，而不是恢复到 Pro。请从与该组织关联的邮箱发送邮件至 support@mintlify.com，并注明相关部署。支持团队可以重新应用 OSS 赞助。 +- **你原本预期在 OSS 计划中，却被收取了费用。** 赞助按组织和方案分别应用。如果折扣缺失，例如在切换方案、更换组织或完成试用之后，Pro 方案会按常规价格计费。请通过 support@mintlify.com 联系支持团队，并提供组织名称和受影响的发票；支持团队可以重新应用赞助并审核过往费用。 +- **你收到了 "You're in! Mintlify's OSS Program" 邮件，但在部署上看不到任何变化。** 请回复该邮件或联系 support@mintlify.com，以便支持团队确认赞助被应用到了哪个组织和部署。 + +联系支持团队时请附上以下信息： + +- 组织和部署，格式为 `app.mintlify.com//`。 +- 该开源项目的公共仓库 URL。 +- 与你的 Mintlify 账户关联的邮箱地址。 +- 你希望审核的任何费用对应的发票 ID 或日期。 + +## 申请加入计划或咨询资格 + +Mintlify 团队按具体情况逐一审核资格。要申请或询问某个项目是否符合条件，请发送邮件至 support@mintlify.com，附上仓库 URL、项目简要说明，以及你希望应用赞助的 Mintlify 组织。 + +## 为开源项目自动生成的文档 + +作为 OSS 计划推广工作的一部分，Mintlify 有时会直接根据一个公共仓库生成文档站点。如果为你维护的项目生成了这样的站点，而你希望将其下线、从搜索中隐藏或转移到你的组织，请参见[移除或隐藏自动生成的 OSS 文档站点](/zh/help-center/remove-auto-generated-oss-docs)。 diff --git a/zh/help-center/remove-auto-generated-oss-docs.mdx b/zh/help-center/remove-auto-generated-oss-docs.mdx new file mode 100644 index 000000000..60664e739 --- /dev/null +++ b/zh/help-center/remove-auto-generated-oss-docs.mdx @@ -0,0 +1,46 @@ +--- +title: "移除或隐藏自动生成的 OSS 文档站点" +description: "下线由 Mintlify 为开源项目生成的文档站点，或在不删除的情况下将其从搜索引擎和 AI 工具中隐藏。" +keywords: ["auto-generated docs", "OSS docs removal", "remove open source docs", "hide open-source docs", "noindex open source", "unpublish OSS site", "auto-generated wiki"] +--- + +作为 [OSS 计划](/zh/help-center/oss-program-plan-and-billing)的一部分，Mintlify 有时会直接根据一个公共开源仓库生成文档站点。如果为你维护的项目生成了这样的站点，而你希望移除它或将其从搜索中隐藏，请选择符合你需求的方案。 + +## 完全下线该站点 + +如果你希望将自动生成的站点取消发布，使其不再可访问，请发送邮件至 support@mintlify.com，并附上： + +- 自动生成的文档站点的 URL。 +- 该站点所依据的公共仓库。 +- 你维护或代表该项目的确认信息。使用与该仓库关联的邮箱（例如仓库中公开的维护者邮箱）发送邮件有助于支持团队核实所有权。 + +支持团队会取消发布该部署。此操作会将站点从 `mintlify.app` 移除，并停止任何指向它的自定义域名。 + +## 将站点从搜索引擎和 AI 工具中隐藏 + +如果你希望保留站点在线，但阻止它出现在搜索结果中或被 AI 爬虫抓取，请在你想要隐藏的每个页面的 frontmatter 中添加 `noindex: true`： + +```mdx +--- +title: "Page title" +noindex: true +--- +``` + +设置了 `noindex: true` 的页面会附带 `noindex, nofollow` 的 robots meta 标签渲染，并被排除在 `llms.txt` 和 `llms-full.txt` 之外。完整行为请参见[禁用索引](/zh/optimize/seo#disable-indexing)。 + +要一次性隐藏所有页面，请在 `docs.json` 中设置项目级的 robots 元标签： + +```json +{ + "metatags": { + "robots": "noindex" + } +} +``` + +在自动生成的站点上应用 `noindex` 后，在下次部署之后，其页面会同时从站点自身的搜索和公共搜索引擎结果中移除。 + +## 接管站点而非移除 + +如果你希望保留自动生成的站点并自行维护，请发送邮件至 support@mintlify.com，请求将该部署转移到你的 Mintlify 组织。转移完成后，你可以编辑内容、将其连接到你自己的 Git 仓库，或申请加入 [OSS 计划](/zh/help-center/oss-program-plan-and-billing)，让该部署在受赞助的 Pro 方案上运行。