Skip to content

Resolve Planning Docs validation failure for structured SOP sections #225

Description

@alexeygrigorev

During authorized publication of all pending main commits, Planning Docs validation failed on pushed commit 975b7c6c514fe036c5796071d35669e64f68d6ea.

Run: https://github.com/DataTalksClub/dataops/actions/runs/34060237649

On-Call findings: the Node SOP lint step exits 2 with 90 violations across 15 SOPs. Each reports six missing required sections: summary, prerequisites, procedure, validation, troubleshooting, references. The private knowledge checkout and content-validation workflow itself succeeded; this is a document/schema validation failure, not an established credential problem. Similar failure existed on earlier main.

Diagnose whether the validator misreads canonical structured documents or the private knowledge lacks required material. Preserve actual checks; do not suppress errors or invent operational content. Keep operational document names, contents, links, and artifacts out of the public issue. Application/runtime fixes belong here; any private knowledge change requires an explicit, separately scoped authorization decision if not already covered.

The current app deployment and full browser CI are monitored separately. This issue does not claim those jobs failed or completed.

Activity

  1. added
    bugSomething is broken
    needs groomingRaw intake that needs PM grooming
    process-docsSOPs, templates, references, playbooks
    on Sep 6, 2026
  2. alexeygrigorev commented on Sep 6, 2026

    @alexeygrigorev
    MemberAuthor

    PROCESS FINDINGS

    Read-only diagnosis identifies a private document-format mismatch. The 15 SOPs corresponding to the missing-section pattern contain all six Markdown headings and nonempty section bodies, but lack the required HTML section markers. The public SOP format contract explicitly defines marker names as parser keys and visible headings as rendering text. The parser, linter, and synthetic fixtures follow that contract.

    No public parser fix or heading fallback is justified by these findings. Remediation requires separately scoped private knowledge normalization that preserves existing prose, document IDs, and links, adds canonical section/procedure markup, and reviews the resulting structure without inventing operational content. Verification should cover SOP lint, document links and metadata, rendering, and search indexing.

    Snapshot distinction: the reported CI run emitted 90 missing-section violations across 15 documents. A separate read-only check of the current private remote snapshot reproduced those 90 violations and additionally found six missing-image violations across five other documents. Equality between that private snapshot and the CI checkout was not established, so these additional findings are not attributed to the reported CI run.

    No repository files or private knowledge were edited during diagnosis. The required private knowledge work is separate from publication of the pending public application changes and does not block their independent deployment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething is brokenneeds groomingRaw intake that needs PM groomingprocess-docsSOPs, templates, references, playbookstestingTests and QA

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions