Skip to content

Add developer certificate setup guide and install-flow cross-links - #1164

Open
David Pine (IEvangelist) with Copilot wants to merge 1 commit into
mainfrom
copilot/add-dev-certs-documentation
Open

Add developer certificate setup guide and install-flow cross-links#1164
David Pine (IEvangelist) with Copilot wants to merge 1 commit into
mainfrom
copilot/add-dev-certs-documentation

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

This PR adds a dedicated Aspire docs page for development certificate setup and links it from install/get-started flows. It covers the new CLI trust behavior for polyglot apps (aspire run/aspire start) and the .NET-specific dotnet dev-certs path.

  • New get-started documentation

    • Added /get-started/developer-certificates/ with:
      • CLI-managed trust via aspire run and aspire start
      • explicit cert lifecycle commands (aspire certs trust, aspire certs clean)
      • .NET-specific dotnet dev-certs https --trust / --clean guidance
      • troubleshooting pointers and links to deeper certificate docs
  • Install-flow cross-links

    • Updated get-started/install-cli.mdx to include the new page in See also
    • Updated get-started/aspire-sdk-templates.mdx cert guidance to point to the new consolidated page
  • Redirect follow-up

    • Maintainer follow-up requested: register https://aka.ms/aspire/devcerts to redirect to /get-started/developer-certificates/
# CLI-managed trust (recommended)
aspire run
aspire start

# Explicit trust/refresh
aspire certs trust
aspire certs clean
aspire certs trust

# .NET-specific path
dotnet dev-certs https --trust

Copilot AI changed the title [WIP] Add aka.ms link and documentation for developer certificates Add developer certificate setup guide and install-flow cross-links Jun 2, 2026
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review June 30, 2026 08:38
Copilot AI review requested due to automatic review settings June 30, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Set up development certificates” get-started page and wires it into existing onboarding flows so readers can find certificate trust/setup guidance from install and template docs.

Changes:

  • Added a new /get-started/developer-certificates/ documentation page covering Aspire CLI certificate trust commands and the dotnet dev-certs workflow.
  • Linked the new page from the CLI install page “See also” section.
  • Updated the SDK templates get-started doc to point to the consolidated certificate guidance page.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/frontend/src/content/docs/get-started/install-cli.mdx Adds a “See also” link to the new developer certificates page.
src/frontend/src/content/docs/get-started/developer-certificates.mdx Introduces the new consolidated developer certificates setup guide.
src/frontend/src/content/docs/get-started/aspire-sdk-templates.mdx Replaces external certificate troubleshooting links with a pointer to the new consolidated page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +15 to +19
When you run either of these commands, Aspire ensures a development certificate exists and is trusted:

```bash title="Aspire CLI"
aspire run
```
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/developer-certificates.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/aspire-sdk-templates.mdx Outdated

@adamint Adam Ratzman (adamint) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found several cross-platform certificate issues that I think need to be fixed before merge: trust is skipped in non-interactive environments, Linux browser and OpenSSL trust require different setup, clean removes all development certificates, the new page duplicates the canonical certificate page and is not in the sidebar, and one troubleshooting link is dead. I verified the command/help surface and a read-only certificate check on macOS; Windows and Linux end-to-end proof was not available.

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1164. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1164 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@aspire-repo-bot aspire-repo-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated wording suggestions from the forbidden-words check. Apply the suggestions to resolve them.

const horizontalWhitespace = String.raw`[ \t]+`;

// A deprecated term only matches when it isn't fused to an adjacent alphanumeric
// character, so longer tokens like `ASP.NET Aspire` or `.NET AspireX` stay intact

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of ".NET Aspire".

Suggested change
// character, so longer tokens like `ASP.NET Aspire` or `.NET AspireX` stay intact
// character, so longer tokens like `ASPAspire` or `AspireX` stay intact

const termEnd = String.raw`(?![A-Za-z0-9])`;

// Markdown emphasis/link openers can sit between an article and a term in raw
// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of ".NET Aspire".

Suggested change
// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or
// README content (e.g. `a **Aspire**`, `a [Aspire](url)`, or


// Markdown emphasis/link openers can sit between an article and a term in raw
// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or
// `a _.NET Aspire_`), so the article corrector consumes them to stay grammatical

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of ".NET Aspire".

Suggested change
// `a _.NET Aspire_`), so the article corrector consumes them to stay grammatical
// `a _Aspire_`), so the article corrector consumes them to stay grammatical

const markdownOpeners = String.raw`[*\[_]*`;

// Fenced code blocks and inline code spans are copied through verbatim so sample
// commands like `dotnet aspire run` are never rewritten into an unrunnable

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of "dotnet aspire".

Suggested change
// commands like `dotnet aspire run` are never rewritten into an unrunnable
// commands like `Aspire run` are never rewritten into an unrunnable

* Case-insensitive regex source matching the deprecated term core, without
* boundaries. Use `${horizontalWhitespace}` for internal spaces; alphanumeric
* boundaries are applied automatically so a rule can never corrupt a longer
* token like `ASP.NET Aspire` or `.NET AspireX`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of ".NET Aspire".

Suggested change
* token like `ASP.NET Aspire` or `.NET AspireX`.
* token like `ASPAspire` or `AspireX`.

/**
* Indefinite article the replacement should take. Set this only when the
* replacement's leading sound differs from the term's, so a preceding `a`/`an`
* is corrected (e.g. `a .NET Aspire` -> `an Aspire`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of ".NET Aspire".

Suggested change
* is corrected (e.g. `a .NET Aspire` -> `an Aspire`).
* is corrected (e.g. `a Aspire` -> `an Aspire`).

seoTitle: Bun integration for Aspire AppHost (Community Toolkit)
description: Learn how to use the Aspire Community Toolkit Bun hosting integration to orchestrate Bun applications alongside other resources in the Aspire app host.
seoTitle: Bun integration for Aspire AppHost
description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire app host.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "AppHost" instead of "app host".

Suggested change
description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire app host.
description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire AppHost.

['uppercase article', `A ${legacyDotnetAspireName} sample`, 'An Aspire sample'],
['lowercase article', `Build a ${legacyDotnetAspireName} sample`, 'Build an Aspire sample'],
['no article', `Deploy the ${legacyDotnetAspireName} app`, 'Deploy the Aspire app'],
])('normalizes the "dotnet aspire" spelling (%s)', (_scenario, input, expected) => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of "dotnet aspire".

Suggested change
])('normalizes the "dotnet aspire" spelling (%s)', (_scenario, input, expected) => {
])('normalizes the "Aspire" spelling (%s)', (_scenario, input, expected) => {

test('normalizes prose while preserving adjacent code', () => {
const input = `Build a ${legacyAspireName} app, then run \`${legacyDotnetAspireName} run\`.`;
expect(normalizeAspireTerminology(input)).toBe(
'Build an Aspire app, then run `dotnet aspire run`.'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Aspire" instead of "dotnet aspire".

Suggested change
'Build an Aspire app, then run `dotnet aspire run`.'
'Build an Aspire app, then run `Aspire run`.'

@IEvangelist David Pine (IEvangelist) added the ci:skip-forbidden-words Allows maintainers to bypass false positives in the forbidden-word check. label Aug 7, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@IEvangelist David Pine (IEvangelist) removed the ci:skip-forbidden-words Allows maintainers to bypass false positives in the forbidden-word check. label Aug 7, 2026
@IEvangelist
David Pine (IEvangelist) force-pushed the copilot/add-dev-certs-documentation branch from e55ad5e to 2899f68 Compare August 7, 2026 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[13.2] Add a new aka.ms link and documentation on setup of developer certificates

4 participants