CNCF Tech Doc Recommendations: Umbrella Issue
维护者通常 3 天内回复
@lakxy 已经在做这个了。
开始于 2025年10月29日。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 领域
- content, documentation
调研方向
从 cncf/techdocs/analyses/0015-knative/ 中的分析以及链接的 CNCF Tech Docs issue 315 开始，然后查看未勾选的 graphics sub-issue 6310。该 issue 未指定任何文件或测试；完成标准仅被描述为执行建议并持续更新此 checklist。
由索引模型根据 Issue 内容生成。
描述
FEATURE REQUEST: ☂ CNCF Tech Doc Recommendations
Overview
This is a checklist for the CNCF technical documentation analysis and implementation plan. It should be updated as sub-issues are added, completed, or otherwise modified.
This issue tracks recommended changes resulting from an analysis of the Knative documentation commissioned by CNCF. The analysis and supporting documents are here: https://github.com/cncf/techdocs/tree/main/analyses/0015-knative/
The CNCF Knative documentation effort is tracked in the CNCF Tech Docs repo:
https://github.com/cncf/techdocs/issues/315
🗞️ Sub-issues
This is a list of issues representing the recommended work on the Knative website(s) and technical documentation.
✏️ Separate technical documentation from the project page
The Knative project [landing page] redirects to the doc page:
https://knative.dev/docs/.
It's helpful to users if there's a clear separation between technical
documentation and other information. The technical documentation is goal-driven
and should be factual, specific, and purposeful.
Separate the technical documentation from the project landing page.
✏️ Rename pages
Audit page and heading titles for consistency and accuracy.
✏️ Update technical overview
Write a conceptual overview of Knative where the "Concepts"
section is in the current documentation, but be much more comprehensive.
✏️ Update Installation to better orient users
Add "roadmap" information to orient readers in the Installation section of the
documentation.
✏️ Reorganization issues
This issue suggests several changes to the documentation's organization to
improve usability and consistency.
✏️ Document the kn CLI on the site
The kn CLI documentation is maintained in the
[/knative/kn] repo, except for the install instructions, which are on the doc
site.
Consolidate the kn CLI documentation so that it's maintained in one place.
✏️ Revise the Security and threat disclosure page
The [Knative Security and Disclosure Information] page has some misleading and
confusing elements. Rewrite the introduction to this page so that it's clear
what procedures and information are available.
✏️ Add a glossary
Add a glossary of terms to the technical documentation.
✏️ Review graphics
Review the graphics on the site to make sure they meet these criteria:
-
Does the graphic enhance understanding? Does it add information that can't be
conveyed in a few words? -
Is the graphic placed in context by the surrounding text?
-
Does the graphic's size and aspect ratio enable proper placement and text flow
on a variety of screens sizes? -
Is the graphic maintainable: Will it require frequent updating for
localization, software updates, or interface changes?
✏️ Edit for conformance to style guide
Edit the website for conformance to the [Knative style guide].
✏️ Improve troubleshooting
Improve Knative troubleshooting instructions by adding explanations.
✏️ Fill out the Eventing API
Improve the explanations in the Eventing API.
✏️ Write a Getting Started page
Write a getting started page to orient new users, with meta information
about what to expect and where to go on the documentation site.
✏️ Make install downloads findable
Move and relabel the download file section so that the files are easy to find.
✏️ Truncate search results
Displaying the entire page text of each search result hinders users' ability to find their result.
Configure the Search to truncate results after 100 characters or so.
- 主要语言
- HTML
- 星标
- 5.1k
- 派生
- 1.3k
- 平均合并
- 2 天 1 小时
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
knative/docs 的其他 Issue
-
chore: broken link of kserve documentation可能已有人在做 @githarshil 于 4 天前认领。 未关闭kind/bug kind/documentation kind/good-first-issue
难度 1/5 1 小时以内 新手友好度 88/100
knative/docs#6708 · 3 条评论 · 已指派 1 人 ·
维护者通常 3 天内回复
-
lifecycle/stale
难度 1/5 1 小时以内 新手友好度 35/100
维护者通常 3 天内回复
-
Enhancement Proposal: Improve Code Block Language Specifiers Across Documentation可能重新可做 关联的 PR 已关闭且未合并。 未关闭triage/accepted
难度 4/5 3-5 天 新手友好度 58/100
维护者通常 3 天内回复
-
bug: the net-istio documentation is outdated in the case of the knative operator.可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭kind/bug triage/accepted
难度 4/5 3-5 天 新手友好度 35/100
维护者通常 3 天内回复
-
lifecycle/frozen triage/accepted
难度 4/5 3-5 天 新手友好度 25/100
维护者通常 3 天内回复
相似的 Issue
-
[good first issue, hacktoberfest] 🏯 Hacktoberfest Task - Add new Japan Fact 898 (good-first-issue)未关闭community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1 小时以内 新手友好度 86/100
lingdojo/kana-dojo#33145 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 75/100
career-ops-hq/career-ops#5921 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 86/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 75/100
defold/asset-portal#362 ·
-
tool-submission
难度 1/5 1 小时以内 新手友好度 75/100
BraveOPotato/NoSignups#2238 ·