Decouple build artifact naming from RFC "seriesInfo" metadata
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
调研方向
Start with openid/fapi/build-all.py and the markdown2rfc container's make.sh entrypoint, which both derive output names from seriesInfo.value. Trace how build metadata and output names flow into HTML and XML generation, then check the openid/publication checks. Done means documents without a seriesInfo block build with OIDF naming, existing identifiers and artifacts remain intact, and rendered output has no unintended IETF metadata.
由索引模型根据 Issue 内容生成。
描述
Problem
The FAPI build pipeline currently depends on the "seriesInfo.value" field to determine output filenames.
This dependency exists in two places:
- "openid/fapi/build-all.py" extracts the output basename from a "value = "..."" line.
- The "danielfett/markdown2rfc" container's "make.sh" entrypoint uses "grep -m1 value" for the same purpose.
This forces OpenID Foundation documents to include RFC-specific "seriesInfo" metadata solely to make the build succeed.
For example, FAPI 2.0 Implementation Advice currently declares "name = "Internet-Draft"", although it is not an IETF Internet-Draft.
Proposed changes
- Decouple output filename generation from "seriesInfo". Derive the document basename from the source filename and the draft revision from the document title or explicitly configured build metadata.
- Pass the output basename explicitly to the Markdown-to-HTML conversion pipeline, bypassing or updating the container entrypoint's reliance on "grep".
- Maintain backward compatibility for existing FAPI documents that currently use "seriesInfo.value".
- Ensure the generated HTML and XML do not incorrectly identify OIDF documents as IETF Internet-Drafts or Standards Track documents.
- Preserve the existing manifest, HTML filename normalization, and XML artifact generation.
Acceptance criteria
- Existing FAPI documents continue to build without changing their published document identifiers.
- A document without a "[seriesInfo]" block builds successfully.
- The output filename follows the OIDF specification naming conventions.
- The rendered HTML contains no unintended IETF Internet-Draft metadata or boilerplate.
- The generated artifacts pass the "openid/publication" checks.
References
- "OIDF Naming and Contents of Specifications" (https://openid.net/wg/resources/naming-and-contents-of-specifications/)
- "OIDF Publication Error Modes" (https://github.com/openid/publication/blob/main/ERROR-MODES.md)
- "FAPI build-all.py" (https://github.com/openid/fapi/blob/master/build-all.py)
- "markdown2rfc make.sh" (https://github.com/oauthstuff/markdown2rfc/blob/master/make.sh)
- "RFC 7991 §2.47" (https://www.rfc-editor.org/rfc/rfc7991#section-2.47)
- 主要语言
- HTML
- 星标
- 5
- 派生
- 3
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
openid/fapi 的其他 Issue
-
component: FAPI 1: Advanced migrated-from-bitbucket priority: major type: bug
难度 2/5 1-3 小时 新手友好度 62/100
-
migrated-from-bitbucket priority: trivial type: bug
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 5/5 一周以上 新手友好度 35/100
-
Add support for resource-server constrained grant status queries for asynchronous delivery use cases未关闭
难度 5/5 一周以上 新手友好度 8/100
-
难度 5/5 一周以上 新手友好度 20/100
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 61/100
JWhite212/SignalLadder#215 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 90/100
yegor256/antlr2ebnf-maven-plugin#155 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
canonical/craft-actions#146 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
lucide-icons/lucide#5165 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
sillsdev/SIL.TextEditing#164 ·
维护者通常 1 天内回复