Skip to content

Update release notes link to use aka.ms. #294

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 1 commit into from
Jun 4, 2018
Merged

Update release notes link to use aka.ms. #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion pkg/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<PackageLicenseUrl>https://github.com/dotnet/machinelearning/blob/master/LICENSE</PackageLicenseUrl>
<PackageProjectUrl>https://dot.net/ml</PackageProjectUrl>
<PackageIconUrl>https://aka.ms/mlnetlogo</PackageIconUrl>
<PackageReleaseNotes>https://github.com/dotnet/machinelearning/tree/master/Documentation/release-notes</PackageReleaseNotes>
<PackageReleaseNotes>https://aka.ms/mlnetreleasenotes</PackageReleaseNotes>
Copy link
Contributor

Choose a reason for hiding this comment

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

Who owns this path? Can you assign rights to edit it for ml.net group?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want a versioned link? http://aka.ms/mlnetreleasenotes-v0.2

If it's being built into the package itself, we may want a versioned link.

Copy link
Contributor

Choose a reason for hiding this comment

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

The Aka.ms is pointing to the list of release notes, we can have a specific one when 1.0 drops

Copy link
Member Author

Choose a reason for hiding this comment

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

We found on our team that if we have a versioned link, it gets stale very easily. Especially as you start multiple servicing branches and shipping patches often. See https://github.com/dotnet/corefx/issues/29314, https://github.com/dotnet/corefx/issues/26014. Someone needs to update the link for every preview/release/patch/etc.

So the current experiment is to have one URL that points to the "root" of the release notes. The users can navigate to the specific version as necessary. It puts a little more work on the user, but at least it doesn't point them to the wrong place.

Copy link
Member Author

Choose a reason for hiding this comment

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

Who owns this path? Can you assign rights to edit it for ml.net group?

@shauheen created the aka.ms link for me.

</PropertyGroup>

<ItemGroup>
Expand Down