feature/align documentation standards#177
Open
JohannesRudolph wants to merge 3 commits into
Open
Conversation
Member
JohannesRudolph
commented
May 20, 2026
JohannesRudolph
commented
- docs(scorecard): add no-documentation_md rule and scorecard criterion
- refactor(azure): remove legacy documentation_md output from all backplane modules
Add documentation_md anti-pattern rule to AGENTS.md: - Document that documentation_md output in backplane/ is a legacy pattern - Specify user-facing docs belong in BBD readme field - Specify platform-engineer docs belong in backplane/README.md - Add to checklist for new modules Add 'no_documentation_md_output' scorecard check (integration category): - Checks backplane/ TF files for legacy documentation_md output - Reports violation with actionable detail message
…lane modules The documentation_md output pattern is deprecated. Documentation is now split: - User-facing content belongs in the BBD readme field (meshstack_integration.tf) - Platform-engineer-facing content belongs in backplane/README.md Changes per module: - aks: delete documentation.tf, remove output row from README - azure-virtual-machine: delete documentation.tf, remove output row from README - container-registry: delete documentation.tf, remove output row from README - github-actions-terraform-setup: delete documentation.tf, remove output row from README - key-vault: delete documentation.tf, remove output row from README - postgresql: delete documentation.tf, fix README intro (was incorrectly titled Key Vault) - service-principal: delete documentation.tf, create backplane/README.md (was missing) - spoke-network: delete documentation.tf, remove output row from README
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
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
1 participant
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.