diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index d7abcd7b..80ff2e70 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -11,6 +11,11 @@ "source_path": "Contribute/light-workflow.md", "redirect_url": "/" }, + { + "source_path": "Contribute/content/dotnet/dotnet-contribute-code-analysis.md", + "redirect_url": "/contribute/content/dotnet/code-analysis-rules", + "redirect_document_id": true + }, { "source_path": "Contribute/dotnet-contribute-process.md", "redirect_url": "/contribute/dotnet/dotnet-contribute" @@ -237,11 +242,11 @@ "source_path": "ai-navigator/index.yml", "redirect_url": "/contribute/", "redirect_document_id": false - }, + }, { "source_path": "Contribute/content/architecture-center/solution-idea-templates.md", "redirect_url": "/contribute/content/architecture-center/aac-contribute", "redirect_document_id": false } ] -} \ No newline at end of file +} diff --git a/Contribute/content/TOC.yml b/Contribute/content/TOC.yml index 5b5d1266..0da618e5 100644 --- a/Contribute/content/TOC.yml +++ b/Contribute/content/TOC.yml @@ -102,7 +102,7 @@ - name: Pull request review process href: dotnet/dotnet-pr-review.md - name: Code analysis docs - href: dotnet/dotnet-contribute-code-analysis.md + href: dotnet/code-analysis-rules.md - name: Patterns and Practices (AAC, WAF, CAF) href: architecture-center/aac-contribute.md - name: PowerShell-Docs diff --git a/Contribute/content/dotnet/dotnet-contribute-code-analysis.md b/Contribute/content/dotnet/code-analysis-rules.md similarity index 88% rename from Contribute/content/dotnet/dotnet-contribute-code-analysis.md rename to Contribute/content/dotnet/code-analysis-rules.md index 59422448..f6896ca8 100644 --- a/Contribute/content/dotnet/dotnet-contribute-code-analysis.md +++ b/Contribute/content/dotnet/code-analysis-rules.md @@ -1,29 +1,29 @@ --- -title: Contribute docs for .NET code analysis rules to the .NET docs repository +title: Contribute docs for .NET code analysis rules description: This article describes the process for contributing to the articles and code samples for .NET code analysis rules in the .NET docs repository. author: mavasani -ms.author: mavasani +ms.author: gewarren ms.topic: contributor-guide ms.service: learn ms.custom: external-contributor-guide -ms.date: 06/17/2025 +ms.date: 03/17/2026 --- -# Contribute docs for .NET code analysis rules to the .NET docs repository +# Contribute docs for .NET code analysis rules -.NET compiler platform (Roslyn) analyzers inspect your C# or Visual Basic code for code quality and code style issues. Starting in .NET 5.0, these analyzers are [included with the .NET SDK](/dotnet/fundamentals/code-analysis/overview). +.NET compiler platform (Roslyn) analyzers inspect your C# or Visual Basic code for code quality and code style issues. These analyzers are [included with the .NET SDK](/dotnet/fundamentals/code-analysis/overview). - [Code quality analysis ("CAxxxx" rules)](/dotnet/fundamentals/code-analysis/overview#code-quality-analysis): - - Implemented [here](https://github.com/dotnet/roslyn-analyzers/tree/main/src/NetAnalyzers) in `dotnet/roslyn-analyzers` repo. + - Implemented in the [dotnet/sdk](https://github.com/dotnet/sdk/tree/main/src/Microsoft.CodeAnalysis.NetAnalyzers) repo (previously implemented in `dotnet/roslyn-analyzers` repo). - Documented [here](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules) in the `dotnet/docs` repo. See [Contribute docs for 'CAxxxx' rules](#contribute-docs-for-caxxxx-rules). - [Code style analysis ("IDExxxx" rules)](/dotnet/fundamentals/code-analysis/overview#code-style-analysis): - - Implemented [here](https://github.com/dotnet/roslyn/tree/main/src/Analyzers) in `dotnet/roslyn` repo. + - Implemented in the [dotnet/roslyn](https://github.com/dotnet/roslyn/tree/main/src/Analyzers) repo. - Documented [here](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/style-rules) in the `dotnet/docs` repo. See [Contribute docs for 'IDExxxx' rules](#contribute-docs-for-idexxxx-rules). ## Contribute docs for 'CAxxxx' rules Please follow the following steps to contribute documentation for code quality analysis rules to the [dotnet/docs](https://github.com/dotnet/docs) repo: -1. Determine `Rule ID` and `Category`: Ensure that you know the 'CAxxxx' rule ID and category for the rule to be documented. This means either your CA analyzer has been merged into [dotnet/roslyn-analyzers](https://github.com/dotnet/roslyn-analyzers) repo or you have an open PR with an approved ID and category that has been assigned to the rule. +1. Determine `Rule ID` and `Category`: Ensure that you know the 'CAxxxx' rule ID and category for the rule to be documented. This means either your CA analyzer has been merged into the [dotnet/sdk](https://github.com/dotnet/sdk) repo or you have an open PR with an approved ID and category that has been assigned to the rule. 2. Add rule doc: 1. Clone an existing CA rule file under [root](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules) folder, say `ca1000.md`, and rename it. 2. Update the content of the file appropriately. diff --git a/Contribute/index.yml b/Contribute/index.yml index 9ccd5fd5..d0597fdb 100644 --- a/Contribute/index.yml +++ b/Contribute/index.yml @@ -1,8 +1,7 @@ ### YamlMime:Marketing -### YamlMime:Marketing title: 'Experts Hub' metadata: - title: 'Experts Hub: Share what you know. Shape what’s next.' + title: "Experts Hub: Share what you know. Shape what's next." description: 'Share your knowledge with the world as a Microsoft expert!' sections: # hero with background image @@ -16,7 +15,7 @@ sections: src: media/experts-hub-long-format-400.png # top navigation links - componentType: navigation - size: large + size: large alignment: center blocks: - componentType: icon-link @@ -39,7 +38,7 @@ sections: questions: - question: Overview of this section answer: | - This section highlights high‑interest topics your audience is already searching for and talking about. Think of these as prime opportunities to create content that stands out and attracts learners who are actively looking for guidance. + This section highlights high-interest topics your audience is already searching for and talking about. Think of these as prime opportunities to create content that stands out and attracts learners who are actively looking for guidance. If a topic aligns with your expertise, jump in and turn it into content that showcases your voice and point of view. You might: @@ -53,7 +52,6 @@ sections: answer: | Grow your reputation on Microsoft Q&A by providing expert insights, clarification, and solutions on these trending topics: - - There's interest in understanding the differences between [Developer Command Prompt and Developer PowerShell in Visual Studio](https://learn.microsoft.com/answers/questions/5722678/what-are-the-different-between-developer-command-p). - Help Azure users [understand error codes](https://learn.microsoft.com/answers/questions/5562339/error-code-5000225-message-this-tenant-has-been-bl) related to managing [tenant lifecycles in Microsoft Entra](https://learn.microsoft.com/entra/fundamentals/inaccessible-tenant). - Learners want to understand how to use agents created from templates in Copilot Studio, such as the [Customer Insight template agent](https://learn.microsoft.com/answers/questions/5527396/an-agent-created-through-co-pilot-studio-is-not-ab). - question: 'Updates and tools for AI builders in Microsoft Foundry' @@ -67,7 +65,7 @@ sections: - Developer audiences are interested in building and remotely hosting MCP servers. [This episode](https://learn.microsoft.com/shows/azure-friday/host-remote-mcp-servers-on-azure-functions), led by Scott Hanselman and Lily Ma, demonstrates how to remotely host MCP servers on Azure Functions with official MCP SDKs. - Explore a [deep dive into the AKS MCP Server & Agentic CLI](https://www.youtube.com/watch?v=tEPfxO1FEMk) in January's AKS community call. - As more audiences build AI agents, they're looking to improve cost efficiency on Azure. [This learning path on maximizing AI agent ROI](https://learn.microsoft.com/training/paths/maximize-cost-efficiency-ai-agents/) offers strategies for cost-conscious decisions, ROI forecasting, and scalable architectures to optimize investments on Azure. - - question: AI for all levels of .NET developers + - question: AI for all levels of .NET developers answer: | Help .NET developers across multiple skill levels understand the foundations and opportunities for leveraging AI in their applications. - [Hands-on course](https://github.com/microsoft/Generative-AI-for-beginners-dotnet) and [accompanying video series](https://www.youtube.com/playlist?list=PLdo4fOcmZ0oUkPkWy9EtmBvFAjfp4ZHnx) on Generative AI fundamentals with .NET. @@ -82,7 +80,7 @@ sections: alt: A GitHub Copilot chat interaction with the Microsoft Learn MCP Server componentType: image - title: Content creation resources for the Microsoft Learn MCP Server - summary: A set of ready-to-use assets to help you accurately present, demo, and share the Microsoft Learn MCP Server with your audience. + summary: A set of ready-to-use assets to help you accurately present, demo, and share the Microsoft Learn MCP Server with your audience. componentType: text links: - componentType: link @@ -184,7 +182,7 @@ sections: title: Impactful opportunities happening now blocks: - componentType: summary-card - title: Contribute to awesome-azd + title: Contribute to awesome-azd summary: Share templates for using the Azure Developer CLI (azd) by contributing to the awesome-azd collection. url: https://github.com/azure/awesome-azd - componentType: summary-card @@ -193,7 +191,7 @@ sections: url: https://github.com/github/awesome-copilot - componentType: summary-card title: Join the Azure AI Foundry Discord community - summary: Join the Azure AI Foundry community to share your knowledge and connect with other AI experts and learners. + summary: Join the Azure AI Foundry community to share your knowledge and connect with other AI experts and learners. url: https://discord.com/invite/microsoftfoundry - componentType: summary-card title: Agent Creators @@ -260,7 +258,7 @@ sections: title: Connect with us links: - componentType: social-link - url: https://twitter.com/MicrosoftLearn + url: https://twitter.com/MicrosoftLearn destination: twitter - componentType: social-link url: https://www.linkedin.com/showcase/microsoftlearn/ @@ -269,5 +267,5 @@ sections: url: https://www.tiktok.com/@microsoftlearn destination: website - componentType: social-link - url: https://aka.ms/MicrosoftLearnNewsletter + url: https://aka.ms/MicrosoftLearnNewsletter destination: website