已开启
【GEO 优化】为文档补充元数据:description / keywords / changefreq 等 frontmatter 字段 #37
huangshijun创建于  6 天前
huangshijun
6 天前 创建

【GEO 优化】为文档补充元数据:description / keywords / changefreq 等 frontmatter 字段

一、背景

为提升 openEuler 文档在搜索引擎(SEO)与生成式 AI 引擎(GEO,Generative Engine Optimization,如 ChatGPT、DeepSeek、文心一言等)中的可发现性与引用准确率,文档中心正在为每篇发布到 docs.openeuler.org 的文档补充标准化元数据(frontmatter)。需要贵仓配合完成本仓文档的元数据补充。

补充后这些元数据将用于:

用途 生效位置
页面 <meta name="description"> / <meta name="keywords"> 搜索结果摘要、语义检索匹配
结构化数据 JSON-LD(TechArticle 的 author、datePublished 等) 搜索引擎富摘要、AI 引擎权威性判断(E-E-A-T)
sitemap.xml 的 changefreq / priority 搜索引擎与 AI 爬虫的抓取调度

二、需要做什么

在 docs/zh/ 与 docs/en/ 下、所有被 _toc.yaml 引用并发布到文档中心的 .md 文件顶部添加 YAML frontmatter。

  • 仅添加元数据,不改动正文内容(内容勘误、章节调整等请另行提交 PR);
  • 中英文文档需同步补充,英文文档的 description / keywords 使用英文;

三、字段规范

字段 必填 类型 约束与建议 用途
title 必填 string 默认取正文一级标题;仅当页面标题需要与正文 H1 区分时填写 页面 <title> / og:title
description 必填 string 一句话概括文档内容;陈述句,避免堆砌关键词、避免与正文首句完全重复 meta description,搜索结果与 AI 引用摘要
keywords 必填 string[] 3–5 个;覆盖组件名、技术领域、使用场景(如 [iSula, 容器引擎, 安全容器]);中英文文档各用自己的语言 meta keywords,语义检索增强
changefreq 建议填写 enum always / hourly / daily / weekly / monthly / yearly / never;默认 monthly;发布说明、FAQ 等高频更新文档建议 weekly sitemap.xml 更新频率
author 选填 string 作者或责任 SIG(如 CloudNative SIG、张三);未填写默认为 openEuler JSON-LD author,权威性信号
date 选填 date YYYY-MM-DD,文档首次发布日期 JSON-LD datePublished
priority 选填 number 0.0–1.0,默认 0.7;手册首页、高流量页面建议 0.8–1.0 sitemap.xml 优先级

四、示例

中文文档(docs/zh/.../isula_container_engine.md):

---
description: 介绍 iSula 容器引擎的安装、配置与常见操作,帮助用户在 openEuler 上快速构建轻量、安全的容器运行环境。
keywords: [iSula, 容器引擎, openEuler, 安全容器, 容器镜像]
changefreq: monthly
author: CloudNative SIG
date: 2026-10-13
priority: 0.8
---

# iSula 容器引擎

(正文内容不变……)

英文文档(docs/en/.../isula_container_engine.md):

---
description: Covers the installation, configuration, and common operations of the iSula container engine, helping you build a lightweight and secure container runtime on openEuler.
keywords: [iSula, container engine, openEuler, secure container, container image]
changefreq: monthly
author: CloudNative SIG
date: 2026-10-13
priority: 0.8
---

# iSula Container Engine

(Body content unchanged...)

五、注意事项

  1. frontmatter 必须从文件第一行的 --- 开始,YAML 语法需正确(可用 yq / yamllint 校验);
  2. keywords 推荐数组格式 [a, b, c],逗号分隔的字符串也可识别;值中含 :、# 等特殊字符时需加引号;
  3. overview 为文档中心保留字段(用于标识章节总览页),请勿使用;layout、sidebar 等 VitePress 保留字段同样请勿设置;
  4. 同一仓库多版本目录(如 docs/zh/24.03_LTS_SP2/、docs/zh/master/)中的同名文档请一并补充;
  5. frontmatter 与正文之间保留一个空行。

如有疑问欢迎在本 issue 下讨论。感谢配合!

likedislike
openeuler-ci-botopeneuler-ci-bot成员
6 天前 将 persimmonzzz、MrRlu、solarhu、Gemshunter、yangzhao_kl、hjx_gitff、byrobins、luanjianhai、snoweay、lostway1 设为负责人
openeuler-ci-botopeneuler-ci-bot成员
6 天前 添加了label:sig/sig-ops
openeuler-ci-bot
openeuler-ci-bot成员
6 天前 评论:

Welcome To openEuler Community

Hey @persimmonzzz , thanks for your contribution to the community.

Bot Usage Manual

I'm the Bot here serving you. You can find the instructions on how to interact with me at Here . That means you can comment below every pull request or issue to trigger Bot Commands. You can self-configure the PR merge rules for this repository. For more details, please refer to Here.

Contact Guide

If you have any questions, please contact the SIG: sig-ops ,
and any of the maintainers: @Gemshunter, @MrRlu, @byrobins, @hjx_gitff, @lostway1, @luanjianhai, @snoweay, @solarhu, @yangzhao_kl ,
and any of the committers: @Vchanger, @byrobins, @hongwentakkk1, @m0_58016603, @wangfenglai, @webankto, @weli1, @xuhou, @yaozhenhe .

likedislike