dotnet / docs

This repository contains .NET Documentation.
https://learn.microsoft.com/dotnet
Creative Commons Attribution 4.0 International
4.27k stars 5.9k forks source link

Duplicate LINQ articles #16482

Open gewarren opened 4 years ago

gewarren commented 4 years ago

Some LINQ articles are duplicated in the /visual-basic and /csharp subfolders. This is bad from a maintenance perspective. Can we consolidate?

For example:

https://docs.microsoft.com/en-us/dotnet/visual-basic/programming-guide/concepts/linq/linq-to-adonet-portal-page and https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/linq-to-adonet-portal-page

https://docs.microsoft.com/en-us/dotnet/visual-basic/programming-guide/concepts/linq/enabling-a-data-source-for-linq-querying and https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/enabling-a-data-source-for-linq-querying1

https://docs.microsoft.com/en-us/dotnet/visual-basic/programming-guide/concepts/linq/visual-studio-ide-and-tools-support-for-linq and https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/visual-studio-ide-and-tools-support-for-linq

Youssef1313 commented 4 years ago

Where they should be consolidated ?

gewarren commented 4 years ago

It's probably fine to have a LINQ section in each language's TOC, but for articles that are duplicated, we could either convert them to an include file that's reused in each TOC, or we could choose one location (I'd say C#) and then link to that file from the other (VB) TOC - link it with a contextual TOC link so you don't jump to the C# TOC when you click it.

Youssef1313 commented 4 years ago

Wouldn't it be better to find some directory that holds LINQ article for both languages ?

I was thinking of having a linq directory in docs\standard and move the articles in both languages there. For articles that are in only one language, It might be easy to write the snippets in the other language. So, at the end, the linq folders in csharp or visualbasic will be completely removed, and redirected to the new linq folder in standard. Currently, there is one article related to linq in docs\standard folder, it may be moved to that linq folder after creating it.

mairaw commented 4 years ago

This is similar to the issue #4728. The vendor team has started the consolidation of the LINQ to XML articles under standard/linq. You can see the progress here: https://github.com/dotnet/docs/tree/linq-to-xml

Next step was going to be to move into the other sections.

mairaw commented 4 years ago

I've opened https://github.com/dotnet/docs/pull/16969 so you can see what we're doing there and comment on the direction if wanted. But we're basically doing exactly what @Youssef1313 mentioned. Including the move of the standalone LINQ article from standard to standard\linq.

But that section is large, so it might take a while to finish and merge.

mairaw commented 4 years ago

Just found out that there dupe articles in other areas too. For example: https://docs.microsoft.com/en-us/previous-versions/hh534540(v=vs.140) has the links to the C# and VB version

dotnet-bot commented 3 years ago

This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the @dotnet/docs team for visibility.

Youssef1313 commented 3 years ago

@BillWagner This is still an issue. Consider re-opening to track merging the duplicate articles.