search

dotnet / aspire

Tools, templates, and packages to accelerate building observable, production-ready apps
https://learn.microsoft.com/dotnet/aspire
MIT License
3.87k stars 463 forks source link

Ensure correct term is used when referring to the app host project #5795

Open DamianEdwards opened 1 month ago

DamianEdwards commented 1 month ago

The correct term for the app host project is "app host project". When used in a situation that dictates PascalCase, e.g. project names, this becomes "AppHost". Title case would be "App host". We aren't consistent throughout the product today, e.g. in warning messages, template titles and descriptions, doc comments, etc., and should clean them up.

IEvangelist commented 1 month ago

In docs, we strive to be consistent with our usage. When speaking about it conceptually, we call it "app host". When we refer to it in the content of the project itself, we say "AppHost". We do use the heading "App host usage" in integration docs, but that's because we're talking about it conceptually and we're required to use sentence case in headings in docs.

DamianEdwards commented 1 month ago

Thanks @IEvangelist. So how would it be used when referring to the project in the conceptual/generic sense, rather than a specific example? i.e. "Update your app host project to..." or "Update your AppHost project to..."? IIUC I'm thinking it's the former?

mitchdenny commented 1 month ago

How should we refer to it in XML docs (just checking for future because I know I've been inconsistent).