Add TypeScript AppHost support to PostgreSQL integration docs#581
Closed
Add TypeScript AppHost support to PostgreSQL integration docs#581
Conversation
* Initial plan * Add WithBun() documentation to JavaScript integration page Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update Bun example to use specific version tag Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
) * Initial plan * Add documentation for deployment slot support to Azure App Service Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
- Created documentation for Azure Application Insights integration. - Created documentation for Azure Data Explorer (Kusto) integration. - Created documentation for Azure Log Analytics integration. - Created documentation for Azure Data Lake Storage integration. - Added `aspire doctor` command placeholder with redirect to main CLI command page. - Added documentation for `aspire ps` command to list running AppHost processes. - Added documentation for `aspire stop` command to stop running AppHost processes.
…LI commands and diagnostics
…#288) * Initial plan * Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update project file samples to modern 13.x format Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
#277) * Add polyglot AppHost documentation for TypeScript, Python, Go, Rust, and Java * feat: enhance PivotSelector component with marginTop prop for better layout control (#302) docs: update Polyglot AppHost documentation with new features and usage examples docs: add link to Polyglot AppHost in resource model documentation docs: include Polyglot AppHost reference in get-started guide for broader language support style: import utility classes for padding and margin in site CSS style: create utils.css for reusable padding and margin utility classes * fix: format project structure in polyglot AppHost documentation for clarity --------- Co-authored-by: David Pine <david.pine@microsoft.com>
- Created a new translation guide document in MDX format to assist contributors in translating the aspire.dev documentation. - Added two new images for the translation page link and language selector in both light and dark themes. - Included a detailed section on supported languages, translation status, best practices, and tips for translators.
- Added FooterPreferences component for user preferences (theme, language, keyboard shortcuts). - Introduced FooterSocials component to display social media links. - Updated Footer.astro to include new components and adjusted layout for preferences. - Enhanced Header.astro to remove theme and language selectors, now located in the footer. - Implemented auto-detection of user language on first visit in Head.astro. - Adjusted styles for new components and improved responsiveness. - Updated translations in various languages to include "preferences".
- Changed hideOnClick prop in Head.astro from 'toggle' to true for improved clarity. - Removed fixed width and height from .starlight-sidebar-topics-icon to allow for flexible sizing. - Adjusted icon size in .social-icons and .starlight-sidebar-topics-icon for consistency and better responsiveness.
…json and pnpm-lock.yaml
* Initial plan * Add documentation for .NET tool resources Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
…ASPIREEXTENSION001 with version notes and suppression methods
…ASPIRECONTAINERSHELLEXECUTION001, ASPIREPIPELINES004, ASPIREPOSTGRES001, and ASPIREUSERSECRETS001 with improved descriptions and examples
…ures and benefits
…ve documentation examples for various languages
…ons and examples - Updated the description to clarify Aspire's code-first and agent-enabled workflow. - Added sections on the challenges of distributed development without Aspire. - Included a comparison table highlighting the benefits of using Aspire. - Provided step-by-step commands for starting services with and without Aspire. - Introduced code snippets for C# and TypeScript AppHost configurations. - Emphasized the advantages of a unified model for both development and production environments. - Added tips for using AI coding agents and handling multi-language stacks.
* Move Aspire SDK and templates from Get Started to AppHost > C# AppHost These pages are 100% .NET-specific (NuGet packages, .csproj files, dotnet new templates) but had generic labels in the universal Setup and tooling section. Now scoped under AppHost > C# AppHost where the context is clear. Fixes #566 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add TypeScript AppHost project structure page Document aspire.config.json, .modules/ directory, apphost.ts, and package.json for TypeScript AppHost projects. Adds a balanced TypeScript AppHost group alongside the C# AppHost group in sidebar. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Shorten sidebar labels: C# AppHost → C#, TypeScript AppHost → TypeScript Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Consolidate into 'Language support' group under AppHost Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * POC: Language toggles on AppHost pages, Project structure sidebar - Sidebar: 'Project structure' group with C# and TypeScript sub-pages - Configuration page: C#/TypeScript tabs for launch profile config (launchSettings.json vs aspire.config.json) - Eventing page: C#/TypeScript tabs for event subscription examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add C#/TypeScript tabs to all AppHost code samples Add language toggles to every AppHost code block across 7 pages: persistent-containers, withdockerfile, executable-resources, certificate-configuration, container-files, migrate-from-docker-compose. Mark dotnet-tool-resources as C# AppHost only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove .NET-specific language from AppHost page descriptions - docker-compose reference: 'C# API calls' → 'AppHost API calls' - executable-resources: remove ExecutableResource class name from description - withdockerfile: remove .csproj reference from context path description Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move .NET tool resources to Integrations → Frameworks & runtimes It's a .NET-specific integration, not a generic AppHost resource type. Renamed sidebar label to '.NET CLI tools' for clarity. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix TypeScript API bugs found by tsc compilation Validated all TS code samples against generated SDK: - withLifetime: use ContainerLifetime.Persistent enum, not string - addExecutable: args param is string[], not string - addContainer: 2 args (tag in image string), not 3 Test project at /tmp/ts-api-validation/ compiles clean. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix remaining TS API issues found by tsc validation - addProject: add required 3rd arg (launch profile 'https') across 4 files - withContainerFiles: mark as not yet available in TS SDK - All TS code samples now compile clean against generated SDK Test project at /tmp/ts-api-validation/ validates all APIs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix app.host.ts → apphost.ts in all TypeScript code block titles 46 occurrences across 6 files. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Initial plan * Add aspire describe command documentation (renamed from aspire resources) Addresses #461: CLI aspire resources renamed to aspire describe with --watch renamed to --follow/-f. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix alphabetical ordering of aspire describe in sidebar Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address review feedback: wrap Steps, expand NDJSON, add what's new entry - Wrap numbered list in Steps component per review feedback - Expand NDJSON acronym to Newline Delimited JSON with links - Add 'Resource monitoring with aspire describe' section to what's new 13.2 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add case-insensitive note to --format option Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Replace ndjson.org links with GitHub spec repo Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
…spire.Hosting.Foundry (#518) * Update Foundry integration naming: Azure AI Foundry → Microsoft Foundry - Rename package references from Aspire.Hosting.Azure.AIFoundry to Aspire.Hosting.Foundry - Update type references: AzureAIFoundryResource → FoundryResource - Update method references: AddAzureAIFoundry → AddFoundry - Update branding from 'Azure AI Foundry' to 'Microsoft Foundry' in all docs - Keep 'Foundry Local' naming unchanged - Update integration data files (names, docs links, integrations catalog) - Update sidebar, integration grid, compatibility matrix - Update whats-new release notes for 9.4 and 9.5 Related: microsoft/aspire#14149 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Revert changes in whatsnew * Update articles with AddProject * Use enumerations for models * Add note about new name --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…spire across multiple files and scripts. This includes JSON module files, helper functions, and documentation updates to reflect the new repository URL. Additionally, adjustments were made in the code to normalize source repository URLs and ensure consistency in tests and command descriptions.
…into release/13.2
… writing helper - Created a new JSON module for Aspire.Hosting.Maui version 13.2.0-preview.1.26170.3, defining various methods for managing Android and iOS devices, emulators, and project resources. - Implemented `StableFileWriter` helper class in both AtsJsonGenerator and PackageJsonGenerator to handle writing files only if content has changed, ensuring consistent line endings and UTF-8 encoding without BOM.
- Introduced project-scoped configuration with `aspire.config.json`, replacing the legacy `.aspire/settings.json`. - Enhanced the configuration settings table to reflect new settings and their descriptions. - Removed the deprecated `--debug` option and added new commands for managing HTTPS certificates (`aspire certs`, `aspire certs clean`, `aspire certs trust`). - Added commands for exporting telemetry and logs (`aspire export`, `aspire logs`). - Introduced MCP command functionality with `aspire mcp`, `aspire mcp call`, and `aspire mcp tools`. - Added `aspire resource` command for executing resource-specific commands. - Updated CLI command descriptions and examples for clarity and consistency. - Added new options for banner display, log level configuration, and suppression of the startup logo.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…9.2 documentation
- Add TypeScript examples throughout postgres-host.mdx using synced C#/TS tabs - Restructure postgres-get-started.mdx with separate C#/TypeScript quickstart paths - Add new SyncedPivotSelector component to sync pivot selector with Starlight tabs - Add new 'Connect to PostgreSQL' page with language-neutral connection reference (JavaScript, Python, Go, .NET examples) - Move connection properties and env var reference from host page to connect page - Mark client integration as .NET-specific in sidebar and page content - Add aspire add postgres to both C# and TypeScript installation sections - Show aspire.config.json update in TypeScript installation examples - Rename 'Using with non-.NET applications' to neutral language - Fix sidebar not auto-expanding current page group after SidebarPersister restore - Fix typo: confgure → configure in postgres-host description Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Adds TypeScript AppHost examples and language-neutral connection guidance to the PostgreSQL integration docs.
Changes
SyncedPivotSelectorcomponentTypeScript API validation
All TypeScript AppHost code samples validated against the actual
Aspire.Hosting.PostgreSQL+Aspire.Hosting.JavaScriptSDK types usingtsc --noEmit.