跳转至

Configure Documentation Provider(配置文档提供器(Documentation Provider))

The public Palantir documentation ↗ is mirrored in the Palantir platform. This can be useful for customers who may not have access to the Internet while using the platform.

Configuration

To configure the documentation provider, open Control Panel and navigate to Enrollment Settings > Support > Documentation. The selected settings will apply to any user of an organization within this enrollment. Changes can take up to 10 minutes to propagate to all users.

You can choose between the following options for the documentation provider:

Public documentation website

If the public documentation website is selected as documentation provider, users navigating to ${YOUR_WORKSPACE_URL}/docs will be automatically redirected to the palantir.com/docs public website. If navigating to a specific page of documentation, the user will be redirected to that specific page on the public website.

This is the recommended setting for most customers, as documentation updates are generally available on the public website before the in-platform mirror.

If users are not expected to have Internet access while using the Palantir platform, consider using the in-platform mirror configuration option.

In-platform mirror

If the in-platform mirror option is selected, users navigating to ${YOUR_WORKSPACE_URL}/docs will see documentation content served from an in-platform mirror of the public documentation website. This is useful if users are not expected to have Internet access to the Internet while using the Palantir platform.

This option may not be available to all customers. If you are interested in this option and it appears to be unavailable, contact your Palantir representative.


中文翻译


配置文档提供器(Documentation Provider)

Palantir公开文档 ↗ 已在Palantir平台内置镜像,对于使用平台时无法访问互联网的客户而言十分实用。

配置

要配置文档提供器,打开控制面板(Control Panel),导航至注册设置(Enrollment Settings) > 支持(Support) > 文档(Documentation)。所选设置将作用于该注册下所属组织的所有用户,变更最多需要10分钟才能同步到所有用户。

您可以从以下文档提供器选项中进行选择: * 公开文档网站 * 平台内置镜像

公开文档网站(Public documentation website)

如果选择公开文档网站作为文档提供器,用户访问 ${YOUR_WORKSPACE_URL}/docs 时将自动重定向至 palantir.com/docs 公开网站。如果用户访问的是某一特定文档页面,将被重定向到公开网站的对应页面。

这是推荐大多数客户使用的设置,因为公开网站的文档更新通常会早于平台内置镜像发布。

如果用户使用Palantir平台时无法访问互联网,建议考虑使用平台内置镜像配置选项。

平台内置镜像(In-platform mirror)

如果选择平台内置镜像选项,用户访问 ${YOUR_WORKSPACE_URL}/docs 时将看到由公开文档网站的平台内置镜像提供的文档内容。该方案适用于用户使用Palantir平台时无法访问互联网的场景。

该选项并非面向所有客户开放。如果您有使用该选项的需求但发现其不可用,请联系您的Palantir客户代表。