菜单
开源 RSS
上次评审时间:2024 年 9 月 3 日

重复使用内容

在某些有限的情况下,在多个位置重复使用内容可能会很有用。例如,用于向仪表盘添加面板的过程适用于开源产品和企业版产品。

Grafana 网站支持从片段到整个目录的内容重复使用。

开始之前

在开始重复使用内容之前,了解其中的权衡很重要。重复使用内容会引入维护开销,这些开销可能大于维护单独内容的开销。

您可以通过以下方式重复使用内容

  1. 链接到权威内容
  2. 定义网站范围的文本
  3. 将内容共享到学习路线
  4. 共享内容块
  5. 挂载内容目录

以下各节详细讨论了每个选项。

您可以链接到权威来源,而不是将内容直接包含在文档中。

优点

  • 您可以立即重复使用内容。

缺点

  • 您无法控制内容。

    如果权威内容发生更改,您的链接可能需要更新。

  • 链接的内容可能会导致页面更复杂,可能会让读者感到困惑。

  • 用户可能会因为点击链接到另一个页面或章节而失去上下文。

    此问题尚未通过用户体验研究验证。

对于应在整个站点中保持一致的文本,请使用 docs/copy 短代码。

将内容共享到学习路线

对于学习路线中的文本,请使用 shared 短代码

短代码不需要像 将内容块共享到其他项目 那样创建新的无头页面。

只有学习路线应重复使用通过 shared 短代码共享的内容。

共享内容块

您可以使用 docs/shared 短代码重复使用内容块。为此,请参阅重复使用共享内容

优点

  • 您可以重复使用少量内容。
  • 您可以在一个地方维护内容。
  • 您可以将共享内容与其他内容组合。

缺点

  • 您需要执行初始设置以创建共享内容。

挂载内容目录

您可以使用 Hugo 挂载重复使用整个内容目录。为此,请参阅使用 Hugo 挂载重复使用内容目录

通过此选项,您可以共享内容和结构。每个页面都具有完全相同的标题结构。如果您的页面结构需要灵活性,则需要改用其他选项。

优点

  • 您可以轻松地重复使用大量内容。
  • 您可以在一个地方维护内容。

缺点

  • 页面中没有条件文本。

    条件文本会使源文件复杂化,并使外部贡献者难以理解,因此未实现。

  • 您必须维护每个链接的两个目标。

    特别是,您希望对于在 OSS 文档和 Grafana Cloud 文档之间重复使用的内容,链接保持在每个文档集中,而不是让重复使用的内容链接回 OSS 文档。

    为此,请使用 ref URI

    如果两个页面都链接到同一位置,则重复使用的文档中可能不应存在该链接,这表明该文档不适合重复使用。

  • 您可能需要排除挂载目标中不适合的某些文件。