
文档教程云原生【免费下载链接】docsUser documentation for Knative components.项目地址https://gitcode.com/gh_mirrors/docs1/docs点击查看免费下载本篇指南面向所有希望向 Knative 官方博客投稿的开发者与社区成员系统梳理 Knative 博客的内容定位、投稿准备、选题规范、评审流程与发布节奏。读完本文你将掌握如何判断什么内容适合投稿、如何按规范提交一篇可被快速评审的博客文章、如何参与 Knative 每季度版本发布的社区宣传以及博客从 PR 到上线背后的评审机制包括lgtm/approved标签与 SLA 约定。博客的归属与内容定位Knative 博客由 DUX 工作组中创建博客文章是贡献什么What to contribute三类内容之一与创建新文档、创建代码示例并列。博客在 Knative 文档内容体系中是一种独立的内容类型。根据创建新文档中给出的内容类型表博客Blog的目标读者是对项目有基本理解、希望通过叙述性、经验性、非正式的方式来了解 Knative 的人其内容聚焦于三类主题作者亲身使用和配置 Knative 的经验尤其是具有新颖体验或独特视角的实践突出展示 Knative 特性的技术介绍讲述如何使用 Knative 完成某个任务或满足某个具体用例的教程型内容。与 Tasks任务和 Examples示例不同博客文章在上线发布后不会持续维护和测试其技术准确性——这是博客与正式文档最核心的区别投稿时需要注意内容须经得起时间的检验。博客领导团队与联系渠道博客内容由编辑团队把关具体分工如下技术编辑Technical EditorsLionel Villard、Evan Anderson负责技术准确性与内容深度文案编辑Copy EditorsAshleigh Brennan、Caroline Lee、María Cruz负责语言表达、风格与排版质量博客社区经理Blog Community ManagersMaría Cruz、Jonatas Baldin负责博客日常运营、社区沟通与发布排期。与团队沟通的首选渠道是 CNCF Slack 的#knative-documentation频道这是投稿过程中获得反馈、申请加速评审的主要通道。提交一篇博客文章分步操作任何人都可以撰写博客文章并提交评审但商业性内容Commercial content不允许出现在博客中。提交一篇博客文章的标准流程如下签署 Contributor License AgreementsCLA如果尚未签署需先完成 CLA 签署注意使用与git commit相同的邮箱地址这是所有贡献的前提条件。熟悉 Markdown 格式阅读文档仓库中已有的博客文章了解它们的结构与写法。博客文章按类别存放在不同目录中详见下文博客内容在仓库中的组织浏览这些目录可以找到大量可参考的实例。选择你习惯的文本编辑器撰写文章。可选借助 Markdown 工具如果对 Markdown 语法不熟悉可以参考 GitHub 的 Markdown 格式说明或使用 StackEdit 等在线编辑工具辅助写作。更新导航文件按Updating the Blog页面的说明更新导航配置确保新文章能出现在博客索引中具体机制见下文。为你的博客文章开启一个 Pull RequestPR。等待自动分配评审人PR 创建后会自动分配一位评审人评审人会检查你的提交、与你讨论反馈和细节当 PR 获得批准后文章将被排期发布。在 Slack 的 #knative-documentation 频道提醒编辑团队把刚创建的 PR 链接发到频道中方便团队及时跟进。提示遵循文档贡献者的 GitHub 工作流可以了解 fork、分支、PR 评审与 Prow 命令如/assign、/lgtm、/approve的完整使用方式这些同样适用于博客 PR。博客指南什么内容适合投稿适合的内容Suitable content仅限原创内容Original content only不接受转载或翻译内容Knative 新特性发布与项目更新教程与演示Tutorials and demos使用案例Use cases与特定厂商或平台相关、关于 Knative 安装和使用的具体内容。不适合的内容Unsuitable Content完全没有涉及 Knative 的博客不调用 Knative API 或接口的内容厂商推销性质的宣传内容Vendor pitches。与发布节奏对齐版本公告与深度剖析博客承担着向社区传递 Knative 项目动态的重要职责有两种典型的协作方式定期发布Scheduled releasesKnative 项目每3 个月发布一个新版本社区欢迎贡献者撰写文章向社区传达新版本的变化。理想情况下每个发布版本例如 1.8、1.9、1.10都应有一篇对应的博客文章。标题命名约定为Version [版本号] release - [日期]。版本公告文章的作者应撰写变更摘要并挑选当前版本中**最多 3 个亮点highlights**进行重点介绍。重大变更Big changes to the project项目层面的重大变更需要一篇深度剖析deep dive文章详细描述新特性的工作机制并给出新功能的实际示例。仓库中提供了两种可直接参考的范式发布公告模板_template-announcing-knative-v1-X-release.txt给出了完整的发布公告骨架包含 Front mattertitle、linkTitle、author、date、description、type: blog、目录结构Highlights、Serving、Eventing、Eventing Extensions、Client、Operator、Thank you contributors 等分节以及按Breaking or Notable Changes / New Features Changes / Bug Fixes组织的写作格式。已发布的真实示例announcing-knative-v1-23-release.md展示了完整落地的版本公告可以看到其结构开篇说明新版本已可用并引导读者进入安装文档随后按组件Serving、net-contour、net-gateway-api、net-istio、net-kourier、Eventing 等分别列出新特性、改进与 Bug 修复例如 Generic ephemeral volumes、EndpointSlice migration、IPv6 support 等并附上对应的 PR 链接与贡献者。评审流程与 SLA博客文章以 PR 形式提交后会被自动分配给一位评审人。每篇博客文章需要编辑团队中至少一人添加lgtm标签当必要的标签就位后其中一位评审人会添加approved标签并安排文章的发布时间。也就是说一篇博客 PR 从提交到可合并至少需要同时具备lgtm与approved两个标签。服务级别协议SLA博客文章的评审最长可能需要1 周时间。如果你希望申请加速评审expedited review请在通过 Slack 联系编辑团队时在你的留言中明确说明这一点。博客文章模板推荐的写作结构仓库提供了官方博客模板template-blog-entry.md其中封装了社区认可的写作最佳实践。模板建议的完整结构如下评论形式的评审追踪表Reviewer 追踪表在文章顶部以 HTML 注释形式放置评审记录表包含评审人 GitHub ID、日期与批准状态便于追溯评审过程。!-- | Reviewer | Date | Approval | | ------------------ | ---------- | ------------- | | !-- GitHub ID -- | YYYY-MM-DD | :1:, :monocle_face:, :-1: | --博客正文Blog content body开头先说明本文的目标——要介绍的特性是什么、如何使用该特性、对应的官方文档链接以及为什么它对读者有价值。正文可拆分为多个独立的步骤或小节每个小节都要有一句引入语说明该节的目的与结果并链接到涉及的新概念或相关文档。结果小节About results收尾时串联前文关键点复述整体目标与重要性。进一步阅读Further reading补充其他相关资源指明读者的下一步方向。关于作者About the author附上简短的作者自我介绍。模板还附带了可直接复制使用的无说明版本Copy the template投稿者可以复制该版本并填入自己的内容。博客内容在仓库中的组织与导航更新目录结构与 Front matter博客内容按类别归档在博客根目录下的四个子目录中docs/blog/articles/Knative 核心特性、工具与相关主题的技术文章docs/blog/releases/各版本发布公告每个版本一篇文章docs/blog/events/线上与线下社区活动预告与回顾docs/blog/steering/Steering Committee 与 TOC 的治理、技术方向与社区动态更新。已发布的真实文章例如get-started-knative-eventing.md、knative-eventing-eda-agents.md展示了成熟的博客写法开篇通常标注作者与身份然后介绍背景、用图表达架构流程、分步骤给出kubectl apply -f ...等可执行命令最后提供进一步阅读资源。发布公告类文章还会带 YAML Front matter 元数据title、author、date、description、type: blog。导航与 RSS 配置导航更新方面mkdocs.yml中的rss插件配置如下它决定了哪些目录下的文章会被纳入博客的 RSS 源rss: match_path: blog/(articles|steering|events|releases)/.* feeds_filenames: rss_created: blog/feed_rss_created.xml rss_updated: blog/feed_rss_updated.xml date_from_meta: as_creation: date datetime_format: %Y-%m-%d这解释了投稿时必须使用 Front matter 中date字段的原因RSS 源依赖该元数据来确定文章的创建日期格式为%Y-%m-%d。同时docs/blog/index.md是博客首页Featured Posts精选文章区域通过相对链接如articles/ai_functions_llama_stack.md指向具体文章新增博客时需要同步在此处登记并遵循导航与重定向规范维护好站内链接。本地预览与发布验证在提交 PR 前建议先本地预览渲染效果确保 Front matter、图片相对路径与 Markdown 格式均正确。网站基于 Material for MkDocs 构建有两种预览方式详见本地预览文档方式一Docker 容器推荐在仓库根目录执行./hack/docker/run.sh然后打开浏览器访问 http://localhost:8000编辑docs/blog/下的任何文件都会自动热重载完成后用CtrlC停止容器。如需完整构建所有版本的全站需先设置GITHUB_TOKEN环境变量执行./hack/docker/test.sh方式二本地 Python mkdocs CLI先安装依赖pip install -r requirements.txt再启动预览mkdocs serve --dirtyreload当看到Serving on http://127.0.0.1:8000的输出后即可访问预览。无论采用哪种方式提交 PR 后 PR 评论中都会自动出现一个可用的在线预览链接供评审人与作者共同确认效果。从投稿到上线的全流程总结回顾全文一篇 Knative 博客文章的生命周期可归纳为六个关键节点选题合规内容必须是原创、与 Knative 直接相关调用 Knative API 或接口不得是厂商推销准备就绪签署 CLA、参考博客模板与已有文章完成写作Front matter 带date元数据导航登记更新博客索引与导航配置确保文章可被 RSS 与精选列表收录提交 PR按GitHub 工作流开启 PR系统自动分配评审人评审通过获得至少一人lgtm与评审人approved标签正常 SLA 最长 1 周可申请加速排期发布批准后由社区经理安排发布时间在 #knative-documentation Slack 频道保持沟通。如果你正在关注某个即将到来的 Knative 版本或在使用 Knative 的过程中遇到了值得分享的实践与教训欢迎按照本文的规范提交你的第一篇博客文章——这是参与 Knative 社区建设、与全球开发者交流经验最直接的方式之一。赞分享文档教程云原生【免费下载链接】docsUser documentation for Knative components.项目地址https://gitcode.com/gh_mirrors/docs1/docs点击查看免费下载相关推荐TablePro 发布博客写作指南从草稿、配图到上线的完整工作流TablePro 发布博客写作指南从草稿、配图到上线的完整工作流 TablePro 把发布公告博客当作大版本发布流程的正式出口一篇 Markdown 文件即knowledge-repo 投稿快速上手从创建 Knowledge Post 到合并上线的完整工作流knowledge repo 投稿快速上手从创建 Knowledge Post 到合并上线的完整工作流 导读 本文围绕仓库中的 repository_read后端前端企业应用免费激活 Windows 与 Office一条命令无需产品密钥免费激活 Windows 与 Office一条命令无需产品密钥 几分钟时间一条命令全程免费屏幕右下角的未激活水印、Office 反复弹出的激活提示操作系统上一篇OpenToonz实战指南8个问题搞定2D动画软件的获取、构建与配置下一篇Faraday漏洞管理平台完整指南从发现到修复的全流程揭秘 创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考