diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index a1d251b66..bd5bfb7a2 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,4 +1,4 @@ -## .NET Aspire Community Toolkit — Copilot Coding Instructions +## Aspire Community Toolkit — Copilot Coding Instructions ### Project Overview diff --git a/.github/workflows/dotnet-main.yml b/.github/workflows/dotnet-main.yml index 7339a0d28..959ab2f1d 100644 --- a/.github/workflows/dotnet-main.yml +++ b/.github/workflows/dotnet-main.yml @@ -84,7 +84,7 @@ jobs: --file-list "${{ github.workspace }}/SignClientFileList.txt" --timestamp-url "http://timestamp.digicert.com" --publisher-name ".NET Foundation" - --description ".NET Aspire Community Toolkit" + --description "Aspire Community Toolkit" --description-url "https://github.com/CommunityToolkit/Aspire" --azure-key-vault-url "${{ secrets.SIGN_KEY_VAULT_URL }}" --azure-key-vault-client-id ${{ secrets.SIGN_CLIENT_ID }} diff --git a/.github/workflows/dotnet-release.yml b/.github/workflows/dotnet-release.yml index 2f149c0d8..107895afa 100644 --- a/.github/workflows/dotnet-release.yml +++ b/.github/workflows/dotnet-release.yml @@ -79,7 +79,7 @@ jobs: --file-list "${{ github.workspace }}/SignClientFileList.txt" --timestamp-url "http://timestamp.digicert.com" --publisher-name ".NET Foundation" - --description ".NET Aspire Community Toolkit" + --description "Aspire Community Toolkit" --description-url "https://github.com/CommunityToolkit/Aspire" --azure-key-vault-url "${{ secrets.SIGN_KEY_VAULT_URL }}" --azure-key-vault-client-id ${{ secrets.SIGN_CLIENT_ID }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdb8c8ffb..731ab5889 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# ✨ Contributing to the .NET Aspire Community Toolkit +# ✨ Contributing to the Aspire Community Toolkit -Thank you for exhibiting interest in contributing to the .NET Aspire Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project! +Thank you for exhibiting interest in contributing to the Aspire Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project! -In the next few steps, you will be able to see a glimpse of ways you can contribute to the .NET Aspire Community Toolkit. +In the next few steps, you will be able to see a glimpse of ways you can contribute to the Aspire Community Toolkit. ## ❔ Questions @@ -14,11 +14,11 @@ If you find any bug, you can help the community by [submitting an issue](https:/ ## 👌 Good First Issue -If this is your first time contributing to the .NET Aspire Community Toolkit and do not have advanced level programming experience, we have got you covered 💥 we have a list of [good first issue](https://github.com/CommunityToolkit/Aspire/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background. +If this is your first time contributing to the Aspire Community Toolkit and do not have advanced level programming experience, we have got you covered 💥 we have a list of [good first issue](https://github.com/CommunityToolkit/Aspire/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background. ## 🙋 Help Wanted -The .NET Aspire Community Toolkit also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/Aspire/labels/help%20wanted). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues. +The Aspire Community Toolkit also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/Aspire/labels/help%20wanted). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues. ## 📬 Add New Feature @@ -29,11 +29,11 @@ The .NET Aspire Community Toolkit also has a list of issues that are labeled as ## 📝 Add or Improve Documentation -The documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/). If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR to [the documentation repository](https://github.com/dotnet/docs-aspire). +The documentation for the Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/). If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR to [the documentation repository](https://github.com/dotnet/docs-aspire). ## 🚀 Create, Submit or Review Pull Request -Anyone can create a Pull Request by forking the .NET Aspire Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the .NET Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main .NET Aspire Community Toolkit. +Anyone can create a Pull Request by forking the Aspire Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main Aspire Community Toolkit. If this is your first time running the solution, be sure to familiarise yourself with [how to setup the development environment](./docs/setup.md). @@ -49,7 +49,7 @@ Each PR that builds successfully will have a preview package created. You can fi ## 💙 Thank You -**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the .NET Aspire Community Toolkit.** +**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the Aspire Community Toolkit.** ## Code of Conduct diff --git a/README.md b/README.md index daaaf5960..5414ba8fb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ [.NET Foundation](https://dotnetfoundation.org) -# .NET Aspire Community Toolkit +# Aspire Community Toolkit [![CI](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml) | [![main branch](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml) | [![Latest Release](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml) -The .NET Aspire Community Toolkit is a collection of integrations and extensions for developing with .NET Aspire. +The Aspire Community Toolkit is a collection of integrations and extensions for developing with Aspire. -All features are contributed by you, our amazing .NET community, and maintained by a core set of maintainers. Check out our [FAQ](./docs/faq.md) for more information. +All features are contributed by you, our amazing Aspire community, and maintained by a core set of maintainers. Check out our [FAQ](./docs/faq.md) for more information. ## 👀 What does this repo contain? -This repository contains the source code for the .NET Aspire Community Toolkit, a collection of community created Integrations and extensions for [.NET Aspire](https://aka.ms/dotnet/aspire). +This repository contains the source code for the Aspire Community Toolkit, a collection of community created Integrations and extensions for [Aspire](https://aka.ms/dotnet/aspire). | Package | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -29,7 +29,7 @@ This repository contains the source code for the .NET Aspire Community Toolkit, | - **Learn More**: [`Hosting.Python.Extensions`][python-ext-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Python.Extensions][python-ext-shields]][python-ext-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.Python.Extensions][python-ext-shields-preview]][python-ext-nuget-preview] | An integration that contains some additional extensions for running python applications | | - **Learn More**: [`Hosting.KurrentDB`][kurrentdb-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Hosting.KurrentDB][kurrentdb-shields]][kurrentdb-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.KurrentDB][kurrentdb-shields-preview]][kurrentdb-nuget-preview] | An Aspire hosting integration leveraging the [KurrentDB](https://www.kurrent.io) container. | | - **Learn More**: [`KurrentDB`][kurrentdb-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.KurrentDB][kurrentdb-client-shields]][kurrentdb-client-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.KurrentDB][kurrentdb-client-shields-preview]][kurrentdb-client-nuget-preview] | An Aspire client integration for the [KurrentDB](https://github.com/kurrent-io/KurrentDB-Client-Dotnet) package. | -| - **Learn More**: [`Hosting.Flagd`][flagd-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Hosting.Flagd][flagd-shields]][flagd-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.Flagd][flagd-shields-preview]][flagd-nuget-preview] | A .NET Aspire hosting integration for [flagd](https://flagd.dev), a feature flag evaluation engine. | +| - **Learn More**: [`Hosting.Flagd`][flagd-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Hosting.Flagd][flagd-shields]][flagd-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.Flagd][flagd-shields-preview]][flagd-nuget-preview] | An Aspire hosting integration for [flagd](https://flagd.dev), a feature flag evaluation engine. | | - **Learn More**: [`Hosting.ActiveMQ`][activemq-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Hosting.ActiveMQ][activemq-shields]][activemq-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.ActiveMQ][activemq-shields-preview]][activemq-nuget-preview] | An Aspire hosting integration leveraging the [ActiveMq](https://activemq.apache.org) container. | | - **Learn More**: [`Hosting.Sqlite`][sqlite-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Hosting.Sqlite][sqlite-shields]][sqlite-hosting-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Hosting.Sqlite][sqlite-shields-preview]][sqlite-hosting-nuget-preview] | An Aspire hosting integration to setup a SQLite database with optional SQLite Web as a dev UI. | | - **Learn More**: [`Microsoft.Data.Sqlite`][sqlite-integration-docs]
- Stable 📦: [![CommunityToolkit.Aspire.Microsoft.Data.Sqlite][sqlite-shields]][sqlite-nuget]
- Preview 📦: [![CommunityToolkit.Aspire.Microsoft.Data.Sqlite][sqlite-shields-preview]][sqlite-nuget-preview] | An Aspire client integration for the Microsoft.Data.Sqlite NuGet package. | @@ -70,7 +70,7 @@ _Stable releases are not published to the Azure Artifacts feeds, they can only b ## 📃 Documentation -Documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/overview). +Documentation for the Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/overview). ## 🚀 Contribution diff --git a/docs/create-integration.md b/docs/create-integration.md index 3b1e21866..ddb57dc67 100644 --- a/docs/create-integration.md +++ b/docs/create-integration.md @@ -1,12 +1,12 @@ ## 💡 Creating an Integration -So, you want to create a new integration for the .NET Aspire Community Toolkit? That's awesome! This guide will walk you through the process of creating a new integration. +So, you want to create a new integration for the Aspire Community Toolkit? That's awesome! This guide will walk you through the process of creating a new integration. First up, make sure you've had a read of the [Contributing guide](../CONTRIBUTING.md) to understand the contribution guidelines, and then familiarise yourself with creating a custom .NET Aspire integration for [hosting](https://learn.microsoft.com/dotnet/aspire/extensibility/custom-hosting-integration?tabs=windows) or for [clients](https://learn.microsoft.com/dotnet/aspire/extensibility/custom-client-integration). ## 📂 Repository Structure -The repository structure for the .NET Aspire Community Toolkit is as follows: +The repository structure for the Aspire Community Toolkit is as follows: - `src/` - Contains the source code for the toolkit and where you'll create your integration. - `tests/` - Contains the test projects for the toolkit and where you'll create unit and integration tests (where applicable). @@ -133,4 +133,4 @@ Here's an example from the OllamaSharp integration: ## 🎉 You're done -That's it! You've created a new integration for the .NET Aspire Community Toolkit. If you have any questions or need help, feel free to reach out to the maintainers or the community on GitHub Discussions. +That's it! You've created a new integration for the Aspire Community Toolkit. If you have any questions or need help, feel free to reach out to the maintainers or the community on GitHub Discussions. diff --git a/docs/diagnostics.md b/docs/diagnostics.md index e2a3972a4..958eb3e63 100644 --- a/docs/diagnostics.md +++ b/docs/diagnostics.md @@ -1,14 +1,14 @@ -# .NET Aspire Community Toolkit Diagnostics +# Aspire Community Toolkit Diagnostics -Some of the API's in the .NET Aspire Community Toolkit are decorated with the [`ExperimentalAttrible`](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute). This attribute is used to indicate that an API is not ready for production use and is subject to change in the future. +Some of the API's in the Aspire Community Toolkit are decorated with the [`ExperimentalAttrible`](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute). This attribute is used to indicate that an API is not ready for production use and is subject to change in the future. ## CTASPIRE001 -There are cases where there is an API provided by the .NET Aspire Community Toolkit that is an intermidiary solution until a feature is added to .NET Aspire itself. This could be a private API that is not yet ready for public consumption, or a workaround waiting for the completion of a feature in .NET Aspire. +There are cases where there is an API provided by the Aspire Community Toolkit that is an intermidiary solution until a feature is added to .NET Aspire itself. This could be a private API that is not yet ready for public consumption, or a workaround waiting for the completion of a feature in .NET Aspire. In these cases, refer to the `` docs section of the API for more information on the feature in .NET Aspire and the issue(s) to track. -Once a release of .NET Aspire with that API is available, the API in the .NET Aspire Community Toolkit will be marked as obsolete and will be removed in a future release. +Once a release of .NET Aspire with that API is available, the API in the Aspire Community Toolkit will be marked as obsolete and will be removed in a future release. ## CTASPIRE002 diff --git a/docs/faq.md b/docs/faq.md index d72f3478a..25881646a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,19 +6,19 @@ The goal of the project is to be a centralised home for extensions and integrati ## How is this project different from the official .NET Aspire project? -The .NET Aspire Community Toolkit is a community-driven project that is maintained by the community and is not officially supported by the .NET Aspire team. The toolkit is a collection of integrations and extensions that are built on top of the .NET Aspire project. +The Aspire Community Toolkit is a community-driven project that is maintained by the community and is not officially supported by the .NET Aspire team. The toolkit is a collection of integrations and extensions that are built on top of the .NET Aspire project. ## How can I contribute to the project? -Anyone can contribute to the .NET Aspire Community Toolkit and before you get started, be sure to read the [Contributing Guide](../CONTRIBUTING.md) to learn how to contribute to the project. +Anyone can contribute to the Aspire Community Toolkit and before you get started, be sure to read the [Contributing Guide](../CONTRIBUTING.md) to learn how to contribute to the project. ## Should I propose a new integration here on or the `dotnet/aspire` repo? -If you have an idea for a new integration, you should propose it here on the .NET Aspire Community Toolkit repository, rather than [`dotnet/aspire`](https://github.com/dotnet/aspire), as the official .NET Aspire project is focused on the core functionality of the .NET Aspire project. +If you have an idea for a new integration, you should propose it here on the Aspire Community Toolkit repository, rather than [`dotnet/aspire`](https://github.com/dotnet/aspire), as the official .NET Aspire project is focused on the core functionality of the .NET Aspire project. If you have previously proposed an integration on the `dotnet/aspire` repository, you can still propose it here, but link to the existing issue on the `dotnet/aspire` repository to provide context. ## Finding Community Toolkit Integrations -Integrations from the .NET Aspire Community Toolkit will appear in the "Add Aspire Integration" dialog in Visual Studio under the namespace `CommunityToolkit.Aspire.*`. +Integrations from the Aspire Community Toolkit will appear in the "Add Aspire Integration" dialog in Visual Studio under the namespace `CommunityToolkit.Aspire.*`. diff --git a/docs/versioning.md b/docs/versioning.md index 3d85edccc..3f4da5e7a 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -1,6 +1,6 @@ # Overview -The .NET Aspire Community Toolkit follows the [Semantic Versioning 2.0.0](https://semver.org/) specification and aims to keep in sync with the .NET Aspire version numbers to a minor version level. This means that the major version of the toolkit will be the same as the major version of the .NET Aspire framework. +The Aspire Community Toolkit follows the [Semantic Versioning 2.0.0](https://semver.org/) specification and aims to keep in sync with the .NET Aspire version numbers to a minor version level. This means that the major version of the toolkit will be the same as the major version of the .NET Aspire framework. Individual Community Toolkit NuGet packages may version at a patch level different to .NET Aspire, but the major and minor versions will be the same. For example, a package with the version 8.2.x will be compatible with .NET Aspire 8.2, and the patch version may be different. @@ -8,7 +8,7 @@ This means that the introduction of a new integration will not result in a major ## Release Process -The .NET Aspire Community Toolkit aims to be released in sync with .NET Aspire, but there may be a short lag, depending on bandwidth of the maintainers and complexity of any changes. +The Aspire Community Toolkit aims to be released in sync with .NET Aspire, but there may be a short lag, depending on bandwidth of the maintainers and complexity of any changes. Releases are automated using GitHub Actions, each release will be tagged in the repository with the version number, and a release will be created on GitHub with the release notes (where possible).