Skip to content

Fix absolute links https://docs.microsoft.com/dotnet links to relative links - #9837

Merged
mairaw merged 3 commits into
dotnet:masterfrom
msschl:fix-absolute-links
Jan 16, 2019
Merged

mairaw merged 3 commits into
dotnet:masterfrom
msschl:fix-absolute-links

Conversation

@msschl

@msschl msschl commented Jan 4, 2019 •

Copy link
Copy Markdown
Contributor

Summary

Changed absolute https://docs.microsoft.com/dotnet links to relative links.

Contributes to #8364

edit by @mairaw: updated keyword and issue number

Changed absolute https://docs.microsoft.com/dotnet links to relative
links.

@mairaw mairaw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changes look great @msschl but the style guide page should use the absolute path since that page is only used here on GitHub and not part of docs, so the ~ notation won't work.

Comment thread styleguide/template.md Resolved
Comment thread styleguide/template.md Resolved
mairaw and others added 2 commits January 5, 2019 13:45
Co-Authored-By: msschl <markus_schlotbohm@as-gmbh.de>
Co-Authored-By: msschl <markus_schlotbohm@as-gmbh.de>
@msschl

msschl commented Jan 8, 2019

Copy link
Copy Markdown
Contributor Author

@mairaw reverted links to absolute links in styleguide/template.md.

@nxtn nxtn left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since the destinations locate in the same repo, I found it's more common to use relative links that start with ../.

And the ~ notation doesn't work on GitHub.

## The custom Entity base class

The following code is an example of an Entity base class where you can place code that can be used the same way by any domain entity, such as the entity ID, [equality operators](https://docs.microsoft.com/dotnet/csharp/language-reference/operators/equality-comparison-operator), a domain event list per entity, etc.
The following code is an example of an Entity base class where you can place code that can be used the same way by any domain entity, such as the entity ID, [equality operators](~/docs/csharp/language-reference/operators/equality-comparison-operator.md), a domain event list per entity, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following code is an example of an Entity base class where you can place code that can be used the same way by any domain entity, such as the entity ID, [equality operators](~/docs/csharp/language-reference/operators/equality-comparison-operator.md), a domain event list per entity, etc.
The following code is an example of an Entity base class where you can place code that can be used the same way by any domain entity, such as the entity ID, [equality operators](../../../../csharp/language-reference/operators/equality-comparison-operator.md), a domain event list per entity, etc.


- **Unit testing in .NET Core using dotnet test** <br/>
[*https://docs.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test*](https://docs.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test)
[*https://docs.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test*](~/docs/core/testing/unit-testing-with-dotnet-test.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
[*https://docs.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test*](~/docs/core/testing/unit-testing-with-dotnet-test.md)
[*https://docs.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test*](../../../../core/testing/unit-testing-with-dotnet-test.md)

@mairaw mairaw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for your changes @msschl and your feedback @NextTurn. I agree that the relative paths are preferred but they are not required, so I'll merge this as-is. For the files inside the includes folder though, the ~ are better because you don't know in which topic they'll be used, so in that case the use of ~ is better.

@mairaw
mairaw merged commit ac489d3 into dotnet:master Jan 16, 2019
@nxtn

nxtn commented Jan 16, 2019

Copy link
Copy Markdown
Contributor

@mairaw Shall we add this special rule for includes folder to styleguide/template.md#internal-links?

@mairaw

mairaw commented Jan 16, 2019

Copy link
Copy Markdown
Contributor

I think that would be good!

@nxtn

nxtn commented Jan 17, 2019

Copy link
Copy Markdown
Contributor

Well we have 4K links with ../includes/.

https://github.com/dotnet/docs/search?q=..%2Fincludes%2F

@mairaw

mairaw commented Jan 17, 2019

Copy link
Copy Markdown
Contributor

Using .. for the includes links in the content inside the docs folder is fine. My comment was regarding the links to our content from the files inside the includes like we had a few in this PR. For those files, we should use ~ for relative links. Makes sense?

@nxtn

nxtn commented Jan 17, 2019

Copy link
Copy Markdown
Contributor

Oh OK, I got it.

@msschl
msschl deleted the fix-absolute-links branch February 15, 2019 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants