docs: add central Variable Management Standard page#16
Closed
kristopherjturner wants to merge 1 commit intomainfrom
Closed
docs: add central Variable Management Standard page#16kristopherjturner wants to merge 1 commit intomainfrom
kristopherjturner wants to merge 1 commit intomainfrom
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
8 tasks
There was a problem hiding this comment.
Pull request overview
This PR adds a new Variable Management Standard documentation page to the Docusaurus docs site, addressing the final acceptance criteria for issue #15 (standardizing variable management across repositories). It inserts the new page at sidebar position 4 and bumps the positions of the existing prerequisites and authentication pages accordingly.
Changes:
- New page
docs/implementation/04-variable-management-standard.mdxdocumenting the org-wide variable management pattern, repository matrix, directory structure, naming conventions, secret management, schema validation CI, and new repo onboarding checklist. - Cross-reference and navigation updates in
03-key-inputs-and-variables.mdxto link to the new page. - Sidebar position increments in
04-prerequisites-and-assumptions.mdx(4→5) and05-authentication.mdx(5→6).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
docs/implementation/04-variable-management-standard.mdx |
New standards page covering variable management patterns across all solution repos |
docs/implementation/03-key-inputs-and-variables.mdx |
Added cross-reference tip box and updated navigation "Next" link to point to the new page |
docs/implementation/04-prerequisites-and-assumptions.mdx |
Bumped sidebar_position from 4 to 5 |
docs/implementation/05-authentication.mdx |
Bumped sidebar_position from 5 to 6 |
💡 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.
| |-----------|--------|--------|---------------|------------| | ||
| | [azurelocal-toolkit](https://github.com/AzureLocal/azurelocal-toolkit) | [variables.example.yml](https://github.com/AzureLocal/azurelocal-toolkit/blob/main/config/variables.example.yml) | [schema](https://github.com/AzureLocal/azurelocal-toolkit/blob/main/config/schema/variables.schema.json) | [reference](https://github.com/AzureLocal/azurelocal-toolkit/blob/main/docs/reference/variables.md) | `validate-config.yml` | | ||
| | [azurelocal-sofs-fslogix](https://github.com/AzureLocal/azurelocal-sofs-fslogix) | [variables.example.yml](https://github.com/AzureLocal/azurelocal-sofs-fslogix/blob/main/config/variables.example.yml) | [schema](https://github.com/AzureLocal/azurelocal-sofs-fslogix/blob/main/config/schema/variables.schema.json) | [reference](https://github.com/AzureLocal/azurelocal-sofs-fslogix/blob/main/docs/reference/variables.md) | `validate-config.yml` | | ||
| | [aurelocal-avd](https://github.com/AzureLocal/aurelocal-avd) | [variables.example.yml](https://github.com/AzureLocal/aurelocal-avd/blob/main/config/variables.example.yml) | [schema](https://github.com/AzureLocal/aurelocal-avd/blob/main/config/schema/variables.schema.json) | [reference](https://github.com/AzureLocal/aurelocal-avd/blob/main/docs/reference/variables.md) | `validate-config.yml` | |
| ## Related Documentation | ||
|
|
||
| - **[Key Inputs and Variables](./03-key-inputs-and-variables.mdx)** — How the toolkit uses `infrastructure.yml` and `master-registry.yaml` | ||
| - **[Naming Standards](../planning/01-naming-standards.mdx)** — Azure resource naming conventions |
| ## Related Documentation | ||
|
|
||
| - **[Key Inputs and Variables](./03-key-inputs-and-variables.mdx)** — How the toolkit uses `infrastructure.yml` and `master-registry.yaml` | ||
| - **[Naming Standards](../planning/01-naming-standards.mdx)** — Azure resource naming conventions |
Comment on lines
+175
to
+177
| import yaml, jsonschema, sys | ||
| schema = yaml.safe_load(open('config/schema/variables.schema.json')) | ||
| data = yaml.safe_load(open('config/variables.example.yml')) |
Contributor
Author
|
Superseded by #17 which now includes all issue-15 variable standardization changes merged with 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
Adds the Variable Management Standard page to the docs site, completing the final acceptance criteria item for issue #15.
Changes