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
4 changes: 2 additions & 2 deletions deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@
* **Scopes** (optional): Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Use multiple scopes if you need different access levels.
* **Additional authorization parameters** (optional): Additional query parameters to add to the initial authorization request.
* **Token URL**: Your OAuth token exchange endpoint.
* **Info API URL** (optional): Endpoint on your server that Mintlify calls to retrieve user info. Required for group-based access control. If omitted, the OAuth flow only verifies identity.

Check warning on line 107 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L107

Use 'endpoints?' instead of 'Endpoint'.
* **Logout URL** (optional): The native logout URL for your OAuth provider. When users log out, Mintlify validates the logout redirect against this configured URL for security. The redirect only succeeds if it exactly matches the configured `logoutUrl`. If you do not configure a logout URL, users redirect to `/login`. Mintlify redirects users with a `GET` request and does not append query parameters, so include any parameters (for example, `returnTo`) directly in the URL.

Check warning on line 108 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L108

Use 'logouts?' instead of 'Logout'.
* **Redirect URL** (optional): The URL to redirect users to after authentication.
5. Click **Save changes**.

Expand Down Expand Up @@ -137,7 +137,7 @@
- **Scopes**: `['provider.users.docs']`
- **Token URL**: `https://auth.foo.com/exchange`
- **Info API URL**: `https://api.foo.com/docs/user-info`
- **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`

Check warning on line 140 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L140

Use 'logouts?' instead of 'Logout'.

**Create a user info endpoint** at `api.foo.com/docs/user-info`, which requires an OAuth access token with the `provider.users.docs` scope, and returns:

Expand Down Expand Up @@ -471,5 +471,5 @@
| [Search](/assistant/index) | Full support | Full support, respects user groups | Full support, respects user groups |
| [Assistant](/assistant/index) | Full support | Full support, respects user groups | Full support, respects user groups |
| [skill.md](/ai/skillmd) | Full support | Not supported | Not supported |
| [Sitemap](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication, but excludes pages in groups | Available behind authentication, but excludes pages in groups |
| [robots.txt](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication | Available behind authentication |
| [Sitemap](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication, but excludes pages in groups | Publicly accessible. Anonymous visitors see only public pages. Authenticated users also see ungrouped pages. |
| [robots.txt](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication | Publicly accessible when any public pages exist |
4 changes: 2 additions & 2 deletions es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -503,5 +503,5 @@ Algunas funciones se comportan de manera diferente o no están disponibles cuand
| [Búsqueda](/es/assistant/index) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios |
| [Assistant](/es/assistant/index) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios |
| [skill.md](/es/ai/skillmd) | Compatibilidad completa | No compatible | No compatible |
| [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | Disponible tras autenticación, pero excluye las páginas en groups |
| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación |
| [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | De acceso público. Los visitantes anónimos solo ven las páginas públicas. Los usuarios autenticados también ven las páginas sin grupo. |
| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | De acceso público cuando existen páginas públicas |
4 changes: 3 additions & 1 deletion es/optimize/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,9 @@ Para incluir páginas ocultas en la indexación de búsqueda, añade `seo.indexi
```

<Note>
Para sitios de documentación que requieren autenticación, los sitemaps y los archivos `robots.txt` también requieren autenticarse para acceder a ellos. Los sitemaps excluyen las páginas que pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups).
Para sitios de documentación totalmente autenticados, los sitemaps y los archivos `robots.txt` también requieren autenticarse para acceder a ellos, y los sitemaps excluyen las páginas que pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups).

Para sitios parcialmente autenticados que incluyen páginas públicas, los sitemaps y los archivos `robots.txt` son de acceso público. Los visitantes anónimos solo ven las páginas públicas en el sitemap. Los usuarios autenticados también ven las páginas sin grupo.
</Note>

<div id="custom-sitemaps-and-robotstxt-files">
Expand Down
4 changes: 2 additions & 2 deletions fr/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -503,5 +503,5 @@ Certaines fonctionnalités se comportent différemment ou ne sont pas disponible
| [Search](/fr/assistant/index) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs |
| [Assistant](/fr/assistant/index) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs |
| [skill.md](/fr/ai/skillmd) | Prise en charge complète | Non pris en charge | Non pris en charge |
| [Sitemap](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification, mais exclut les pages dans des groupes | Disponible derrière l’authentification, mais exclut les pages dans des groupes |
| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification | Disponible derrière l’authentification |
| [Sitemap](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification, mais exclut les pages dans des groupes | Accessible publiquement. Les visiteurs anonymes ne voient que les pages publiques. Les utilisateurs authentifiés voient également les pages non groupées. |
| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification | Accessible publiquement lorsqu’il existe des pages publiques |
4 changes: 3 additions & 1 deletion fr/optimize/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,9 @@ Pour inclure les pages masquées dans l'indexation de recherche, ajoutez `seo.in
```

<Note>
Pour les sites de documentation qui nécessitent une authentification, les sitemaps et les fichiers `robots.txt` requièrent également une authentification pour y accéder. Les sitemaps excluent les pages appartenant à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups).
Pour les sites de documentation entièrement authentifiés, les sitemaps et les fichiers `robots.txt` requièrent également une authentification pour y accéder, et les sitemaps excluent les pages appartenant à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups).

Pour les sites partiellement authentifiés qui incluent des pages publiques, les sitemaps et les fichiers `robots.txt` sont accessibles publiquement. Les visiteurs anonymes ne voient que les pages publiques dans le sitemap. Les utilisateurs authentifiés voient également les pages non groupées.
</Note>

<div id="custom-sitemaps-and-robotstxt-files">
Expand Down
4 changes: 3 additions & 1 deletion optimize/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,9 @@ To include hidden pages in search indexing, add `seo.indexing` to your `docs.jso
```

<Note>
For documentation sites that require authentication, sitemaps and `robots.txt` files also require authenticating to access. Sitemaps exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).
For fully authenticated documentation sites, sitemaps and `robots.txt` files also require authenticating to access, and sitemaps exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).

For partially authenticated sites that include public pages, sitemaps and `robots.txt` are publicly accessible. Anonymous visitors see only public pages in the sitemap. Authenticated users also see ungrouped pages.
</Note>

### Custom sitemaps and robots.txt files
Expand Down
4 changes: 2 additions & 2 deletions zh/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -503,5 +503,5 @@ groups: ["admin"]
| [搜索](/zh/assistant/index) | 完全支持 | 完全支持,尊重用户分组 | 完全支持,尊重用户分组 |
| [AI 助手](/zh/assistant/index) | 完全支持 | 完全支持,尊重用户分组 | 完全支持,尊重用户分组 |
| [skill.md](/zh/ai/skillmd) | 完全支持 | 不支持 | 不支持 |
| [站点地图](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问,但会排除 groups 中的页面 | 需要通过认证后才能访问,但会排除 groups 中的页面 |
| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问 | 需要通过认证后才能访问 |
| [站点地图](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问,但会排除 groups 中的页面 | 可公开访问。匿名访客仅能看到公开页面;已认证用户还可以看到未分组的页面。 |
| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问 | 当存在公开页面时可公开访问 |
4 changes: 3 additions & 1 deletion zh/optimize/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,9 @@ Mintlify 会自动生成 `sitemap.xml` 和 `robots.txt` 文件。你可以在文
```

<Note>
对于需要认证的文档站点,站点地图和 `robots.txt` 文件也需要完成认证后才能访问。站点地图会排除属于 [用户分组](/zh/deploy/authentication-setup#control-access-with-groups) 的页面。
对于完全需要认证的文档站点,站点地图和 `robots.txt` 文件也需要完成认证后才能访问,且站点地图会排除属于 [用户分组](/zh/deploy/authentication-setup#control-access-with-groups) 的页面。

对于包含公开页面的部分认证站点,站点地图和 `robots.txt` 可公开访问。匿名访客只能在站点地图中看到公开页面,已认证的用户还可以看到未分组的页面。
</Note>

<div id="custom-sitemaps-and-robotstxt-files">
Expand Down
Loading