tldr; This is a status update on the .NET documentation. If you want me to do more of those (once a month), please let me know in the comments!
Hi everyone!
If you missed our first post for June, well today I’m posting a summary of all .NET related documentation that were updated significantly during the month of July.
My name is Maxime Rouiller and I’m a Cloud Advocate with Microsoft. For the month of July, I’m covering 3 major products.
- .NET, which had ~248 commits, and 3,331 changed files on their docs repository
- ASP.NET, which had ~190 commits, and 1,413 changed files on their docs repository
- NuGet, which had ~126 commits, and 133 changed files on their docs repository
Obviously, that’s a lot of changes and I’m to help you find the gold within this tsunami of changes.
So here are all the documentation updates by product with commentary when available!
.NET Core
There were lots of consolidation in the documentation happening. Content that was specific to the .NET Framework documentation that also applies to the .NET Core documentation are being moved to the .NET Guide. Things like Native Interop (say hi to COM), the C# Language Reference
.NET Architecture
The .NET Architecture e-books content was mixed in with the fundamentals content under the .NET Guide. The team wanted to give a better home for those, so a new landing page was created.
.NET Application Architecture Guidance
Native Interop
Csharp
- sizeof operator - C# reference
- Unmanaged types - C# reference
- delegate operator - C# reference
- nameof operator - C# reference
- Built-in reference types - C# reference
- User-defined conversion operators - C# reference
- Floating-point numeric types - C# reference
-
- What is CS0844?
Cannot use local variable ‘name’ before it is declared. The declaration of the local variable hides the field ‘name’.
- More examples added on how to fix the issue.
- What is CS0844?
VB.NET
There were tons of documentation that needed examples. Here are a few. To change the language to VB, make sure you pick your favorite language on the language selector at the top of the page left of the “Feedback” button.
- Handles clause requires a WithEvents variable defined in the containing type or one of its base types
- Best Practices for exceptions - .NET
- LINQ (Language Integrated Query)
Tutorials, recommendations, and others
This .NET CLI tutorial was rewritten and went from one page to three.
- Create an item template for dotnet new - .NET Core CLI
- Create a project template for dotnet new
- Create a template pack for dotnet new
- The .NET Portability Analyzer - .NET
- Portability Analyzer article had more details added in. Things like XLSX format, what to do with missing assemblies, etc. Worth a re-read.
- Containerize an app with Docker tutorial
- Added examples, updated dockerfile
FROM
, added steps on how to build the container
- Added examples, updated dockerfile
.NET APIs
.NET Core 3.0 Preview 7 was launched on July 23rd, so the API reference documentation for .NET Core and .NET Platform Extensions 3.0 was updated.
The documentation team is also working closing with the .NET developer team to add more API documentation for .NET Core 3.0. We reduced the number of undocumented APIs by 1,374 in July and this effort will continue through the month of August.
ASP.NET Core
gRPC
Documentation keeps improving on gRPC. This time, it’s security focused.
- Authentication and authorization in gRPC for ASP.NET Core
- Security considerations in gRPC for ASP.NET Core
Troubleshooting
This doc was consolidated from other pages that handled errors and how to troubleshoot.
Blazor
Security (Authentication/Authorization/etc.)
Authentication without Identity providers tutorial. Very interesting read!
Those pages received significant changes.
- Create an ASP.NET Core app with user data protected by authorization
- Account confirmation and password recovery in ASP.NET Core
MVC / WebAPI
New features in 3.0 that allows you to use HTTP REPL directly from the CLI.
Fundamentals
This CLI global tool is used to help you create areas, controllers, views, etc. for your ASP.NET Core applications. Especially useful if you want to create your own. For the source, look no further than on GitHub.
The following are pages that received significant changes.
Host and Deploy
SignalR
Performance
This article was co-written with /u/stevejgordon! Have you heard about ObjectPool
? It prevents objects to be garbage collected and reused instead. It’s been in .NET Core forever but this article was written with performance in mind.
Tutorials
New tutorial for ASP.NET Core 3.0 Preview this time with jQuery.
Those Razor Pages tutorials received significant changes due in part to the latest Preview.
- Add a new field to a Razor Page in ASP.NET Core
- Add search to ASP.NET Core Razor Pages
- Add validation to an ASP.NET Core Razor Page
- Update the generated pages in an ASP.NET Core app
- Work with a database and ASP.NET Core
- Add a model to a Razor Pages app in ASP.NET Core
- Scaffolded Razor Pages in ASP.NET Core
- Tutorial: Get started with Razor Pages in ASP.NET Core
2 more tutorials to receive significant changes are focused on Web API and SignalR
NuGet
Including the 5.2 release notes, there’ new pages that has been created within the last month. Take a look to stay up to date!
- NuGet 5.2 RTM Release Notes
- Create a NuGet package using the dotnet CLI
- Identify the project format
- Create packages with COM interop assemblies
- Set a NuGet package type
A few of significantly modified pages includes handling nuget accounts, and Package Restore.