Improve Content Performance - .NET Docs
Our team will spend some time over the next three months on tasks that will improve the overall content health of the articles in this docset.
The task in the month of April is to examine report data and determine the best course of action. The result will be closing the one issue to analyze reports, and create new issues based on what we learn from those reports.
In May and June, we'll work on the tasks identified in April.
May 2021
.NET
- Items
Managed Languages
- Items
Migration guide to document scenarios around migrating apps from .NET Framework to .NET.
Overall
- .NET 6 planning
.NET
- Items
Managed Languages
- Create Fundamentals section
- Consolidate XML doc section
- Remaining C# 9 tasks
This section may split into “cloud” and “microservices” sections. We will defer that decision while building out the content based on the current outline.
We'll be integrating more closely with the existing .NET SDK for Azure docs, and providing more detailed guidance on cloud scenarios. In addition, the emphasis on "data" brings together the different brands and libraries providing data storage (EntityFramework Core, Apache Spark for .NET, Azure storage and Data Lake).
This section provides the home for the modern libraries that provide data access. This includes EF Core, Reddis, Apache SPARK and more. This overview will help readers determine the best alternatives for data storage for their application.
Consider adding a "Microservices" ToC node at the top level. Aside from that proposal, the organization is not changing. During this wave, we'll add a new hub page under .NET docs that is .NET web - with links into ASP.NET docs, etc.
C#
There are a number of improvements planned for C#. Much of the organization traces C#'s evolution through its versions. That creates an incorrect impression that the "introductory" features are the "oldest" features. There's also a heavy emphasis on Windows workloads that no longer matches the value proposition of C#. The work here is a combination of reorganization and improved learning paths for new C# developers (both new programmers and new to C#). Focus will be spent on areas that generate the most questions: The beginner areas, LINQ, and async/await. Finally, many articles are language independent, and will move to the correct language-independent area.
F#
The organization is not changing.
Visual Basic
The organization is not changing. This is to keep the docs in sync with the language message of stability for Visual Basic: Visual Basic works the same on Core, .NET 5, and Framework. The stability of the Visual Basic docs will reflect that.
Meta-project encapsulated all of the other project workloads.
For .NET 5, we are reorganizing the content to match the workloads describing what you can build with .NET. Each child project contains the issues (tasks) for that specific workload area.
- Fundamentals
- Microsoft.Extensions, DI, config, logging
- Cross platform
- Open source
- NET Framework 4.x
- C#, F#, Visual Basic
- What's new
- Include links to all .NET content: ASP.NET, Xamarin, Azure SDK for .NET
- Web apps and services
- Mobile
- Desktop
- Gaming: Focus will be on Unity and MonoGame
- Machine Learning
- Data
- Cloud
- Internet of Things
- Architecture Center
This area requires the most reorganization. The docs we have now are organized around "Framework", "Core", and ".NET Standard". Navigation requires understanding the history. That's a barrier for new .NET developers. The new organization reflects the "One .NET" vision of .NET 5 / .NET 6.
There are a number of issues around articles on asynchronous programming using async, await, System.Threading.Tasks types. There are also similar numbers of issues on the Task Parallel Library, PLINQ and related concepts. Finally, there is confusion between the terms "asynchronous programming", "multi-threaded programming" and "parallel program execution".
This project collects those issues to create a cohesive plan to address that confusion.
This project describes the tasks related to performing a review of API and conceptual content related to security and cryptography,
See issue #4161 for public discussion and list of features/scenarios.