Prepare FAPI 2.0 Implementation Advice for informational publication

未关闭
#886 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
html
领域
documentation

调研方向

Start with the document’s front matter and publication build in build-all.py, then review the linked FAPI 2.0 Implementation Advice source and the OIDF naming and publication check references. Check how the document identifier and output filenames are set before removing seriesInfo, and review status language, normative recommendations, Notices, acknowledgements, security considerations, references, and history. Done means the informational OIDF document builds without inappropriate IETF metadata and passes the publication checks.

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

描述

Background

We would like to publish "FAPI 2.0 Implementation Advice" (https://github.com/openid/fapi/blob/master/FAPI_2_0_Implementation_Advice.md) at https://openid.net/specs/.

Since this document provides implementation advice rather than defining a normative security profile, it should be published as an informational document, not as a Standards Track specification.

The current metadata and some aspects of the document need to be corrected before publication.

  1. Correct the document metadata

The current front matter contains:

title = "FAPI 2.0 Implementation Advice"
abbrev = "fapi-2-implementation-advice"
ipr = "none"
workgroup = "connect"

[seriesInfo]
name = "Internet-Draft"
value = "fapi-2_0-implementation_advice-01"
status = "standard"

The following changes are needed:

  • "workgroup": Change "connect" to "fapi".
  • "seriesInfo.name": Remove "Internet-Draft". This is not an IETF Internet-Draft. "Informational" should not be substituted as the series name, since it describes a document category rather than a publication series.
  • "seriesInfo.status": The current "standard" value incorrectly identifies the document as Standards Track. The generated document should clearly identify its informational nature.
  • "seriesInfo": Prefer removing the entire block, since this is an OIDF publication rather than an RFC or IETF Internet-Draft. The document identifier and output filename should be managed independently.
  • "ipr": Keep "ipr = "none"" to suppress IETF-specific IPR boilerplate. OIDF copyright and licensing notices must remain in the document.

Note that the current FAPI build pipeline relies on "seriesInfo.value" for output filenames. Removal of "seriesInfo" therefore depends on fixing that build dependency separately.

See "build-all.py" (https://github.com/openid/fapi/blob/master/build-all.py).

  1. Clarify the document's status

The document should clearly distinguish:

  • Its type: Informational implementation guidance.
  • Its publication status: Working Group Draft or another applicable OIDF publication stage.

In particular, the document should not imply that it is an OIDF International Standard or an IETF Standards Track document.

The title, document identifier, revision number, and draft disclaimer should be aligned with the intended publication stage and OIDF naming conventions.

  1. Review normative language

Some sections, particularly the HTTP header recommendations, contain normative requirements using "shall" and "should".

We should review whether these requirements are appropriate for an informational advice document.

In particular, we should distinguish recommendations for implementations from requirements that an ecosystem may choose to adopt.

If the document intends to define new interoperability requirements, we should consider whether those requirements belong in a separate normative specification.

  1. Complete publication readiness checks

Before submission:

  • Update the copyright year and verify that the Notices text conforms to the current OIDF IPR Policy.
  • Complete the Acknowledgements section (currently "todo...").
  • Add or review Security Considerations.
  • Verify the References and their normative/informative classification.
  • Add Document History if required for the publication stage.
  • Ensure that the generated HTML and source filenames follow OIDF publication conventions.
  • Validate the generated HTML against the "openid/publication" checks.

Acceptance criteria

  1. The document is clearly identified as informational guidance from the FAPI Working Group.
  2. No incorrect IETF Internet-Draft or Standards Track metadata appears in the generated document.
  3. The document builds successfully without relying on inappropriate "seriesInfo" values.
  4. The Notices and other publication metadata conform to OIDF requirements.
  5. The document passes the applicable publication checks and is ready for submission to "openid.net/specs/".

References

主要语言
HTML
星标
5
派生
3
PR 合并指标
30 天内没有已合并 PR

环境准备

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

从这里开始

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

openid/fapi 的其他 Issue

查看 openid/fapi 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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