Skip to content

Ensure the use of polyglot is consistent - #1481

Open
Alistair Matthews (alistairmatthews) wants to merge 4 commits into
microsoft:release/13.5from
alistairmatthews:make-polyglot-term-usage-consistent
Open

Ensure the use of polyglot is consistent#1481
Alistair Matthews (alistairmatthews) wants to merge 4 commits into
microsoft:release/13.5from
alistairmatthews:make-polyglot-term-usage-consistent

Conversation

@alistairmatthews

Copy link
Copy Markdown
Collaborator

Summary

This PR:

  • Defines the term "polyglot" in the glossary.
  • Corrects use of that term throughout the content
  • Links to the definition on first use of that term in each page.

Fixes: #1480

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 glossary definition for “polyglot” (Aspire docs meaning: non-C# code) and updates docs pages to link to that definition on first usage, improving consistency across “what’s new”, CLI reference, integrations, diagnostics, and getting-started content.

Changes:

  • Added a “Polyglot” entry to the glossary with repository-specific meaning and examples.
  • Replaced/standardized “polyglot” usage across many docs pages and linked the first occurrence to the glossary anchor.
  • Updated select localized (JA) content to align with the new definition.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
src/frontend/src/content/docs/whats-new/aspire-13-5.mdx Links first “polyglot” mention in 13.5 release notes to the glossary.
src/frontend/src/content/docs/whats-new/aspire-13-4.mdx Links “polyglot” in 13.4 release notes to the glossary.
src/frontend/src/content/docs/whats-new/aspire-13-3.mdx Links “polyglot” in 13.3 release notes to the glossary.
src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md Links “polyglot” in config settings description to the glossary.
src/frontend/src/content/docs/reference/cli/configuration.mdx Links “polyglot” in CLI configuration guidance to the glossary.
src/frontend/src/content/docs/reference/cli/commands/aspire-start.mdx Links “polyglot” in aspire start docs to the glossary.
src/frontend/src/content/docs/ja/extensibility/multi-language-integration-authoring.mdx Adds a local definition sentence for “polyglot” with a glossary link.
src/frontend/src/content/docs/integrations/frameworks/go/go-host.mdx Links “polyglot” mention in Go AppHost templates section to the glossary.
src/frontend/src/content/docs/integrations/devtools/flagd/flagd-get-started.mdx Links “polyglot” mention in OFREP guidance to the glossary.
src/frontend/src/content/docs/integrations/devtools/flagd/flagd-connect.mdx Links “polyglot” mention in OFREP guidance to the glossary.
src/frontend/src/content/docs/integrations/devtools/dev-tunnels.mdx Links “polyglot” mention in note about TypeScript API to the glossary.
src/frontend/src/content/docs/integrations/databases/surrealdb/surrealdb-host.mdx Links “polyglot” mention describing TypeScript AppHost behavior to the glossary.
src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Links “polyglot” mention in C#-only overload note to the glossary.
src/frontend/src/content/docs/integrations/cloud/azure/azure-virtual-network.mdx Links “polyglot-friendly helper” phrasing to the glossary.
src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database/azure-sql-database-host.mdx Links “polyglot-friendly helper” phrasing to the glossary.
src/frontend/src/content/docs/integrations/cloud/azure/azure-postgresql/azure-postgresql-host.mdx Links “polyglot-friendly helper” phrasing to the glossary.
src/frontend/src/content/docs/integrations/cloud/azure/azure-log-analytics.mdx Links “polyglot-friendly helper” phrasing to the glossary.
src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-host.mdx Links “polyglot-friendly helper” phrasing to the glossary.
src/frontend/src/content/docs/get-started/glossary.mdx Adds the canonical “Polyglot” definition and examples.
src/frontend/src/content/docs/get-started/faq.mdx Updates phrasing and links “polyglot” usage to the glossary.
src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx Links “polyglot” usage in extension overview to the glossary.
src/frontend/src/content/docs/get-started/add-aspire-existing-app.mdx Links “polyglot” usage in AppHost style guidance to the glossary.
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx Links “polyglot” usage in ATS tags list to the glossary.
src/frontend/src/content/docs/diagnostics/aspireexport015.mdx Links “polyglot” usage in diagnostic docs to the glossary.
src/frontend/src/content/docs/diagnostics/aspireexport013.mdx Links “Polyglot” usage in diagnostic docs to the glossary.
src/frontend/src/content/docs/diagnostics/aspireexport010.mdx Links “polyglot” usage in diagnostic docs to the glossary.
src/frontend/src/content/docs/app-host/with-terminal.mdx Links “polyglot” usage in TypeScript note to the glossary.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/frontend/src/content/docs/reference/cli/configuration.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md Outdated
Comment thread src/frontend/src/content/docs/diagnostics/aspireexport013.mdx Outdated
Comment thread src/frontend/src/content/docs/diagnostics/aspireexport015.mdx Outdated
Comment thread src/frontend/src/content/docs/diagnostics/aspireexport010.mdx Outdated

### Polyglot

In this repository, **polyglot** means relating to code written in any language other than C#.

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.

Could we distinguish Aspire's shorthand for non-C# AppHost/API/SDK surfaces from the normal "multiple languages" meaning here? The OFREP pages use polyglot environments in the latter sense, while this definition makes a Python-only environment polyglot. It also conflicts with the AppHost entry above, which still says AppHosts are C#-only.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Adam Ratzman (@adamint) Many thanks! Absolutely we can and in fact that's exactly why I thought this PR was needed. I'm not sure we've decided on a consistent usage so any discussion here is very welcome. I've added "This contrasts with some other contexts where polyglot refers to any combination of languages." which I hope addresses your point?

Also, I've addressed the C# bias in the Glossary, which should already have been fixed.

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.

3 participants