Skip to content

Allow extensions to inject IDocumentationFileExporter and control the relative path published in links.json#806

Merged
Mpdreamz merged 2 commits intomainfrom
fix/extensions-html-link-reference
Mar 21, 2025
Merged

Allow extensions to inject IDocumentationFileExporter and control the relative path published in links.json#806
Mpdreamz merged 2 commits intomainfrom
fix/extensions-html-link-reference

Conversation

@Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Mar 20, 2025

Fixes: elastic/detection-rules#4508

Ensures the detection rule extension emits to .artifacts/docs/html not .artifacts/docs because the rule references come from ../rules.

This also ensures links.json advertises the virtual markdown files not the toml files.

See bad links.json file here: https://docs-v3-preview.elastic.dev/elastic/detection-rules/pull/4508/links.json

Excerpt from local build:

"rules/cross-platform/initial_access_zoom_meeting_with_no_passcode.md": {
      "anchors": [
        "setup",
        "investigation-guide",
        "triage-and-analysis",
        "investigating-zoom-meeting-with-no-passcode",
        "possible-investigation-steps",
        "false-positive-analysis",
        "response-and-remediation",
        "rule-query"
      ]
    }

@Mpdreamz Mpdreamz requested a review from a team as a code owner March 20, 2025 18:12
@Mpdreamz Mpdreamz added the fix label Mar 20, 2025
@Mpdreamz Mpdreamz self-assigned this Mar 20, 2025
@Mpdreamz Mpdreamz changed the title Allow reference to inject IDocumentationFileExporter and control the relative path published in links.json Allow extensions to inject IDocumentationFileExporter and control the relative path published in links.json Mar 20, 2025
@Mpdreamz Mpdreamz merged commit 945042a into main Mar 21, 2025
10 checks passed
@Mpdreamz Mpdreamz deleted the fix/extensions-html-link-reference branch March 21, 2025 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants