Add docs-schema-mapping.yaml for documentation-schema relationships#44956
Merged
Crow-Control merged 2 commits intocommon2026from Feb 14, 2026
Merged
Add docs-schema-mapping.yaml for documentation-schema relationships#44956Crow-Control merged 2 commits intocommon2026from
Crow-Control merged 2 commits intocommon2026from
Conversation
13 tasks
Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor common module with breaking changes
Add docs-schema-mapping.yaml for documentation-schema relationships
Feb 14, 2026
Crow-Control
requested review from
Boemeltrein,
StevenMcElligott,
alfi0812,
stavros-k and
xstar97
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces a comprehensive mapping file that documents the relationships between markdown documentation files and their corresponding JSON schema files in the common chart library. This mapping serves as a single source of truth for maintaining consistency between documentation and validation schemas.
Changes:
- Added
charts/library/common/docs-schema-mapping.yamlwith complete mappings between docs and schemas - Documented both 1:1 and one-to-many relationships where documentation applies to multiple schemas
- Included lists of schemas without documentation and docs without schemas for completeness
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,358 @@ | |||
| # Mapping of documentation files to their related schema files | |||
| # Format: | |||
There was a problem hiding this comment.
There is trailing whitespace after "Format:" in the comment. While this doesn't affect functionality, it's generally good practice to avoid trailing whitespace in files.
Crow-Control
added a commit
that referenced
this pull request
Feb 14, 2026
…44956) Created a comprehensive mapping file that documents the relationships between markdown documentation files and their corresponding JSON schema files in the common chart library. ## Changes - **Added `charts/library/common/docs-schema-mapping.yaml`**: YAML mapping showing which docs files relate to which schema files - Direct 1:1 mappings (e.g., `docs/addons.md` → `schemas/addons/addons.json`) - One-to-many relationships where documentation applies to multiple schemas (e.g., `docs/container/env.md` → both `schemas/workload/podSpec/containers/env.json` and `schemas/workload/podSpec/initContainers/env.json`) - Lists of schemas without documentation and docs without schemas for completeness ## Structure The mapping is organized hierarchically by category: - Top-level configurations (addons, certificate, configmap, hpa, etc.) - CNPG resources - Container configurations - Ingress and middleware configurations - Persistence types - Service types - Workload types This provides a single reference for maintaining consistency between documentation and validation schemas. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
Crow-Control
added a commit
that referenced
this pull request
Feb 15, 2026
…44956) Created a comprehensive mapping file that documents the relationships between markdown documentation files and their corresponding JSON schema files in the common chart library. ## Changes - **Added `charts/library/common/docs-schema-mapping.yaml`**: YAML mapping showing which docs files relate to which schema files - Direct 1:1 mappings (e.g., `docs/addons.md` → `schemas/addons/addons.json`) - One-to-many relationships where documentation applies to multiple schemas (e.g., `docs/container/env.md` → both `schemas/workload/podSpec/containers/env.json` and `schemas/workload/podSpec/initContainers/env.json`) - Lists of schemas without documentation and docs without schemas for completeness ## Structure The mapping is organized hierarchically by category: - Top-level configurations (addons, certificate, configmap, hpa, etc.) - CNPG resources - Container configurations - Ingress and middleware configurations - Persistence types - Service types - Workload types This provides a single reference for maintaining consistency between documentation and validation schemas. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
Contributor
|
This PR is locked to prevent necro-posting on closed PRs. Please create a issue or contact staff on discord if you want to further discuss this |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Created a comprehensive mapping file that documents the relationships between markdown documentation files and their corresponding JSON schema files in the common chart library.
Changes
charts/library/common/docs-schema-mapping.yaml: YAML mapping showing which docs files relate to which schema filesdocs/addons.md→schemas/addons/addons.json)docs/container/env.md→ bothschemas/workload/podSpec/containers/env.jsonandschemas/workload/podSpec/initContainers/env.json)Structure
The mapping is organized hierarchically by category:
This provides a single reference for maintaining consistency between documentation and validation schemas.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.