Skip to content

Fix typos in Update custom-resources.md #934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 17, 2024
Merged

Fix typos in Update custom-resources.md #934

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d141a27
Fix typos in Update custom-resources.md
DamianEdwards May 17, 2024
17afc44
Fix another backslash
DamianEdwards May 17, 2024
e16f9b7
Update custom-resources.md
IEvangelist May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/extensibility/custom-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to shutdown the app (you can close the browse
dotnet add ./MailDev.Hosting/MailDev.Hosting.csproj package Aspire.Hosting --version 8.0.0-preview.7.24251.11
```

> [!IMPORTANT]
> The version you specify here should match the version of the .NET Aspire workload installed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note, technically I don't think it needs to match the Aspire workload, but instead the version of Aspire.Hosting.AppHost package reference in the AppHost project.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(which ideally, both that and the workload would be the same version, but that is not always the case)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what is being added... it will always match itself 🤣. The .NET CLI command is adding a package reference to version 8.0.0.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right after the project is created, then yes, they will match of course. But think about the scenario where I have one workload version, create the project and push it to a repo, and you have a different workload version and pull the repo, and want to work on a client library (hosting package). This is what I meant that you'll want to match the version of the packagereference (which will match my workload as opposed to yours) instead of the version of your workload.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to change the versions back in a few days ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shhhhh


1. Add class library reference to the _MailDevResource.AppHost_ project.

```dotnetcli
Expand Down Expand Up @@ -212,9 +215,9 @@ _The MailDev web app should look similar to the following:_

Once .NET Aspire can successfully launch the MailDev component, it's time to consume the connection information for MailDev within a .NET project. In .NET Aspire it's common for there to be a _hosting package_ and one or more _component packages_. For example consider:

- **Hosting package**:
- **Hosting package**: Used to represent resources within the app model.
- `Aspire.Hosting.Redis`
- **Component packages**:
- **Component packages**: Used to configure and consume client libraries.
- `Aspire.StackExchange.Redis`
- `Aspire.StackExchange.Redis.DistributedCaching`
- `Aspire.StackExchange.Redis.OutputCaching`
Expand Down
Loading