search

SteeltoeOSS / Documentation

The documentation, api browser, and getting started guides used for the Steeltoe's website.
Apache License 2.0
8 stars 23 forks source link

Update package references to Steeltoe 3.2.0 #268

Closed ccheetham closed 2 years ago

ccheetham commented 2 years ago

Fixes #267

TimHess commented 2 years ago

I don't see any mistakes in here, but is this all of the refs?

TimHess commented 2 years ago

I see 4 instances of -Version 3.1.0 attached to instructions for using PowerShell... maybe we should just remove those instead since it's so sporadic

bart-vmware commented 2 years ago

Perhaps leave out the version number altogether and use tabs such as here?

image

There are similar tabs on NuGet, I think the first three should cover most cases: image

ccheetham commented 2 years ago

@bart-vmware are you suggesting going from:

<ItemGroup>
...
    <PackageReference Include="Steeltoe.CircuitBreaker.HystrixCore" Version="3.2.0"/>
...
</ItemGroup>

to

dotnet add package Steeltoe.CircuitBreaker.HystrixCore
bart-vmware commented 2 years ago

I'm suggesting to use tabs, similar to https://raw.githubusercontent.com/SteeltoeOSS/Documentation/main/guides/get-to-know-steeltoe/exercise2.md:

# [Package Manager](#tab/package-manager)

PM> Install-Package Steeltoe.CircuitBreaker.HystrixCore

# [.NET CLI](#tab/dotnet-cli)

dotnet add package Steeltoe.CircuitBreaker.HystrixCore

# [PackageReference](#tab/package-reference)

<PackageReference Include="Steeltoe.Common" />
ccheetham commented 2 years ago

@TimHess updated PowerShell examples @bart-vmware I like the tabs. It's beyond the scope of this PR but would like to have a broader discussion on doc layout in near future.