Skip to content

Forge and standardize public TSG templates - #342

Merged
John Neemes (1008covingtonlane) merged 3 commits into
Azure:mainfrom
1008covingtonlane:joneemes/tsg-forge-templates
Aug 19, 2026
Merged

Forge and standardize public TSG templates#342
John Neemes (1008covingtonlane) merged 3 commits into
Azure:mainfrom
1008covingtonlane:joneemes/tsg-forge-templates

Conversation

@1008covingtonlane

Copy link
Copy Markdown
Collaborator

Summary

  • Upgrade all eight public authoring templates with explicit applicability, safety, evidence, rollback, validation, escalation, and automation prompts.
  • Add a canonical azure-local-supportability/tsg-metadata/v1 JSON Schema.
  • Separate read-only action classification from state-changing risk labels.
  • Align component indexes, contribution guidance, and article metadata vocabulary.

Validation

  • TSG-FORGE static lint: A for all eight templates.
  • Deterministic TSG PR lint: zero findings for all eight templates.
  • Persona usability panel: 13 of 13 reviewers scored every template 5/5.
  • Multi-model residual: two frontier model families per high-value lens, zero remaining findings. The third family was unavailable and is recorded as degraded coverage.
  • All five article metadata markers validate against the canonical schema.
  • Relative links and in-page anchors resolve at the template and documented copy locations.
  • Live HaaS mutation: not applicable. These are L0 authoring assets, not executable fault scenarios.

Align all authoring templates with safety, applicability, validation, persona, and automation requirements. Add the canonical public TSG metadata schema and provenance vocabulary.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Standardizes Azure Local supportability authoring with safety, validation, applicability, and automation guidance.

Changes:

  • Expands article and component templates with consistent authoring prompts.
  • Adds the canonical TSG metadata schema.
  • Updates contribution and review guidance.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
TSG/Templates/tsg-metadata.schema.json Defines metadata validation.
TSG/Templates/Troubleshoot-Template.md Expands troubleshooting guidance.
TSG/Templates/Reference-Template.md Standardizes reference articles.
TSG/Templates/Overview-Template.md Adds routing and validation guidance.
TSG/Templates/Markdown-Snippets.md Adds reusable authoring patterns.
TSG/Templates/HowTo-Template.md Expands procedural safety guidance.
TSG/Templates/DeepDive-Template.md Adds evidence and operational boundaries.
TSG/Templates/Component/README-Template.md Standardizes component inventories.
TSG/Templates/Component/CONTRIBUTING-Template.md Defines component contribution requirements.
CONTRIBUTING.md Updates repository authoring requirements.
.github/copilot-instructions.md Updates automated review guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread TSG/Templates/Reference-Template.md Outdated
Comment thread TSG/Templates/Markdown-Snippets.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread TSG/Templates/Troubleshoot-Template.md
Address five template-consistency and correctness findings:

1. Reference-Template source-of-truth column no longer permits OEM documentation
   for the OEM row; it requires a public Microsoft source, matching the
   template's own public-Microsoft-only link policy.
2. Markdown-Snippets validation-record lint result now lists A, B, C, F (C was
   omitted though the schema and rubric allow it).
3. CONTRIBUTING.md grade table now uses the canonical type-completeness rubric
   from README-Template.md instead of detector/live-loop definitions; validation
   depth stays in fidelity_level.
4. .github/copilot-instructions.md grade table aligned to the same canonical
   rubric for the same reason.
5. Troubleshoot-Template rollback and rollback verification are split into a
   separate, explicitly conditional block so copying the mitigation block no
   longer runs rollback after a successful action.
The fidelity_level note I added said (L0 to L3), but the fidelity tables in both
files, the canonical README-Template rows, and the schema enum define L4 (full
live inject-detect-mitigate loop). Correct the range to L0 to L4 and reword the
parenthetical so it spans static-only through the full live loop.
@tihamble

Copy link
Copy Markdown
Collaborator

Reviewed the whole PR and read every changed file end to end, then ran the checks that matter for a template rewrite instead of just reading the diff.

What held up:

  • The eight templates, both guidance files, and the new metadata schema lint clean: no structural errors, no broken or empty links, and no internal-only URLs or work item ids left in public content.
  • The five article metadata markers (overview, how-to, troubleshoot, deep-dive, reference) validate against the new tsg-metadata.schema.json, including the rule that detector.signal is null when detector.type is none and the stricter gate when automation_status is proven. The only marker that does not validate is the labeled copy-me placeholder in Markdown-Snippets, which is intended.
  • The 944 deleted lines are reformatting and consolidation, not lost guidance. The warning and caution callouts, the images-folder guidance, and the example commands all reappear in the rewritten files, and the data-loss warning comes back with a risk label attached. Nothing was renamed or removed, so no inbound links break.
  • The two Azure Local cmdlets referenced (Invoke-SolutionUpdatePrecheck and Get-SolutionUpdateEnvironment) match the public docs, and the code blocks are illustrative or read-only rather than scripts an operator runs verbatim.
  • In-document anchors and tables of contents resolve across all files, 108 links with none broken.

The risk-label vocabulary is applied consistently and the read-only action type is kept separate from the state-changing risk labels. No issues to flag.

@tihamble T.J. Hambley (tihamble) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed all 11 files end to end, audited every deleted line against base, and validated the five article metadata markers against the new schema. No substantive guidance was dropped and nothing was renamed or removed. Approving.

@1008covingtonlane
John Neemes (1008covingtonlane) merged commit 5ea8cf8 into Azure:main Aug 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants