Skip to content

Commit c029d9c

Browse files
authored
Update Aspire_Components_Progress.md (#9132)
1 parent 8f7e88e commit c029d9c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/Components/Aspire_Components_Progress.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# .NET Aspire Components Progress for November
1+
# .NET Aspire Integrations Progress
22

3-
As part of the .NET Aspire November preview, we want to include a set of .NET Aspire Components which help developers build .NET Aspire applications. These components should follow the [.NET Aspire Component Requirements](#net-aspire-component-requirements). Bellow is a chart that shows the progress of each of the components we intend to ship, and their current stance against each of the requirements.
3+
These integrations should follow the [.NET Aspire Integration Requirements](#net-aspire-integration-requirements). Below is a chart that shows the progress of each of the client integrations we ship, and their current stance against each of the requirements.
44

5-
| .NET Aspire Component Name | [Contains README](#contains-readme) | [Public API](#public-api) | [Configuration Schema](#json-schemaconfiguration) | [DI Services](#di-services) | [Logging](#logging) | [Tracing](#tracing) | [Metrics](#metrics) | [Health Checks](#health-checks) |
5+
| .NET Aspire Integration Name | [Contains README](#contains-readme) | [Public API](#public-api) | [Configuration Schema](#json-schemaconfiguration) | [DI Services](#di-services) | [Logging](#logging) | [Tracing](#tracing) | [Metrics](#metrics) | [Health Checks](#health-checks) |
66
| --------------------------------------- | :---------------------------------: | :-----------------------: | :----------------------------------------------------: | :-------------------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------------------: |
77
| Npgsql |||||||||
88
| Npgsql.EntityFrameworkCore.PostgreSQL |||||||||
@@ -44,38 +44,38 @@ Nomenclature used in the table above:
4444
- ❌ - Requirement can't be met
4545
- N/A - Requirement not applicable
4646

47-
## .NET Aspire Component Requirements
47+
## .NET Aspire Integration Requirements
4848

4949
### Contains README
5050

51-
Each .NET Aspire component must contain a README.md file which is included in the package. This README should contain the component's main description, usage examples, and basic getting started documentation. The goal of this file is to contain everything a developer will need in the first 5 minutes. Finally, README should have a link pointed back to the full documentation of the component, which will include a list of logging categories used, tracing activity names, and Metric names. For a concrete example of a README file, please look [here](./Aspire.StackExchange.Redis/README.md).
51+
Each .NET Aspire integration must contain a README.md file which is included in the package. This README should contain the integration's main description, usage examples, and basic getting started documentation. The goal of this file is to contain everything a developer will need in the first 5 minutes. Finally, README should have a link pointed back to the full documentation of the integration, which will include a list of logging categories used, tracing activity names, and Metric names. For a concrete example of a README file, please look [here](./Aspire.StackExchange.Redis/README.md).
5252

5353
### Public API
5454

55-
Each component must go through an API Review that will validate that the API shape proposed by the component is conforming to the guidelines. This also includes the [naming conventions](./README.md#naming).
55+
Each integration must go through an API Review that will validate that the API shape proposed by the integration is conforming to the guidelines. This also includes the [naming conventions](./README.md#naming).
5656

5757
### Json Schema/Configuration
5858

59-
Each component should provide a `sealed` `Settings` type as well as named configuration which will showcase the exposed settings for that specific component. This will also include the Logging section in which categories are listed and can be configured. For more information, please check out [the configuration best practices](./README.md#configuration)
59+
Each integration should provide a `sealed` `Settings` type as well as named configuration which will showcase the exposed settings for that specific integration. This will also include the Logging section in which categories are listed and can be configured. For more information, please check out [the configuration best practices](./README.md#configuration)
6060

6161
### DI Services
6262

63-
Components must have extension methods which will "glue" the services with the DI container. For an example of this, please check out the `AspireRedisExtensions` class [here](./Aspire.StackExchange.Redis/AspireRedisExtensions.cs). The extension methods that are registering the main component's service to the container should be listed in the README file. The full list of registered services by the component should be included in the main component's documentation page.
63+
Integrations must have extension methods which will "glue" the services with the DI container. For an example of this, please check out the `AspireRedisExtensions` class [here](./Aspire.StackExchange.Redis/AspireRedisExtensions.cs). The extension methods that are registering the main integration's service to the container should be listed in the README file. The full list of registered services by the integration should be included in the main integration's documentation page.
6464

6565
### Health Checks
6666

67-
Aspire components should expose health checks enabling applications to track and respond to the remote service’s health. For more information, please check out [the health checks best practices](./README.md#health-checks).
67+
Aspire integrations should expose health checks enabling applications to track and respond to the remote service’s health. For more information, please check out [the health checks best practices](./README.md#health-checks).
6868

6969
### Telemetry
7070

7171
#### Logging
7272

73-
Components should produce Logs as part of them being cloud-ready. As part of the component's main documentation, it's a requirement to list out the different categories that it uses for logging. The list of categories doesn't need to be exhaustive, but it should include at least the logical level groupings used.
73+
Integrations should produce Logs as part of them being cloud-ready. As part of the integration's main documentation, it's a requirement to list out the different categories that it uses for logging. The list of categories doesn't need to be exhaustive, but it should include at least the logical level groupings used.
7474

7575
#### Tracing
7676

77-
Components should also produce tracing information as part of them being cloud-ready. As part of the component's main documentation, it's a requirement to list out the different activity names that it uses for tracing. It is not a requirement to include tag names.
77+
Integrations should also produce tracing information as part of them being cloud-ready. As part of the integration's main documentation, it's a requirement to list out the different activity names that it uses for tracing. It is not a requirement to include tag names.
7878

7979
#### Metrics
8080

81-
Components should also produce metrics as part of them being cloud-ready. As part of the component's main documentation, it's a requirement to list out the different metric names that it uses. It is not a requirement to also include dimensions.
81+
Integrations should also produce metrics as part of them being cloud-ready. As part of the integration's main documentation, it's a requirement to list out the different metric names that it uses. It is not a requirement to also include dimensions.

0 commit comments

Comments
 (0)