search

dotnet / SqlClient

Microsoft.Data.SqlClient provides database connectivity to SQL Server for .NET applications.
MIT License
860 stars 288 forks source link

Move relative to absolute docs path #2949

Closed MichelZ closed 1 week ago

MichelZ commented 2 weeks ago

Moving relative links to learn.microsoft.com, also verify msdn/docs .microsoft.com links and replacing them with learn.microsoft.com.

.xml Documentation files only

Fixes #2883

benrr101 commented 2 weeks ago

Thank you for your contribution to this! I'm glad someone was keen enough to take on this annoying task!

I'm going to have to look into this a little bit before signing off on it. According to @cheenamalhotra, we get warnings from [something] when absolute links are used. So it's an unfortunate situation where if we use relative links, the links don't work in IDEs but the doc websites are happy, and vice versa if we use absolute links.

MichelZ commented 2 weeks ago

Sure, let me know where you see the error and I can also look for creative workarounds ;)

benrr101 commented 2 weeks ago

Tbh, I'm not sure exactly where this error comes in. My assumption is that it comes from our doc website generation process, but I don't know what that is. Need @cheenamalhotra's input on that

benrr101 commented 2 weeks ago

/azp run

azure-pipelines[bot] commented 2 weeks ago
Azure Pipelines could not run because the pipeline triggers exclude this branch/path.
cheenamalhotra commented 2 weeks ago

I'm going to have to look into this a little bit before signing off on it. According to @cheenamalhotra, we get warnings from [something] when absolute links are used. So it's an unfortunate situation where if we use relative links, the links don't work in IDEs but the doc websites are happy, and vice versa if we use absolute links.

I believe we will get warnings in .NET API reference, when the docs will be published. Something we should follow up internally, if this will be allowed with the .NET API reference docs team, because the XML files are the same that are published to both VS intellisense and .NET API reference Microsoft documentation.