Skip to content

Forge and standardize public TSG templates - #342

Open
John Neemes (1008covingtonlane) wants to merge 1 commit into
Azure:mainfrom
1008covingtonlane:joneemes/tsg-forge-templates
Open

Forge and standardize public TSG templates#342
John Neemes (1008covingtonlane) wants to merge 1 commit 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.

| Product or component | Supported versions | Supported scenarios | Unsupported scenarios | Source of truth |
| -------------------- | ------------------ | ------------------- | --------------------- | --------------- |
| {Azure Local product or component} | {Version or build range} | {Where this applies} | {Where this does not apply} | {Public Microsoft Learn URL or product documentation} |
| {OEM, hardware, driver, firmware, or module when applicable} | {Version or model range} | {Supported use} | {Unsupported use} | {Public Microsoft Learn URL or OEM public documentation when permitted} |

| Check | Command | Result | Report path or output |
| --- | --- | --- | --- |
| TSG-FORGE lint | `python3 <path-to-tsg-forge>/harness.py --lint --tsg <article-file>` | <A, B, F, or not run> | <report path> |
Comment thread CONTRIBUTING.md
Comment on lines +137 to +145
Technical grade records the TSG outcome:

| Grade | Meaning |
| --- | --- |
| `null` | No TSG-FORGE technical grade has been established |
| A | Detector, discoverability, documented mitigation, and revalidation passed |
| B | Live loop passed, but documented discoverability is incomplete |
| C | Recovery required fallback automation or failure detail was not actionable |
| F | The bad state was not detected or the documented mitigation did not restore service |
Comment on lines +128 to +136
Technical grade records the TSG outcome, not the cluster outcome:

| Grade | Meaning |
| --- | --- |
| `null` | No TSG-FORGE technical grade has been established |
| A | The detector, discoverability, documented mitigation, and revalidation passed |
| B | The live loop passed, but documented discoverability is incomplete |
| C | Recovery required fallback automation or the failure detail was not actionable |
| F | The bad state was not detected or the documented mitigation did not restore service |
Comment on lines +174 to +189
```powershell
# Pre-check
{Pre-check command}

# Action
{Mitigation command}

# Rollback, if the stop condition is met
{Rollback command}

# Rollback verification
{Rollback verification command}

# Verification
{Verification command}
```
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.

2 participants