Decouple build artifact naming from RFC "seriesInfo" metadata

Đang mở
  • Có gì không ổn?
#885 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, python, shell
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

  1. 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.
  2. Pass the output basename explicitly to the Markdown-to-HTML conversion pipeline, bypassing or updating the container entrypoint's reliance on "grep".
  3. Maintain backward compatibility for existing FAPI documents that currently use "seriesInfo.value".
  4. Ensure the generated HTML and XML do not incorrectly identify OIDF documents as IETF Internet-Drafts or Standards Track documents.
  5. 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

Ngôn ngữ chính
HTML
Star
5
Fork
3
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openid/fapi

Tất cả issue của openid/fapi

Issue tương tự

Thêm issue về Build System

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.