Decouple build artifact naming from RFC "seriesInfo" metadata

Abierto
  • ¿Algo no está bien?
#885 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, python, shell
Área
build-system, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
HTML
Estrellas
5
Forks
3
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de openid/fapi

Todos los issues de openid/fapi

Issues similares

Más issues de Build System

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.