Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Document: a component reference to a draft stores its published component

已关闭 适合新手
#262 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
68/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

issue 描述了组件位置、页面数据和 {component}/usage 的 API 行为,但没有指出文档文件或测试。首先查找有关组件位置和页面数据的 API 文档,然后检查其中如何描述相关组件引用和使用次数。完成标准是文档说明草稿解析、首次发布时的标识,以及使用情况响应和计数规则。

由索引模型根据 Issue 内容生成。

描述

From api-components-bundle #520 / PR https://github.com/components-web-app/api-components-bundle/pull/523.

For the API section (component positions and page data):

  • A component position, or a page-data component property, never holds a draft of a published component. When a write names such a draft's IRI (POST/PATCH /_/component_positions, positions embedded in a component write, a page-data PATCH, fixtures), the published component is stored instead, because the two resolve to the same thing. Admins still see the draft through the position, as before.
  • A never-published draft is stored as is. Its first publish keeps the same row and IRI, so every reference to it stays.
  • GET {component}/usage returns {positionCount, pageDataCount, total}. The total counts a published component and its draft once.
主要语言
TypeScript
星标
0
派生
0
平均合并
1 小时 20 分钟
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

components-web-app/docs 的其他 Issue

查看 components-web-app/docs 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。