菜单
开源
上次审阅时间:2024 年 6 月 26 日

通过 Hugo mounts 重用内容目录

注意

只有 Grafana Labs 员工才能执行以下任务。

在 Hugo 执行构建之前,它会读取 Hugo 模块 mounts 配置以构建虚拟文件系统。每个 mount 会将源目录挂载到该文件系统中的目标目录。您可以使用 Hugo mounts 在已发布的技术文档的另一部分重用整个目录的内容。

开始之前

  • 确定您要重用的内容目录。

  • 确定要排除的任何页面。通常,排除的页面是在目标目录上下文中没有意义的页面。

    警告

    目录中的页面可能包含指向其他页面的相对链接,这些链接会因其排除而损坏。

    如果排除的页面在目标目录中被其他页面替换,则相对链接仍然有效。

    否则,您应将链接设为绝对链接,以便它们始终指向源目录中的页面。

步骤

重用共享目录

  1. 确定源目录和目标目录。

    源目录是 website 存储库中目录的路径。它始终带有路径前缀 content/docs/。URL https://grafana.org.cn/docs/grafana-cloud/ 处所有 Grafana Cloud 内容的源目录是 content/docs/grafana-cloud

    类似地,目标目录带有路径前缀 content/docs。对于目标 URL https://grafana.org.cn/docs/target-directory/,路径是 content/docs/target-directory

  2. 对于源目录中的每个页面,使用 canonical front matter 将规范 URL 设置为已发布的开源页面 URL。

    canonical front matter 指示重复或非常相似页面的首选 URL。更多信息,请参阅规范

  3. 更新网站存储库 Hugo 配置。

    配置位于 website 存储库的 config/_default/config.yaml 文件中。

    将 mount 添加到 YAML 配置中的 docs.manual_mount 键。

    例如,将源目录 content/docs/source-directory 挂载到 content/docs/target-directory,并排除 content/docs/source-directory/_index.md 文件

    yaml
    - source: content/docs/source-directory
      target: content/docs/target-directory
      excludeFiles:
        - /_index.md