openshift-docs

用途

OpenShift 文档技能用于搜索和阅读预生成的 OpenShift Container Platform（OCP）文档。当用户提出关于 OpenShift 功能、配置、安装、故障排查或任何 OCP 特定主题的问题时（包括 Operator、Route、Service、oc 命令行、RBAC、网络、存储、集群管理等），可使用该技能。

主要能力

• 提供本地存储的 OpenShift Container Platform 文档，格式为 GitHub 风格的 Markdown。
• 文档由官方 openshift/openshift-docs 仓库的 AsciiDoc 源文件转换而来，存放在本地 docs/ 目录下。
• 支持按版本浏览和检索文档，并通过 AGENTS.md 索引定位具体文件。

该技能特别强调：对于 OpenShift 相关任务，应优先采用“以检索为依据的推理”，而非“以预训练数据为依据的推理”，即应阅读被引用的文件，而不要依赖可能已过时的训练数据。

使用方式

快速开始包含以下步骤。

1. 发现可用版本（Discover available versions）：

ls docs/

1. 浏览和阅读文档（Browse and read docs）：从 AGENTS.md 索引开始。

# Read the doc index
cat docs/4.22/AGENTS.md

# Search the index for a topic
grep -i "networking" docs/4.22/AGENTS.md

# Read a specific doc
cat docs/4.22/networking/index.md

参考资料

references/openshift.md — 文档结构、常见路径、搜索技巧。

适用场景

• 用户询问 OpenShift Container Platform 的功能与配置。
• 用户需要 OCP 的安装、故障排查指导。
• 涉及 Operator、Route、Service、oc、RBAC、网络、存储、集群管理等 OCP 特定主题。

限制与注意事项

• 该技能为只读（read-only）：文档从本地文件读取，不会被修改。
• 文档通过 make docs VERSION=X.Y 预生成并提交到仓库。
• 应使用 AGENTS.md 作为定位具体文档文件的起点。
• 关于文档所覆盖的具体版本号、更新时间、授权许可等信息暂未提供。