[Compute Extensibility] Documentation Overhaul and Migration Guide

[willtsai]

Overview

This issue tracks the comprehensive rework of the Radius documentation to reflect and support the new compute extensibility architecture, as well as the official migration guide for users transitioning from the legacy architecture. The work should be heavily informed by the extensibility feature specifications located in eng/design-notes/extensibility and the implementations within radius-project/radius and radius-project/resource-types-contrib.

Make sure to include and document the new capabilities for supporting recipes stored in private repositories or registries, leveraging Terraform and Bicep settings as described in the Terraform and Bicep Settings Feature Spec and PR #11780.

Major Deliverables

• Comprehensive update of all Radius documentation to reflect the compute extensibility architecture and user workflows
• A migration guide with clear instructions for moving from the 'legacy' Radius architecture to the new compute extensibility model
  • Includes step-by-step migration instructions
  • Practical examples showing "before" (legacy) and "after" (extensible) Bicep files and environment definitions
• Documentation of extensibility features:
  • How to write, use, and customize Recipes and Recipe Packs
  • Integration with private recipe repos/registries, including secrets, authentication, and Terraform/Bicep settings
  • Common extensibility workflows for both new and existing users
• Guidance on breaking changes: Explicitly enumerate any major breaking changes, mitigation strategies, and deprecation timelines

References for Implementation

• Extensibility feature specs
• Compute extensibility implementations in radius-project/radius and resource-types-contrib
• Terraform/Bicep settings feature spec
• PR #11780 – extensibility support for private registries

Acceptance Criteria

• Documentation thoroughly reflects the compute extensibility model, architecture, and user story
• A complete migration guide from legacy architecture to new compute extensibility; includes examples and problem mitigation
• Documentation covers how to consume, author, and leverage recipes and Recipe Packs—including with private registries and advanced settings
• All legacy documentation is replaced or clearly marked as obsolete
• Breaking changes are explicitly noted and explained
• Users can successfully follow the guide to migrate an existing Radius solution from legacy to extensibility architecture

[radius-triage-bot]

👍 We've reviewed this issue and have agreed to add it to our backlog. Please subscribe to this issue for notifications, we'll provide updates when we pick it up.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview

[radius-triage-bot]

👋 @willtsai Thanks for filing this feature request.

A project maintainer will review this feature request and get back to you soon.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview