Add design-notes migration plan with document triage and proposed directory structure#9
Add design-notes migration plan with document triage and proposed directory structure#9
Conversation
…structure Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
nicolejms
left a comment
There was a problem hiding this comment.
recipe-backed core resources has been implemented. Those documents need to be migrated.
Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
Moved 6 documents to the migration list in
Verified implementation evidence: |
docs/design-notes/migration-plan.md
Outdated
| | [`cli/2024-04-azure-workload-identity.md`](https://github.com/radius-project/design-notes/blob/main/cli/2024-04-azure-workload-identity.md) | Enables Azure workload identity (federated identity) for Radius to deploy and manage Azure resources without client secrets. Status: **Approved**. | Azure credential management exists in `pkg/ucp/credentials/`, `pkg/cli/azure/`. | | ||
| | [`cli/2024-06-04-aws-irsa-support.md`](https://github.com/radius-project/design-notes/blob/main/cli/2024-06-04-aws-irsa-support.md) | Enables AWS IRSA (IAM Roles for Service Accounts) for Radius to deploy and manage AWS resources without static access keys. | AWS credential management exists in `pkg/ucp/credentials/`, `pkg/cli/aws/`. | | ||
|
|
||
| ### Compute Extensibility (4 documents) |
There was a problem hiding this comment.
Merged both into a single "Extensibility (9 documents)" section in ef8ca39. The compute/ directory is removed from the proposed structure; all extensibility docs (UDTs + compute extensibility) are now under extensibility/.
docs/design-notes/migration-plan.md
Outdated
| | `features/2025-07-23-radius-configuration-ux.md` | Configuration UX modeling configs as resources is not implemented. | | ||
| | `features/2025-07-radius-resource-types-contribution.md` | Community contribution model for resource types is not implemented. | | ||
| | `features/2025-08-14-terraform-bicep-settings.md` | Terraform/Bicep settings refactoring feature spec is not implemented. | | ||
| | `resources/2025-11-11-secrets-redactdata.md` | `Radius.Security/secrets` sensitive data redaction is not implemented. | |
There was a problem hiding this comment.
Moved to the migration list under Security in ef8ca39. Evidence: Radius.Security/secrets resource type is defined in deploy/manifest/built-in-providers/dev/radius_security.yaml.
docs/design-notes/migration-plan.md
Outdated
| | `features/2025-07-radius-resource-types-contribution.md` | Community contribution model for resource types is not implemented. | | ||
| | `features/2025-08-14-terraform-bicep-settings.md` | Terraform/Bicep settings refactoring feature spec is not implemented. | | ||
| | `resources/2025-11-11-secrets-redactdata.md` | `Radius.Security/secrets` sensitive data redaction is not implemented. | | ||
| | `tools/2025-01-gitops-technical-design.md` | Radius Flux Controller is not implemented; no Flux-related code exists. | |
There was a problem hiding this comment.
Moved to the migration list under GitOps in ef8ca39. Evidence: Flux controller in pkg/controller/reconciler/flux_controller.go, predicate in flux_gitrepository_predicate.go, and functional tests in test/functional-portable/kubernetes/noncloud/flux_test.go.
…echnical-design docs Co-authored-by: nicolejms <101607760+nicolejms@users.noreply.github.com>
Description
Reviews all 62 design documents in the design-notes repository and produces a migration plan identifying which should be migrated to the main repo. Also proposes an improved topic-based directory structure.
Result: 36 documents recommended for migration, 27 excluded.
Applications.CoreApplications.Core-related (Applications.Core/*,Applications.Dapr/*,Applications.Datastores/*,Applications.Messaging/*)docs/design-notes/with 9 categories:architecture/,cli/,extensibility/,gitops/,guides/,recipes/,security/,tools/,ucp/resources/contained both Applications.Core and recipe designs) with topic-aligned groupingextensibility/category (9 documents)Radius.Security/secretssensitive data redaction design undersecurity/(3 documents)gitops/(3 documents)Each recommendation includes a summary and evidence of implementation (specific
pkg/paths).Type of change
Contributor checklist
Please verify that the PR meets the following requirements, where applicable:
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.