As .NET 5 approaches, content / documentation reorganization begins – Visual Studio Magazine


New

As .NET 5 approaches, content / documentation reorganization begins

A GitHub project is looking to revamp documentation and developer content ahead of the November launch of .NET 5, a unification of everything that combines with .NET. .NET Core and other components.

“There will only be one .NET, and you can use it to target Windows, Linux, macOS, iOS, Android, tvOS, watchOS and WebAssembly and more,” Microsoft noted last year by announcing .NET 5, which will include components for desktop, web, cloud, mobile, games, IoT and AI.

Along with this huge consolidation effort, an issue of GitHub titled “.NET 5 Wave – Reorganization # 18923“seeks to change the way users and developers find content, like documentation.

“For .NET 5, we are rearranging the content to match the workloads describing what you can create with .NET. Each child project contains the issues (tasks) for that specific workload area,” explains the problem opened by David Pine of Microsoft. “The amount of work reflects the organization of content that no longer reflects the modern .NET vision. Visitors shouldn’t need to understand the history of .NET to find information on building .NET applications now.

“However, existing customers should be able to easily find content based on their current knowledge of the product and its brands. ”

.NET 5
[Click on image for larger view.] .NET 5 (source: Microsoft).

Areas of focus include “.NET Framework (.NET 5 Wave)”, the legacy offering before .NET Core took on cross-platform and open source .NET. This will require little new content, mainly involving the movement of existing content.

In contrast, “.NET Fundamentals (.NET 5 wave)” will require the greatest reorganization. “The documents we have now are organized around ‘Framework’, ‘Core’ and ‘.NET Standard’. Navigation requires understanding the history. This is a barrier for new .NET developers. The new organization reflects the ‘One .NET’ vision of .NET 5 / .NET 6 “, indicates this element.

Other areas of reorganization span the gamut from web to mobile, data, cloud and machine learning.

The .NET 5 Wave project
[Click on image for larger view.] The .NET 5 Wave project (source: Microsoft).

A reader in a comment asked if the .NET Web and .NET Mobile zones would see the existing documentation from ASP.NET and Xamarin merged.

“Yes and no, and on different schedules,” replied Bill Wagner. “I leave it to the respective problems and projects for a detailed discussion. Here is a brief version:

“In either case, these docsets will appear under docs.microsoft.com/dotnet docset. ASP.NET Core docs will be published under docs.microsoft.com/dotnet/web. Some xamarin docs will be published under docs.microsoft .com. / dotnet / mobile.

“However, we are not moving the source or closing these repositories. Instead, we will update the build scripts to change the active URL. We will keep the history and organization of the repository.”

About the Author

David Ramel is editor and writer for Converge360.


Sam D. Gomez