From 24d223228a26b7ef25ea7ffbde6f2a80fb79bb4d Mon Sep 17 00:00:00 2001 From: David Pine Date: Fri, 14 Oct 2022 10:27:42 -0500 Subject: [PATCH 1/3] Updates to our README --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 15d5fb4dc319d..489fda7beaf58 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # .NET Docs -![Markdownlint](https://github.com/dotnet/docs/workflows/Markdownlint/badge.svg) [![target supported version](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml) - This repository contains the conceptual documentation for .NET. The [.NET documentation site](https://learn.microsoft.com/dotnet) is built from multiple repositories in addition to this one: - [API reference](https://github.com/dotnet/dotnet-api-docs) - [.NET Compiler Platform SDK reference](https://github.com/dotnet/roslyn-api-docs) -Issues and tasks for all but the API reference repository are tracked here. We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. You can read more about our procedures for classifying and resolving issues in our [Issues policy](issues-policy.md) topic. +Issues and tasks for all but the API reference repository are tracked here. We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. You can read more about our procedures for classifying and resolving issues in our [Issues policy](issues-policy.md) topic. To create a new issue, [choose from any of the available templates](https://github.com/dotnet/docs/issues/new/choose). + +## :purple_heart: Contribute We welcome contributions to help us improve and complete the .NET docs. This is a very large repo, covering a large area. If this is your first visit, see our [labels and projects roadmap](styleguide/labels-projects.md) for help navigating the issues and projects in this repository. @@ -19,6 +19,23 @@ To contribute, see: If you're interested in helping migrate existing code that targets the .NET Framework from the [retired Code Gallery](https://learn.microsoft.com/teamblog/msdn-code-gallery-retired) site to .NET Core applications stored in our [samples repository](https://github.com/dotnet/samples) and downloadable from the [Samples Browser](https://learn.microsoft.com/samples/browse), see the [Code Gallery migration](https://github.com/dotnet/docs/projects/88) project. The code gallery samples were moved to the [Microsoft Archive](https://github.com/microsoftarchive?q=msdn-code-gallery) organization. +## :bookmark_tabs: Code of conduct + This project has adopted the code of conduct defined by the Contributor Covenant -to clarify expected behavior in our community. -For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). +to clarify expected behavior in our community. For more information, see the [.NET Foundation: Code of Conduct](https://dotnetfoundation.org/code-of-conduct). + +## :octocat: GitHub Action workflows + +| Workflow status | Description | +|--|--| +| [![Live branch protection](https://github.com/dotnet/docs/actions/workflows/live-protection.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/live-protection.yml) | Adds a comment to PRs that were not automated, but rather manually created that target the `live` branch. | +| [![Close stale issues](https://github.com/dotnet/docs/actions/workflows/stale.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/stale.yml) | Closes stale issues, that haven't been updated in 180 days. | +| [![`dependabot` auto-approve and auto-merge](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml) | Automatically approves and auto-merges PRs originating from the `dependabbot[bot]` when their status checks pass. | +| [![Generate what's new article](https://github.com/dotnet/docs/actions/workflows/whats-new.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/whats-new.yml) | Creates a PR to generate the "What's new" article on the first of every month. | +| [![Markdownlint](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml) | The current status for the entire repositories Markdown linter status. | +| [![MSDocs build verifier](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml) | Runs various Markdown verifications, beyond the linter, such as ensuring links and redirects are valid. | +| [![No response](https://github.com/dotnet/docs/actions/workflows/no-response.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/no-response.yml) | If an issue is labeled with `needs-more-info` and the op doesn't respond within 14 days, the issue is closed. | +| [![OPS status checker](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml) | Builds the site for the PR in context, and verifies the build reporting either, `success,` `warnings`, or `error`. | +| [![Snippets 5000](https://github.com/dotnet/docs/actions/workflows/build-validation.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/build-validation.yml) | Custom .NET build validation, smart enough to locate code impacted by the contextual PR, and build it using either MSBuild or `dotnet` CLI accordingly. | +| [![Target supported version](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml) | Runs monthly to sweep the repository, creating issues when discovering projects that target .NET versions that are out of support. | +| [![Update dependabot.yml](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml) | Automatically updates the `dependabot` configuration weekly, but only if required. | From 3874f4a7a74d0dbfce68d17a1f96b795c20ba555 Mon Sep 17 00:00:00 2001 From: David Pine Date: Fri, 14 Oct 2022 10:36:02 -0500 Subject: [PATCH 2/3] Corrections and clean up --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 489fda7beaf58..253562ae3b501 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,9 @@ We welcome contributions to help us improve and complete the .NET docs. This is To contribute, see: -- The [Contributing Guide](CONTRIBUTING.md) for instructions on procedures we use. -- Issues labeled [`up-for-grabs`](https://github.com/dotnet/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) for ideas. -- [#Hacktoberfest and Microsoft Docs](https://learn.microsoft.com/contribute/hacktoberfest) for details on our participation in the annual event. - -If you're interested in helping migrate existing code that targets the .NET Framework from the [retired Code Gallery](https://learn.microsoft.com/teamblog/msdn-code-gallery-retired) site to .NET Core applications stored in our [samples repository](https://github.com/dotnet/samples) and downloadable from the [Samples Browser](https://learn.microsoft.com/samples/browse), see the [Code Gallery migration](https://github.com/dotnet/docs/projects/88) project. The code gallery samples were moved to the [Microsoft Archive](https://github.com/microsoftarchive?q=msdn-code-gallery) organization. +- The [.NET Contributor Guide :ledger:](https://learn.microsoft.com/contribute/dotnet/dotnet-contribute) for instructions on procedures we use. +- Issues labeled [`help wanted` :label:](https://github.com/dotnet/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+) for ideas. +- [#Hacktoberfest and Microsoft Docs :jack_o_lantern:](https://learn.microsoft.com/contribute/hacktoberfest) for details on our participation in the annual event. ## :bookmark_tabs: Code of conduct From 22d0c0266d27128a6d695c2cf0e00d75fba79d8e Mon Sep 17 00:00:00 2001 From: David Pine Date: Fri, 14 Oct 2022 10:40:15 -0500 Subject: [PATCH 3/3] Minor clean up --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 253562ae3b501..03d6ec3d764ec 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,14 @@ to clarify expected behavior in our community. For more information, see the [.N ## :octocat: GitHub Action workflows -| Workflow status | Description | -|--|--| -| [![Live branch protection](https://github.com/dotnet/docs/actions/workflows/live-protection.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/live-protection.yml) | Adds a comment to PRs that were not automated, but rather manually created that target the `live` branch. | -| [![Close stale issues](https://github.com/dotnet/docs/actions/workflows/stale.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/stale.yml) | Closes stale issues, that haven't been updated in 180 days. | -| [![`dependabot` auto-approve and auto-merge](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml) | Automatically approves and auto-merges PRs originating from the `dependabbot[bot]` when their status checks pass. | -| [![Generate what's new article](https://github.com/dotnet/docs/actions/workflows/whats-new.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/whats-new.yml) | Creates a PR to generate the "What's new" article on the first of every month. | -| [![Markdownlint](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml) | The current status for the entire repositories Markdown linter status. | -| [![MSDocs build verifier](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml) | Runs various Markdown verifications, beyond the linter, such as ensuring links and redirects are valid. | -| [![No response](https://github.com/dotnet/docs/actions/workflows/no-response.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/no-response.yml) | If an issue is labeled with `needs-more-info` and the op doesn't respond within 14 days, the issue is closed. | -| [![OPS status checker](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml) | Builds the site for the PR in context, and verifies the build reporting either, `success,` `warnings`, or `error`. | -| [![Snippets 5000](https://github.com/dotnet/docs/actions/workflows/build-validation.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/build-validation.yml) | Custom .NET build validation, smart enough to locate code impacted by the contextual PR, and build it using either MSBuild or `dotnet` CLI accordingly. | -| [![Target supported version](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml) | Runs monthly to sweep the repository, creating issues when discovering projects that target .NET versions that are out of support. | -| [![Update dependabot.yml](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml) | Automatically updates the `dependabot` configuration weekly, but only if required. | +- [![Live branch protection](https://github.com/dotnet/docs/actions/workflows/live-protection.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/live-protection.yml): Adds a comment to PRs that were not automated, but rather manually created that target the `live` branch. +- [![Close stale issues](https://github.com/dotnet/docs/actions/workflows/stale.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/stale.yml): Closes stale issues that have not been updated in 180 days. +- [![`dependabot` auto-approve and auto-merge](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-approve-and-automerge.yml): Automatically approves and auto-merges PRs originating from the `dependabbot[bot]`. +- [![Generate what's new article](https://github.com/dotnet/docs/actions/workflows/whats-new.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/whats-new.yml): Creates a PR to generate the "What's new" article on the first of every month. +- [![Markdownlint](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/markdownlint.yml): The current status for the entire repositories Markdown linter status. +- [![MSDocs build verifier](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/docs-verifier.yml): Runs various Markdown verifications, beyond the linter, such as ensuring links and redirects are valid. +- [![No response](https://github.com/dotnet/docs/actions/workflows/no-response.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/no-response.yml): If an issue is labeled with `needs-more-info` and the op doesn't respond within 14 days, the issue is closed. +- [![OPS status checker](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/check-for-build-warnings.yml): Builds the site for the PR in context, and verifies the build reporting either, `success,` `warnings`, or `error`. +- [![Snippets 5000](https://github.com/dotnet/docs/actions/workflows/build-validation.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/build-validation.yml): Custom .NET build validation, locates code impacted by a PR, and builds. +- [![Target supported version](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/version-sweep.yml): Runs monthly, creating issues on projects that target .NET versions that are out of support. +- [![Update dependabot.yml](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml/badge.svg)](https://github.com/dotnet/docs/actions/workflows/dependabot-bot.yml): Automatically updates the `dependabot` configuration weekly, but only if required.