Update Manage applications guides to use the synced demo sample - #1994
Open
zachcasper wants to merge 2 commits into
Open
Update Manage applications guides to use the synced demo sample#1994zachcasper wants to merge 2 commits into
zachcasper wants to merge 2 commits into
Conversation
Signed-off-by: Zach Casper <zachcasper@microsoft.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Static Web App Preview
Deployed from commit |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates application-management guides to use synchronized, tested demo samples and adds line-range support to the rad shortcode.
Changes:
- Replaces inline Bicep with focused sample excerpts.
- Aligns deployment and pruning examples with demo resource names.
- Adds
startLine/endLineextraction to the shortcode.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/layouts/shortcodes/rad.html |
Adds sample line-range extraction. |
docs/content/applications/definitions/_index.md |
Reworks resource-modeling guidance around app.bicep. |
docs/content/applications/connections/_index.md |
Uses app-redis.bicep for connection guidance. |
docs/content/applications/deploy/_index.md |
Aligns deployment and pruning commands with demo resources. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ```bash | ||
| rad deploy app.bicep --environment dev | ||
| ``` | ||
| {{< rad-deploy path="samples/demo/app.bicep" args="--environment dev" >}} |
|
|
||
| Add the dependency the Container needs. The following example adds a `Radius.Data/redisCaches` resource named `db` to the same Application: | ||
| <!-- markdownlint-disable-next-line MD033 --> | ||
| Add the dependency the Container needs. The demo's <a href="https://github.com/radius-project/samples/blob/{{< param version >}}/samples/demo/app-redis.bicep" target="_blank" rel="noopener">`app-redis.bicep`</a> definition adds a `Radius.Data/redisCaches` resource named `redis` to the same Application: |
Reshrahim
reviewed
Aug 21, 2026
| } | ||
| } | ||
| ``` | ||
| {{< rad file="/static/samples/demo/app-redis.bicep" embed=true startLine=40 endLine=47 >}} |
Contributor
There was a problem hiding this comment.
If the app.bicep changes then the line numbers may be get messed up. I think markers like //REDIS might be better to stay in sync
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.
Description
The Getting Started guide was updated to embed the tested
static/samples/demo/app.bicepsample, but the Manage applications section still used hard-coded, drift-prone Bicep. This PR updates all three Manage applications guides to embed the synchronized demo samples with focused code highlighting, and aligns their content, naming, and source-linking.Content changes
definitions): walks through the realapp.bicepusing line-range snippets instead of inline Bicep. Adds a new Step 3: Name your resources (static vs. Environment-suffixed names, using theenvironmentNamesnippet) and renumbers the remaining steps. Each step highlights only the lines it discusses.connections): references the demoapp.bicepfrom the Model application resources guide instead of re-embedding it, and embedsapp-redis.bicepfor the added cache and connection. Adds a version-correct source link toapp-redis.bicep.deploy): Step 1 references the shared definition rather than re-embedding it; operational commands use the deployed app name (demo-default). The Prune section now walks through a concrete example of removing therediscache and deleting the orphanedredis-defaultresource.Tooling change
radshortcode (layouts/shortcodes/rad.html) with optionalstartLine/endLineextraction so pages can embed a specific range of a synced sample without adding marker comments to the vendored file. Fully backward-compatible.Review fixes
frontend/db/my-app→demo-default/redis-default) andApplication Graph→Application graph.Validation
hugo --gc --minifybuilds cleanly.markdownlint-cli2passes with 0 issues on all three pages.