Detection rules landing page ignores frontmatter in index.md

Abierto Apto para principiantes
  • ¿Algo no está bien?
#4,697 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp
Área
documentation

Línea de trabajo

Empieza con DetectionRuleOverviewFile.GetMarkdown() en src/Elastic.Markdown/Extensions/DetectionRules/DetectionRuleFile.cs y comprueba cómo puede incluir frontmatter de SourceFile antes del Markdown generado. Lee MarkdownFile.ProcessYamlFrontMatter para seguir cómo se analizan esos metadatos. Compila el docset con frontmatter en docs/index.md y confirma que mapped_pages y las demás claves se aplican a la página de inicio generada.

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

Descripción

bug needs triage
What happened?

The detection rules extension builds the landing page of a detection rules docset, its index.md, from generated Markdown. It never reads the file's own contents. Because frontmatter is only read from the parsed document, any frontmatter in index.md is silently dropped, including mapped_pages.

  • DetectionRuleOverviewFile overrides GetMinimalParseDocumentAsync and GetParseDocumentAsync to parse the string returned by GetMarkdown(). That string starts with # Prebuilt detection rules reference and has no frontmatter.
  • MarkdownFile.ProcessYamlFrontMatter only reads frontmatter when the parsed document's first block is a YamlFrontMatterBlock. For this page it never is, so mapped_pages, description, and the other keys have no effect.

Impact: the Prebuilt detection rules reference can't list its 8.x equivalents (/guide/en/security/<version>/prebuilt-rules.html) in the version menu. That was requested in elastic/docs-content-internal#750.

How can we reproduce it?
  1. Add frontmatter to docs/index.md in elastic/detection-rules: 
    ---
mapped_pages:
  - https://www.elastic.co/guide/en/security/current/prebuilt-rules.html
---
  2. Build the docset.
  3. The generated reference/security/prebuilt-rules page has no legacy versions, and none of the frontmatter is applied.

Possible fix: in DetectionRuleOverviewFile.GetMarkdown(), put the frontmatter block from SourceFile, if there is one, in front of the generated Markdown. Both parser pipelines already call UseYamlFrontMatter(), so ProcessYamlFrontMatter would then pick it up.

Version or commit

main at e7b055b1c7426661455963a8aa007b5ef50f3da8

Related

elastic/detection-rules#7138 adds the mapped_pages frontmatter above. It takes effect once this is fixed.

Lenguaje dominante
C#
Estrellas
25
Forks
44
Merge medio
17 h 21 min
PR fusionados (30 d)
343

Preparar el entorno

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 elastic/docs-builder

Todos los issues de elastic/docs-builder

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.