Skip to content
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.

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

Change nuget packages projectUrl to point to doco or better landing page #12537

Closed
ajcvickers opened this issue Jul 3, 2018 · 6 comments · Fixed by #14177
Closed

Change nuget packages projectUrl to point to doco or better landing page #12537

ajcvickers opened this issue Jul 3, 2018 · 6 comments · Fixed by #14177
Assignees
Labels
area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported punted-for-2.2 type-bug
Milestone

Comments

@ajcvickers
Copy link
Contributor

Moved from dotnet/EntityFramework.Docs#803 filed by @SimonCropp since NuGet packages and their metadata are generated as part of the build.

Often searches will resolve to a nuget package. or people will know the nuget they are using and want to find the doco for it.

However most MS nuget

At the moment nugets point to generic getting stated pages. For example

All point to https://www.asp.net/

This experience looses all context of the users navigation history, and is unlikely to be the desired page for most people. I would expect the better locations would be

I realise that the history of nuget versions is static, but doco is a changing structure. but you could manage the redirects dynamically with all nuget pointing to a redirector https://docs.microsoft.com/nugets?Microsoft.EntityFrameworkCore.SqlServer&version=1.2.3

another option would be ad to nuget the ability to store more urls. eg "project hosting url", "docs url" etc

@ajcvickers
Copy link
Contributor Author

Assigning to @bricelam for the build part, and @divega to update existing packages on NuGet.

@SimonCropp
Copy link
Contributor

@ajcvickers sorry for the cheese moving. but i actually think this should be in https://github.com/MicrosoftDocs/feedback. since it is not specific to only EF. thoughts??

@ajcvickers
Copy link
Contributor Author

@SimonCropp We can change what we do for EF packages. For other packages, you'll need to file an issue in an appropriate place where the owners of those packages will see it. I suspect in all cases the issues should be in "code" repos not docs repos because the packages are generated by the build. The same thing applies to API docs. For other packages in ASP.NET, https://github.com/aspnet/Home would be the right place.

@divega
Copy link
Contributor

divega commented Jul 24, 2018

@divega to update existing packages on NuGet.

I tried to do this. I was wrong.

Editing package metadata is not supported.
To make edits to the package metadata, we recommend uploading a new version of the package created using the updated nuspec. Read more

@divega divega removed their assignment Jul 24, 2018
@divega divega changed the title Change nuget urls to point to doco or better landing page Change nuget packages projectUrl to point to doco or better landing page Aug 27, 2018
@ajcvickers ajcvickers modified the milestones: 2.2.0-preview2, 2.2.0 Sep 11, 2018
@ajcvickers ajcvickers modified the milestones: 2.2.0, 3.0.0 Oct 1, 2018
@bricelam
Copy link
Contributor

bricelam commented Dec 3, 2018

@divega What URL should we use?

@divega
Copy link
Contributor

divega commented Dec 4, 2018

For starers, I would point almost all our packages to https://docs.microsoft.com/ef/core/. But providers can point to their specific pages, e.g. https://docs.microsoft.com/ef/core/providers/sql-server/.

We should also make sure we have pointers to GitHub visible in the documentation (the SQL Server provider already has it).

Normally I would use a fwlink, but it just happens that NuGet gallery shows the actual URL in the UI, so perhaps aka.ms links with something meaningful would be better.

Sounds good?

bricelam added a commit that referenced this issue Dec 15, 2018
bricelam added a commit that referenced this issue Dec 17, 2018
bricelam added a commit that referenced this issue Dec 17, 2018
bricelam added a commit that referenced this issue Dec 17, 2018
bricelam added a commit that referenced this issue Dec 17, 2018
bricelam added a commit that referenced this issue Dec 17, 2018
bricelam added a commit that referenced this issue Dec 18, 2018
bricelam added a commit that referenced this issue Dec 18, 2018
bricelam added a commit that referenced this issue Dec 18, 2018
bricelam added a commit that referenced this issue Dec 18, 2018
Notes for Muggles:

- `build` only compiles by default. Add `-test` to run tests and `-pack` to get nupkgs
- Dependency versions are now in `eng/Versions.props`
- No more API Check, *.baselines.json, or *.breakingchanges.json
- No more NuGet package verifier
- Nightly builds are now published to https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json

Fixes #12537, resolves #14025, resolves dotnet/arcade#1051, resolves dotnet/arcade#1052, resolves dotnet/arcade#1053, resolves dotnet/arcade#1054
bricelam added a commit that referenced this issue Dec 18, 2018
Notes for Muggles:

- `build` only compiles by default. Add `-test` to run tests and `-pack` to get nupkgs
- Dependency versions are now in `eng/Versions.props`
- No more API Check, *.baselines.json, or *.breakingchanges.json
- No more NuGet package verifier
- Nightly builds are now published to https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json

Fixes #12537, resolves #14025, resolves dotnet/arcade#1051, resolves dotnet/arcade#1052, resolves dotnet/arcade#1053, resolves dotnet/arcade#1054
bricelam added a commit that referenced this issue Dec 18, 2018
Notes for Muggles:

- `build` only compiles by default. Add `-test` to run tests and `-pack` to get nupkgs
- Dependency versions are now in `eng/Versions.props`
- No more API Check, *.baselines.json, or *.breakingchanges.json
- No more NuGet package verifier
- Nightly builds are now published to https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json

Fixes #12537, resolves #14025, resolves dotnet/arcade#1051, resolves dotnet/arcade#1052, resolves dotnet/arcade#1053, resolves dotnet/arcade#1054
bricelam added a commit that referenced this issue Dec 19, 2018
Notes for Muggles:

- `build` only compiles by default. Add `-test` to run tests and `-pack` to get nupkgs
- Dependency versions are now in `eng/Versions.props`
- No more API Check, *.baselines.json, or *.breakingchanges.json
- No more NuGet package verifier
- Nightly builds are now published to https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json

Fixes #12537, resolves #14025, resolves dotnet/arcade#1051, resolves dotnet/arcade#1052, resolves dotnet/arcade#1053, resolves dotnet/arcade#1054
bricelam added a commit that referenced this issue Dec 19, 2018
Notes for Muggles:

- `build` only compiles by default. Add `-test` to run tests and `-pack` to get nupkgs
- Dependency versions are now in `eng/Versions.props`
- No more API Check, *.baselines.json, or *.breakingchanges.json
- No more NuGet package verifier
- Nightly builds are now published to https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json

Fixes #12537, resolves #14025, resolves dotnet/arcade#1051, resolves dotnet/arcade#1052, resolves dotnet/arcade#1053, resolves dotnet/arcade#1054
@ajcvickers ajcvickers added the closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. label Jan 25, 2019
@ajcvickers ajcvickers modified the milestones: 3.0.0, 3.0.0-preview2 Feb 6, 2019
@ajcvickers ajcvickers modified the milestones: 3.0.0-preview2, 3.0.0 Nov 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported punted-for-2.2 type-bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants