Skip to content

Commit

Permalink
Merge pull request #53 from CommunityToolkit/docs-move
Browse files Browse the repository at this point in the history 
Migrating docs to dotnet/docs-aspire
  • Loading branch information
@aaronpowell
aaronpowell authored Oct 10, 2024
2 parents 99bb4a0 + 830dfb6 commit 7d8e38d
Show file tree
Hide file tree
Showing 40 changed files with 380 additions and 686 deletions.
50 changes: 0 additions & 50 deletions .github/workflows/docs.yml
View file

This file was deleted.

4 changes: 1 addition & 3 deletions CODEOWNERS
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@

# Aspire.CommunityToolkit.Hosting.Java

/docs/integrations/hosting-java/_ @justinyoo
/examples/java/_ @justinyoo
/src/Aspire.CommunityToolkit.Hosting.Java/_ @justinyoo
/tests/Aspire.CommunityToolkit.Hosting.Java/_ @justinyoo

# Aspire.CommunityToolkit.Hosting.Golang

/docs/integrations/hosting-golang* @tommasodotNET
/examples/golang/* @tommasodotNET
/examples/golang/_ @tommasodotNET
/src/Aspire.CommunityToolkit.Hosting.Golang/_ @tommasodotNET
/tests/Aspire.CommunityToolkit.Hosting.Golang/_ @tommasodotNET
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,18 @@ The .NET Aspire Community Toolkit also has a list of issues that are labeled as

## 📝 Add or Improve Documentation <a name="docs"></a>

The documentation for the .NET Aspire Community Toolkit is available on the [GitHub Pages site](https://communitytoolkit.github.io/aspire/). If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR.
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).

## 🚀 Create, Submit or Review Pull Request <a name="pr"></a>

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.

### 📦 Add New Integration <a name="integration"></a>

For more detailed information on how to add a new integration, refer to the [building an integration](./docs/create-integration.md) documentation.

Also, familiarise yourself with the [versioning](./docs/versioning.md) and [diagnostics](./docs/diagnostics.md) documentation to understand the process of adding new integrations and APIs.

## 💙 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.**
Expand Down
35 changes: 23 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,28 @@

The .NET Aspire Community Toolkit is a collection of common components and extensions for development with .NET Aspire.

All features are contributed by you, our amazing .NET community, and maintained by a core set of maintainers.
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.

## 👀 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).

| Package | Latest stable | Latest Preview | Description |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`Hosting.Azure.StaticWebApps`][swa-integration-docs] | [![Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps][swa-shields]][swa-nuget] | [![Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps][swa-shields-preview]][swa-nuget-preview] | A hosting integration for the [Azure Static Web Apps emulator](https://learn.microsoft.com/azure/static-web-apps/static-web-apps-cli-overview) (Note: this does not support deployment of a project to Azure Static Web Apps). |
| [`Hosting.Java`][java-integration-docs] | [![Aspire.CommunityToolkit.Hosting.Java][java-shields]][java-nuget] | [![Aspire.CommunityToolkit.Hosting.Java][java-shields-preview]][java-nuget-preview] | A integration for running Java code in .NET Aspire either using the local JDK or using a container. |
| [`Hosting.NodeJS.Extensions`][nodejs-ext-integration-docs] | [![Aspire.CommunityToolkit.NodeJS.Extensions][nodejs-ext-shields]][nodejs-ext-nuget] | [![Aspire.CommunityToolkit.Hosting.NodeJS.Extensions][nodejs-ext-shields-preview]][nodejs-ext-nuget-preview] | An integration that contains some additional extensions for running Node.js applications |
| [`Hosting.Ollama`][ollama-integration-docs] | [![Aspire.CommunityToolkit.Ollama][ollama-shields]][ollama-nuget] | [![Aspire.CommunityToolkit.Hosting.Ollama][ollama-shields-preview]][ollama-nuget-preview] | An Aspire component leveraging the [Ollama](https://ollama.com) container with support for downloading a model on startup. |
| Package | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| - **Learn More**: [`Hosting.Azure.StaticWebApps`][swa-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps][swa-shields]][swa-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps][swa-shields-preview]][swa-nuget-preview] | A hosting integration for the [Azure Static Web Apps emulator](https://learn.microsoft.com/azure/static-web-apps/static-web-apps-cli-overview) (Note: this does not support deployment of a project to Azure Static Web Apps). |
| - **Learn More**: [`Hosting.Golang`][golang-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.Hosting.Golang][golang-shields]][golang-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.Hosting.Golang][golang-shields-preview]][golang-nuget-preview] | A hosting integration Golang apps. |
| **Learn More**: [`Hosting.Java`][java-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.Hosting.Java][java-shields]][java-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.Hosting.Java][java-shields-preview]][java-nuget-preview] | A integration for running Java code in .NET Aspire either using the local JDK or using a container. |
| - **Learn More**: [`Hosting.NodeJS.Extensions`][nodejs-ext-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.NodeJS.Extensions][nodejs-ext-shields]][nodejs-ext-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.Hosting.NodeJS.Extensions][nodejs-ext-shields-preview]][nodejs-ext-nuget-preview] | An integration that contains some additional extensions for running Node.js applications |
| - **Learn More**: [`Hosting.Ollama`][ollama-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.Hosting.Ollama][ollama-shields]][ollama-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.Hosting.Ollama][ollama-shields-preview]][ollama-nuget-preview] | An Aspire hosting integration leveraging the [Ollama](https://ollama.com) container with support for downloading a model on startup. |
| - **Learn More**: [`OllamaSharp`][ollama-integration-docs] <br /> - Stable 📦: [![Aspire.CommunityToolkit.OllamaSharp][ollamasharp-shields]][ollamasharp-nuget] <br /> - Preview 📦: [![Aspire.CommunityToolkit.OllamaSharp][ollamasharp-shields-preview]][ollama-nuget-preview] | An Aspire client integration for the [OllamaSharp](https://github.com/awaescher/OllamaSharp) package. |

## 🙌 Getting Started

Each of the integrations in the toolkit is available as a NuGet package, and can be added to your .NET project. Refer to the table above for the available integrations and the documentation on how to use them.

## 📃 Documentation

Documentation for the .NET Aspire Community Toolkit is available on the [GitHub Pages site](https://communitytoolkit.github.io/aspire/).
Documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/).

## 🚀 Contribution

Expand All @@ -47,23 +49,32 @@ As a part of the .NET Foundation, we have adopted the [.NET Foundation Code of C

This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

[swa-integration-docs]: https://communitytoolkit.github.io/aspire/integrations/hosting-azure-static-web-apps
[swa-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-azure-static-web-apps
[swa-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps
[swa-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/
[swa-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps?label=nuget%20(preview)
[swa-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/absoluteLatest
[java-integration-docs]: https://communitytoolkit.github.io/aspire/integrations/hosting-java
[golang-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-golang
[golang-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Golang
[golang-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Golang/
[golang-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Golang?label=nuget%20(preview)
[golang-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Golang/absoluteLatest
[java-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-java
[java-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Java
[java-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Java/
[java-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Java?label=nuget%20(preview)
[java-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Java/absoluteLatest
[nodejs-ext-integration-docs]: https://communitytoolkit.github.io/aspire/integrations/hosting-nodejs-extensions
[nodejs-ext-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-nodejs-extensions
[nodejs-ext-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions
[nodejs-ext-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/
[nodejs-ext-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions?label=nuget%20(preview)
[nodejs-ext-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/absoluteLatest
[ollama-integration-docs]: https://communitytoolkit.github.io/aspire/integrations/hosting-ollama
[ollama-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-ollama
[ollama-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Ollama
[ollama-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Ollama/
[ollama-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.Hosting.Ollama?label=nuget%20(preview)
[ollama-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.Hosting.Ollama/absoluteLatest
[ollamasharp-shields]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.OllamaSharp
[ollamasharp-nuget]: https://nuget.org/packages/Aspire.CommunityToolkit.OllamaSharp/
[ollamasharp-shields-preview]: https://img.shields.io/nuget/v/Aspire.CommunityToolkit.OllamaSharp?label=nuget%20(preview)
[ollamasharp-nuget-preview]: https://nuget.org/packages/Aspire.CommunityToolkit.OllamaSharp/absoluteLatest
Loading

0 comments on commit 7d8e38d

Please sign in to comment.