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

Move relative to absolute docs path #2949

Merged

Conversation

MichelZ
Copy link
Contributor

@MichelZ MichelZ commented Nov 1, 2024

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
Copy link
Contributor

benrr101 commented Nov 1, 2024

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.

@benrr101 benrr101 added the ➕ Code Health Issues/PRs that are targeted to source code quality improvements. label Nov 1, 2024
@benrr101 benrr101 added this to the 6.0-preview3 milestone Nov 1, 2024
@MichelZ
Copy link
Contributor Author

MichelZ commented Nov 1, 2024

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

@benrr101
Copy link
Contributor

benrr101 commented Nov 5, 2024

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
Copy link
Contributor

benrr101 commented Nov 5, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@cheenamalhotra
Copy link
Member

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.

Copy link
Contributor

@benrr101 benrr101 left a comment

Choose a reason for hiding this comment

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

I reached out to @gewarren to get more info on this and according to her, it's perfectly acceptable to use learn.microsoft.com as the base of our URLs. Let's go ahead and take these changes.

@MichelZ thanks for doing the tedious work (I hope you used a script or something!) :D

Copy link
Contributor

@mdaigle mdaigle left a comment

Choose a reason for hiding this comment

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

One broken link, otherwise looks good!

doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml Outdated Show resolved Hide resolved
Copy link
Member

@cheenamalhotra cheenamalhotra left a comment

Choose a reason for hiding this comment

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

Dotnet framework links are obsolete, and don't apply to Microsoft.Data.SqlClient documentation. Use sql/connect/ado-net instead.

doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlTypes/SqlFileStream.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlTypes/SqlFileStream.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlTypes/SqlFileStream.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlTypes/SqlFileStream.xml Outdated Show resolved Hide resolved
doc/snippets/Microsoft.Data.SqlTypes/SqlFileStream.xml Outdated Show resolved Hide resolved
MichelZ and others added 3 commits November 8, 2024 07:09
Co-authored-by: Malcolm Daigle <daiglemalcolm@gmail.com>
Co-authored-by: Cheena Malhotra <13396919+cheenamalhotra@users.noreply.github.com>
@cheenamalhotra cheenamalhotra merged commit 35c317b into dotnet:main Nov 13, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
➕ Code Health Issues/PRs that are targeted to source code quality improvements.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

External links in documentation are relative
4 participants