Skip to content

Commit e5d23cd

Browse files
IEvangelistIEvangelist
authored
Authoring custom integrations: hosting, client & securing communications between the two (#138)
* Add secure communication documentation and update site data version - Created a new documentation file for secure communication between custom hosting and client integrations, detailing the flow of authentication credentials using MailDev and MailKit. - Added prerequisites, code examples, and a summary of the implementation process. - Introduced a new JSON file to specify the Aspire version as "13.0.1". * More custom hosting bits. * checkpoint... * custom client rewrite * Add MailDev resource parameters and update configuration for secure communication * A few fixes * Remove unnecessary ESLint disable comments from content configuration * Refactor code structure for improved readability and maintainability * Reapply missing JS integration * Reapply ESLint disable comments for type safety in content configuration * Format ESLint disable comments for better readability in content configuration * Add deployment manifest format and publishing overview documentation - Introduced a comprehensive guide on the deployment manifest format for Aspire apps, detailing the structure, resource types, and generation process. - Added an overview of the publishing and deployment process in Aspire, explaining the CLI commands, parameter placeholders, compute environments, and hosting integration support. - Included examples and best practices for generating artifacts and deploying applications using Aspire. * Update deployment manifest generation instructions for clarity and accuracy * Update integration links for PostgreSQL and EF Core consistency * Add continue-on-error option for ESLint step in lint-validate workflow
1 parent 4234c46 commit e5d23cd

70 files changed

Lines changed: 13232 additions & 3337 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/prompts/migrate-from-learn.prompt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Example NUnit content
107107
1. **Import statement**: Add `import { Image } from 'astro:assets';` to imports
108108
2. **Asset import**: `import imageName from '@assets/{section}/{filename}';`
109109
3. **Usage**: `<Image src={imageName} alt="descriptive text" />`
110-
4. **Copy both**: Always copy `.png` (or other formats) AND `.excalidraw` source files
110+
4. **Copy both**: Always copy `.png`, `.svg` (or other formats) AND `.excalidraw` source files
111111
5. **Destination**: `src/frontend/src/assets/{section}/`
112112

113113
### Link Transformations

.github/prompts/update-integrations.promt.md renamed to .github/prompts/update-integrations.prompt.md

File renamed without changes.

‎.github/workflows/lint-validate.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ jobs:
3535
run: pnpm install --frozen-lockfile
3636

3737
- name: Run ESLint
38+
continue-on-error: true # List errors should not fail the job
3839
run: pnpm lint
3940

4041
- name: Astro type check

‎.vscode/extensions.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"recommendations": [
33
"astro-build.astro-vscode",
4-
"unifiedjs.vscode-mdx"
4+
"unifiedjs.vscode-mdx",
5+
"esbenp.prettier-vscode"
56
],
67
"unwantedRecommendations": []
78
}

‎.vscode/settings.json‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
{
2-
"prettier.documentSelectors": [
3-
"**/*.astro"
4-
],
5-
"[astro]": {
6-
"editor.defaultFormatter": "esbenp.prettier-vscode"
7-
}
8-
}
2+
"prettier.documentSelectors": ["**/*.astro"],
3+
"[astro]": {
4+
"editor.defaultFormatter": "esbenp.prettier-vscode"
5+
},
6+
"[typescript]": {
7+
"editor.defaultFormatter": "esbenp.prettier-vscode"
8+
},
9+
"[javascript]": {
10+
"editor.defaultFormatter": "esbenp.prettier-vscode"
11+
},
12+
"[markdown]": {
13+
"editor.defaultFormatter": "esbenp.prettier-vscode"
14+
},
15+
"[mdx]": {
16+
"editor.defaultFormatter": "esbenp.prettier-vscode"
17+
},
18+
"[json]": {
19+
"editor.defaultFormatter": "esbenp.prettier-vscode"
20+
},
21+
"[javascriptreact]": {
22+
"editor.defaultFormatter": "esbenp.prettier-vscode"
23+
},
24+
"[yaml]": {
25+
"editor.defaultFormatter": "esbenp.prettier-vscode"
26+
}
27+
}

‎src/frontend/astro.config.mjs‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import catppuccin from '@catppuccin/starlight';
1111
import lunaria from '@lunariajs/starlight';
1212
import mermaid from 'astro-mermaid';
1313
import starlight from '@astrojs/starlight';
14-
import starlightGiscus from 'starlight-giscus';
1514
import starlightGitHubAlerts from 'starlight-github-alerts';
1615
import starlightImageZoom from 'starlight-image-zoom';
1716
import starlightKbd from 'starlight-kbd';
@@ -55,7 +54,6 @@ export default defineConfig({
5554
Header: './src/components/starlight/Header.astro',
5655
Hero: './src/components/starlight/Hero.astro',
5756
MarkdownContent: './src/components/starlight/MarkdownContent.astro',
58-
Pagination: './src/components/starlight/Pagination.astro',
5957
Search: './src/components/starlight/Search.astro',
6058
Sidebar: './src/components/starlight/Sidebar.astro',
6159
SocialIcons: './src/components/starlight/SocialIcons.astro',
@@ -124,20 +122,6 @@ export default defineConfig({
124122
{ id: 'linux', label: 'Linux', detector: 'linux' },
125123
],
126124
}),
127-
starlightGiscus({
128-
repo: 'IEvangelist/aspire-docs-discussions',
129-
repoId: 'R_kgDOPYdXEQ',
130-
category: 'General',
131-
categoryId: 'DIC_kwDOPYdXEc4Ctyny',
132-
mapping: 'pathname',
133-
inputPosition: 'bottom',
134-
reactions: true,
135-
lazy: true,
136-
theme: {
137-
light: 'catppuccin_latte',
138-
dark: 'catppuccin_mocha',
139-
},
140-
}),
141125
],
142126
}),
143127
jopSoftwarecookieconsent(cookieConfig),

‎src/frontend/config/sidebar/cli-reference.topics.ts‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
import type { StarlightSidebarTopicsUserConfig } from 'starlight-sidebar-topics';
2+
3+
export const cliReferenceTopics: StarlightSidebarTopicsUserConfig = {
4+
label: {
5+
en: 'CLI Reference',
6+
es: 'Referencia de CLI',
7+
fr: 'Référence CLI',
8+
de: 'CLI-Referenz',
9+
it: 'Riferimento CLI',
10+
pt: 'Referência de CLI',
11+
ru: 'Справочник CLI',
12+
'zh-CN': 'CLI 参考',
13+
da: 'CLI-reference',
14+
hi: 'CLI संदर्भ',
15+
id: 'Referensi CLI',
16+
ja: 'CLI リファレンス',
17+
ko: 'CLI 참고서',
18+
'pt-BR': 'Referência de CLI',
19+
'pt-PT': 'Referência de CLI',
20+
tr: 'CLI Referansı',
21+
uk: 'CLI Довідник',
22+
},
23+
link: '/reference/cli/overview',
24+
icon: 'forward-slash',
25+
items: [
26+
{
27+
label: 'Overview',
28+
translations: {
29+
da: 'Oversigt',
30+
de: 'Übersicht',
31+
en: 'Overview',
32+
es: 'Descripción general',
33+
fr: "Vue d'ensemble",
34+
hi: 'अवलोकन',
35+
id: 'Ikhtisar',
36+
it: 'Panoramica',
37+
ja: '概要',
38+
ko: '개요',
39+
pt: 'Visão geral',
40+
'pt-BR': 'Visão geral',
41+
'pt-PT': 'Visão geral',
42+
ru: 'Обзор',
43+
tr: 'Genel Bakış',
44+
uk: 'Огляд',
45+
'zh-CN': '概述',
46+
},
47+
slug: 'reference/cli/overview',
48+
},
49+
{
50+
label: 'Install script',
51+
translations: {
52+
da: 'Installationsscript',
53+
de: 'Installationsskript',
54+
en: 'Install script',
55+
es: 'Script de instalación',
56+
fr: "Script d'installation",
57+
hi: 'इंस्टॉलेशन स्क्रिप्ट',
58+
id: 'Skrip Instalasi',
59+
it: 'Script di installazione',
60+
ja: 'インストールスクリプト',
61+
ko: '설치 스크립트',
62+
pt: 'Script de instalação',
63+
'pt-BR': 'Script de instalação',
64+
'pt-PT': 'Script de instalação',
65+
ru: 'Скрипт установки',
66+
tr: 'Kurulum Betiği',
67+
uk: 'Скрипт установки',
68+
'zh-CN': '安装脚本',
69+
},
70+
slug: 'reference/cli/install-script',
71+
},
72+
{
73+
label: 'Configuration',
74+
translations: {
75+
da: 'Konfiguration',
76+
de: 'Konfiguration',
77+
en: 'Configuration',
78+
es: 'Configuración',
79+
fr: 'Configuration',
80+
hi: 'कॉन्फ़िगरेशन',
81+
id: 'Konfigurasi',
82+
it: 'Configurazione',
83+
ja: '構成',
84+
ko: '구성',
85+
pt: 'Configuração',
86+
'pt-BR': 'Configuração',
87+
'pt-PT': 'Configuração',
88+
ru: 'Конфигурация',
89+
tr: 'Yapılandırma',
90+
uk: 'Конфігурація',
91+
'zh-CN': '配置',
92+
},
93+
slug: 'reference/cli/configuration',
94+
},
95+
{
96+
label: 'Commands',
97+
translations: {
98+
da: 'Kommandoer',
99+
de: 'Befehle',
100+
en: 'Commands',
101+
es: 'Comandos',
102+
fr: 'Commandes',
103+
hi: 'कमांड',
104+
id: 'Perintah',
105+
it: 'Comandi',
106+
ja: 'コマンド',
107+
ko: '명령어',
108+
pt: 'Comandos',
109+
'pt-BR': 'Comandos',
110+
'pt-PT': 'Comandos',
111+
ru: 'Команды',
112+
tr: 'Komutlar',
113+
uk: 'Команди',
114+
'zh-CN': '命令',
115+
},
116+
items: [
117+
{ label: 'aspire', slug: 'reference/cli/commands/aspire' },
118+
{ label: 'aspire add', slug: 'reference/cli/commands/aspire-add' },
119+
{
120+
label: 'aspire cache',
121+
collapsed: true,
122+
items: [
123+
{
124+
label: 'aspire cache',
125+
slug: 'reference/cli/commands/aspire-cache',
126+
},
127+
{
128+
label: 'aspire cache clear',
129+
slug: 'reference/cli/commands/aspire-cache-clear',
130+
},
131+
],
132+
},
133+
{
134+
label: 'aspire config',
135+
collapsed: true,
136+
items: [
137+
{
138+
label: 'aspire config',
139+
slug: 'reference/cli/commands/aspire-config',
140+
},
141+
{
142+
label: 'aspire config list',
143+
slug: 'reference/cli/commands/aspire-config-list',
144+
},
145+
{
146+
label: 'aspire config get',
147+
slug: 'reference/cli/commands/aspire-config-get',
148+
},
149+
{
150+
label: 'aspire config set',
151+
slug: 'reference/cli/commands/aspire-config-set',
152+
},
153+
{
154+
label: 'aspire config delete',
155+
slug: 'reference/cli/commands/aspire-config-delete',
156+
},
157+
],
158+
},
159+
{
160+
label: 'aspire deploy',
161+
slug: 'reference/cli/commands/aspire-deploy',
162+
},
163+
{ label: 'aspire do', slug: 'reference/cli/commands/aspire-do' },
164+
{ label: 'aspire exec', slug: 'reference/cli/commands/aspire-exec' },
165+
{ label: 'aspire init', slug: 'reference/cli/commands/aspire-init' },
166+
{ label: 'aspire new', slug: 'reference/cli/commands/aspire-new' },
167+
{
168+
label: 'aspire publish',
169+
slug: 'reference/cli/commands/aspire-publish',
170+
},
171+
{ label: 'aspire run', slug: 'reference/cli/commands/aspire-run' },
172+
{
173+
label: 'aspire update',
174+
slug: 'reference/cli/commands/aspire-update',
175+
},
176+
],
177+
},
178+
],
179+
};

0 commit comments

Comments
 (0)