Skip to content

Commit 2d58f70

Browse files
davidfowlCopilot
andcommitted
Address PR review feedback
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 90e6dae commit 2d58f70

File tree

5 files changed

+69
-11
lines changed

5 files changed

+69
-11
lines changed

src/frontend/config/sidebar/deployment.topics.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,44 @@ export const deploymentTopics: StarlightSidebarTopicsUserConfig = {
113113
},
114114
{
115115
label: 'Azure',
116+
translations: {
117+
da: 'Azure',
118+
de: 'Azure',
119+
en: 'Azure',
120+
es: 'Azure',
121+
fr: 'Azure',
122+
hi: 'Azure',
123+
id: 'Azure',
124+
it: 'Azure',
125+
ja: 'Azure',
126+
ko: 'Azure',
127+
'pt-BR': 'Azure',
128+
ru: 'Azure',
129+
tr: 'Azure',
130+
uk: 'Azure',
131+
'zh-CN': 'Azure',
132+
},
116133
collapsed: false,
117134
items: [
118135
{
119136
label: 'Aspire CLI',
137+
translations: {
138+
da: 'Aspire CLI',
139+
de: 'Aspire CLI',
140+
en: 'Aspire CLI',
141+
es: 'Aspire CLI',
142+
fr: 'Aspire CLI',
143+
hi: 'Aspire CLI',
144+
id: 'Aspire CLI',
145+
it: 'Aspire CLI',
146+
ja: 'Aspire CLI',
147+
ko: 'Aspire CLI',
148+
'pt-BR': 'Aspire CLI',
149+
ru: 'Aspire CLI',
150+
tr: 'Aspire CLI',
151+
uk: 'Aspire CLI',
152+
'zh-CN': 'Aspire CLI',
153+
},
120154
slug: 'deployment/azure/aca-deployment-aspire-cli',
121155
},
122156
{

src/frontend/src/components/TopicHero.astro

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ const accentVarMap: Record<NonNullable<Props['accent']>, string> = {
3838
3939
const accentColor = accentVarMap[accent];
4040
const floatingIconConfigs = buildFloatingIconLayout(title, floatingIcons);
41+
const subtitleSegments = subtitle
42+
.split(/(`[^`]+`)/g)
43+
.filter((segment) => segment.length > 0)
44+
.map((segment) =>
45+
segment.startsWith('`') && segment.endsWith('`')
46+
? { kind: 'code' as const, text: segment.slice(1, -1) }
47+
: { kind: 'text' as const, text: segment }
48+
);
4149
---
4250

4351
<section class="topic-hero not-content" style={`--topic-accent: ${accentColor}`}>
@@ -54,7 +62,13 @@ const floatingIconConfigs = buildFloatingIconLayout(title, floatingIcons);
5462
{title}{' '}
5563
{highlight && <span class="topic-hero-highlight">{highlight}</span>}
5664
</h1>
57-
<p class="topic-hero-subtitle">{subtitle}</p>
65+
<p class="topic-hero-subtitle">
66+
{
67+
subtitleSegments.map((segment) =>
68+
segment.kind === 'code' ? <code>{segment.text}</code> : segment.text
69+
)
70+
}
71+
</p>
5872
{
5973
(primaryCta || secondaryCta) && (
6074
<div class="topic-hero-actions">

src/frontend/src/content/docs/deployment/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import CTABanner from '@components/CTABanner.astro';
2222
icon="rocket"
2323
title="From dev to production,"
2424
highlight="seamlessly."
25-
subtitle="Use aspire publish to emit deployment artifacts as a one-way handoff for external or manual use, or use aspire deploy to let Aspire generate, resolve, and apply changes directly."
25+
subtitle="Use `aspire publish` to emit deployment artifacts as a one-way handoff for external or manual use, or use `aspire deploy` to let Aspire generate, resolve, and apply changes directly."
2626
accent="orange"
2727
floatingIcons={[
2828
'cloud-download',

src/frontend/src/content/docs/deployment/overview.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ builder.AddProject<Projects.Api>("api");
3030

3131
builder.Build().Run();
3232

33-
````
33+
```
3434
</TabItem>
3535
<TabItem id='typescript' label='TypeScript'>
3636
```typescript title="apphost.ts"
@@ -43,7 +43,7 @@ await builder.addDockerComposeEnvironment('env');
4343
await builder.addProject('api', '../Api/Api.csproj', 'http');
4444

4545
await builder.build().run();
46-
````
46+
```
4747

4848
</TabItem>
4949
</Tabs>
@@ -65,7 +65,7 @@ A pipeline step is a named unit of work in the Aspire pipeline. Any resource can
6565
| [`aspire deploy`](/reference/cli/commands/aspire-deploy/) | The deploy entry point | Generate target-specific output, resolve parameters, and apply deployment changes directly |
6666
| [`aspire do <step>`](/reference/cli/commands/aspire-do/) | A named step and its dependencies | Run a specific step directly |
6767

68-
If no resource contributes work for a given entry point, Aspire can still run the pipeline successfully as a no-op. That usually means your AppHost hasn't added a target or other resource that contributes steps for that path yet.
68+
If no resource contributes work for `publish` or `deploy`, Aspire has nothing to execute for that entry point. In current Aspire CLI builds, that entry point completes as a no-op. That usually means your AppHost hasn't added a target or other resource that contributes steps for that path yet.
6969

7070
These are separate entry points. Use `aspire publish` when you want a one-way handoff out of Aspire: it emits artifacts that another tool or a manual step will apply later. Use `aspire deploy` when you want Aspire to stay in control, generate the target-specific output behind the scenes, resolve parameter values, and apply the deployment in one operation. `aspire deploy` does not consume previously published assets.
7171

@@ -104,11 +104,11 @@ var apiKey = builder.AddParameter("apiKey", secret: true);
104104
builder.AddDockerComposeEnvironment("env");
105105

106106
builder.AddProject<Projects.Api>("api")
107-
.WithEnvironment("API_KEY", apiKey);
107+
.WithEnvironment("API_KEY", apiKey);
108108

109109
builder.Build().Run();
110110

111-
````
111+
```
112112
</TabItem>
113113
<TabItem id='typescript' label='TypeScript'>
114114
```typescript title="apphost.ts"
@@ -123,7 +123,7 @@ const api = await builder.addProject('api', '../Api/Api.csproj', 'http');
123123
await api.withEnvironment('API_KEY', apiKey);
124124

125125
await builder.build().run();
126-
````
126+
```
127127

128128
</TabItem>
129129
</Tabs>
@@ -133,6 +133,7 @@ In this example:
133133
- `apiKey` is the Aspire parameter name in the AppHost.
134134
- `API_KEY` is the environment variable the deployed app receives.
135135
- `Parameters__apiKey` is an environment variable you can use to supply the value to the AppHost when the pipeline runs.
136+
- `APIKEY` is the publish-time placeholder name Docker Compose emits in generated `.env` and `${...}` references.
136137

137138
When the Docker Compose target publishes artifacts, the publish path preserves that relationship in target-specific output:
138139

@@ -149,6 +150,8 @@ services:
149150
APIKEY=
150151
```
151152

153+
In this Docker Compose output, the placeholder name is `APIKEY` rather than `API_KEY`. The app still receives `API_KEY`; `APIKEY` is only the generated publish-time placeholder that the emitted artifacts use later.
154+
152155
The placeholder name in published output is target-specific, but the mapping stays the same:
153156

154157
| Stage | Example | Meaning |

src/frontend/tests/unit/custom-components.vitest.test.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -305,18 +305,25 @@ const basicRenderCases: BasicRenderCase[] = [
305305
includes: ['Build', 'faster', 'Get started', '/get-started/', 'Docs'],
306306
},
307307
{
308-
name: 'TopicHero renders optional CTAs and floating icons',
308+
name: 'TopicHero renders optional CTAs, floating icons, and inline code in subtitles',
309309
Component: TopicHero,
310310
props: {
311311
title: 'Platform',
312312
highlight: 'overview',
313-
subtitle: 'Understand the building blocks.',
313+
subtitle: 'Use `aspire publish` for handoff.',
314314
primaryCta: { label: 'Explore', href: '/docs/' },
315315
secondaryCta: { label: 'Deploy', href: '/deployment/' },
316316
icon: 'rocket',
317317
floatingIcons: ['open-book', 'puzzle'],
318318
},
319-
includes: ['Platform', 'overview', 'Explore', '/deployment/', 'floating-icon'],
319+
includes: [
320+
'Platform',
321+
'overview',
322+
'Explore',
323+
'/deployment/',
324+
'floating-icon',
325+
'>aspire publish</code>',
326+
],
320327
},
321328
{
322329
name: 'ThemeImage renders light and dark sources',

0 commit comments

Comments
 (0)