docs-aspire icon indicating copy to clipboard operation
docs-aspire copied to clipboard

Disambiguate Hosting and Components in docs

Open IEvangelist opened this issue 1 year ago • 4 comments

Closing as we are locking down for shipping the 8.0.0 GA release and we aren't convinced this is the correct long term decision (given the above feedback/discussion). We will consider ways we can make the documentation more clear on what these libraries are and how to tell the difference between the Aspire.Hosting.* libraries and the Aspire.* libraries.

Originally posted by @eerhardt in https://github.com/dotnet/aspire/issues/3998#issuecomment-2088546771


Associated WorkItem - 255392

IEvangelist avatar May 01 '24 17:05 IEvangelist

/cc @JamesNK

mitchdenny avatar May 03 '24 01:05 mitchdenny

I think this is also useful in the extensibility section.

Imagine you're a .NET library owner and you want to make your stuff work great with Aspire. You need an overview of information about extensibility options, including resources vs components.

Should I create a resource? Should I create a component? What packages should I have? What are they called and tagged? Do I make them in my repo or the Aspire repo? etc

JamesNK avatar May 03 '24 02:05 JamesNK

This is a confusing spot for customers. I think it might be more confusing for Preview1-5 customers than it will be for GA-and-beyond, but I do agree we need a clear doc - or section of a doc - in the difference between the two.

bradygaster avatar May 03 '24 22:05 bradygaster

Are these accurate statements?

  • Resources are always related to hosting concerns (i.e.; expressed in the app host).
  • Components are always consumers of some resource and are never expressed in the app host.

IEvangelist avatar May 06 '24 16:05 IEvangelist