[INFRA] Establish unified project-wide standards (issue #14)#17
Merged
Conversation
- New page at docs/implementation/04-variable-management-standard.mdx - Documents org-wide pattern: config/variables.example.yml, JSON Schema, docs/reference/variables.md - Includes repository matrix linking all 5 solution repos - Covers naming conventions, secret management, schema validation, onboarding - Cross-link from key-inputs page (03) to new standard page - Bump sidebar positions for prerequisites (4→5) and authentication (5→6) Closes: #15
- Remove /standards from .gitignore to track standards content - Add repo-structure standard (required files, directories, branch naming, labels, CI) - Add IIC fictional company policy (naming patterns, real identities, enforcement) - Rebrand standards index from TierPoint ProdTech to AzureLocal - Track all existing standards content (documentation, scripting, infrastructure, etc.) - Update CONTRIBUTING.md with links to central standards - Add standards compliance checklist to PR template - Add validate-repo-structure CI workflow
kristopherjturner
added
type/infra
This was referenced Mar 17, 2026
Merged
Merged
There was a problem hiding this comment.
Pull request overview
This PR establishes the standards/ directory as the single authoritative location for all AzureLocal project standards, adding 40+ pages across 8 categories. It includes new repo structure and fictional company policy standards, updates CONTRIBUTING.md and the PR template, and adds a CI workflow for repo structure validation.
Changes:
- Added comprehensive standards documentation across 8 categories (documentation, scripting, infrastructure, provisioning, solutions, docusaurus, variable-management, fictional company policy) with a new repo structure standard
- Updated CONTRIBUTING.md and PR template with links to central standards and a standards compliance checklist
- Added
validate-repo-structure.ymlCI workflow to enforce required files and directories
Reviewed changes
Copilot reviewed 41 out of 43 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
standards/index.mdx |
Central navigation hub rebranded to AzureLocal |
standards/repo-structure.mdx |
New: required files, directories, branch naming, labels, commit messages |
standards/fictional-company-policy.mdx |
New: IIC naming patterns and enforcement policy |
standards/documentation/* |
Documentation standards, naming, badges, DrawIO, MDX reference, templates |
standards/scripting/* |
PowerShell/Bash standards, framework, organization |
standards/infrastructure/* |
IaC generation, deployment process, state management |
standards/variable-management/* |
Registry reference, schema validation, workflows, governance, troubleshooting |
standards/solutions/* |
Solution development standard, multi-tool parity |
standards/provisioning/* |
Runbook standard, tab decision logic, stage/step templates |
standards/docusaurus/* |
Docusaurus features and configuration |
CONTRIBUTING.md |
Added links to central standards |
.github/pull_request_template.md |
Added standards compliance checklist |
.github/workflows/validate-repo-structure.yml |
New CI workflow for repo structure validation |
.gitignore |
Added /project_management to ignore list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+217
to
+218
| name: "TierPoint Labs" | ||
| ``` |
Comment on lines
+11
to
+19
| [](https://tierpoint.com) | ||
|
|
||
| > **DOCUMENT CATEGORY**: Standards Index | ||
| > **SCOPE**: Writing, formatting, and document organization standards | ||
| > **PURPOSE**: Central hub for documentation authoring standards and templates | ||
| > **MASTER REFERENCE**: [Documentation Standards](./documentation-standards.mdx) | ||
|
|
||
| **Status**: Active | ||
| **Applies To**: All TierPoint Product Technology repositories |
|
|
||
| ## Overview | ||
|
|
||
| The Master Variable Registry is the single source of truth for all variable definitions used across TierPoint Product Technology repositories. It contains 970+ variables organized into **13 hierarchical sections**, each with detailed metadata including types, constraints, descriptions, and examples. |
| | Field | Description | Example | | ||
| |-------|-------------|---------| | ||
| | `format` | Specialized format | `uuid`, `ipv4`, `cidr`, `email`, `mac` | | ||
| | `pattern` | Regex pattern | `"^[a-z0-9-]+ $"` | |
| **File**: [`./assets/infrastructure.schema.json`](./assets/infrastructure.schema.json) | ||
|
|
||
| **Generated From**: [`./assets/master-registry.yaml`](./assets/master-registry.yaml) | ||
| **Version**: Matches registry version 2.1.0 |
Comment on lines
+233
to
+237
| curl -o variables/master-registry.yaml \ | ||
| https://raw.githubusercontent.com/tierpoint/tierpoint-prodtech-documentation/main/docs/standards/variable-management/assets/master-registry.yaml | ||
|
|
||
| curl -o variables/infrastructure.schema.json \ | ||
| https://raw.githubusercontent.com/tierpoint/tierpoint-prodtech-documentation/main/docs/standards/variable-management/assets/infrastructure.schema.json |
Comment on lines
+39
to
+45
| git clone https://gitlab.com/tierpoint/prodtech/azurelocal/environments/template.git MyNewEnvironment | ||
| cd MyNewEnvironment | ||
|
|
||
| # Copy master registry (for self-contained operation) | ||
| # Replace <docs-repo-path> with the local path to the prodtech-documentation repository | ||
| Copy-Item -Path "<docs-repo-path>\docs\standards\variable-management\assets\master-registry.yaml" -Destination ".\variables\" | ||
| Copy-Item -Path "<docs-repo-path>\docs\standards\variable-management\assets\infrastructure.schema.json" -Destination ".\variables\" |
| # Variable Management Standard | ||
|
|
||
| [](https://yaml.org/) | ||
| [](https://semver.org/) |
…/issue-14-unified-standards
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Establishes the docs-site \standards/\ directory as the single authoritative location for all AzureLocal project standards, per issue #14.
Changes
Acceptance Criteria (Issue #14)
Closes #14