Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

publish 6/11 #1015

Merged
merged 11 commits into from
Jun 11, 2024
30 changes: 11 additions & 19 deletions Contribute/content/architecture-center/aac-contribute.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,26 @@
---
title: Contribute to Patterns and Practices content
description: This article describes how to contribute to Patterns and Practices repositories.
title: Contribute to Azure Patterns and Practices content
description: This article describes how to contribute to Azure Patterns and Practices repositories.
ms.topic: contributor-guide
ms.service: learn
ms.custom: external-contributor-guide
author: martinekuan
ms.author: martinek
ms.date: 02/01/2024
author: lnyswonger
ms.author: lnyswonger
ms.date: 06/07/2024
---

# Patterns and Practices contributions
# Azure Patterns and Practices contributions

Patterns and Practices content helps customers design, build, and operate solutions on Azure. The content comprises three content portfolios listed below. Contributions are encouraged through GitHub pull requests and issues.
Azure Patterns and Practices content helps customers design, build, and operate solutions on Azure. The content comprises three content portfolios listed below. Contributions are encouraged through GitHub pull requests.

| Portfolio | Summary | Repository |
|-----------|---------|------------|
| Azure Architecture Center | Guidance for architecting solutions on Azure using established patterns and practices, incorporating the five pillars of architectural excellence. Use the technology choices and guides to determine the services that are right for your solution or industry. | [https://github.com/microsoftdocs/architecture-center](https://github.com/microsoftdocs/architecture-center) |
| Azure Well-Architected Framework | A set of guiding tenets to improve the quality of a workload. The framework consists of five pillars of architectural excellence to help produce a high-quality, stable, and efficient cloud architecture: reliability, security, cost optimization, operational excellence, and performance efficiency. | [https://github.com/microsoftdocs/well-architected](https://github.com/microsoftdocs/well-architected) |
| Cloud Adoption Framework for Azure | A full lifecycle framework that enables cloud architects, IT professionals, and business decision-makers to achieve their cloud-adoption goals. Best practices, documentation, and tools help you create and implement business and technology strategies for the cloud. | [https://github.com/microsoftdocs/cloud-adoption-framework](https://github.com/microsoftdocs/cloud-adoption-framework) |
| Azure Architecture Center | Guidance for architecting solutions on Azure using established patterns and practices, incorporating the five pillars of architectural excellence. Use the technology choices and guides to determine the services that are right for your workload's requirements. | [https://github.com/MicrosoftDocs/architecture-center](https://github.com/MicrosoftDocs/architecture-center) |
| Azure Well-Architected Framework | A set of guiding tenets to improve the quality of a workload. The framework consists of five pillars of architectural excellence to help produce a high-quality, stable, and efficient cloud architecture: reliability, security, cost optimization, operational excellence, and performance efficiency. | [https://github.com/MicrosoftDocs/well-architected](https://github.com/MicrosoftDocs/well-architected) |
| Cloud Adoption Framework for Azure | A full lifecycle framework that enables cloud architects, IT professionals, and business decision-makers to achieve their cloud-adoption goals. Best practices, documentation, and tools help you create and implement business and technology strategies for the cloud. | [https://github.com/MicrosoftDocs/cloud-adoption-framework](https://github.com/MicrosoftDocs/cloud-adoption-framework) |

## Propose changes to an article

You can propose small changes to content if you want to correct a typo or error, add a link, or add more details. Ensure that your contribution is technically accurate and provides helpful or valuable information in the context of the article. To get started, select the "Edit this document" pencil icon in the upper-right corner of the page you'd like to contribute to. See [Edit Microsoft Learn documentation](../how-to-write-quick-edits.md) for more details.

## Submit a content suggestion

If you'd like to propose new content or substantial changes to content, use the links below to file a GitHub issue in the appropriate repository:

[Azure Architecture Center proposal](https://github.com/MicrosoftDocs/architecture-center/issues/new?title=Content%20suggestion&body=Provide%20a%20detailed%20description%20of%20your%20proposal,%20including%20links%20to%20related%20or%20impacted%20articles,%20and%20any%20relevant%20attachments:)

[Azure Well-Architected Framework proposal](https://github.com/MicrosoftDocs/well-architected/issues/new?title=Content%20suggestion&body=Provide%20a%20detailed%20description%20of%20your%20proposal,%20including%20links%20to%20related%20or%20impacted%20articles,%20and%20any%20relevant%20attachments:)

[Cloud Adoption Framework for Azure proposal](https://github.com/MicrosoftDocs/cloud-adoption-framework/issues/new?title=Content%20suggestion&body=Provide%20a%20detailed%20description%20of%20your%20proposal,%20including%20links%20to%20related%20or%20impacted%20articles,%20and%20any%20relevant%20attachments:)
If you can't directly propose changes through GitHub, you can also use the [feedback experience](../provide-feedback.md) at the bottom of the article you'd like to see improved. Please leave a detailed description of the change you'd like to see and why.
4 changes: 2 additions & 2 deletions Contribute/content/dotnet/dotnet-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Following these guidelines will ensure a better experience for you and for us.

Choose an existing issue and address it. You can look at our [open issues](https://github.com/dotnet/docs/issues) list and volunteer to work on the ones you're interested in:

- Filter by the [good-first-issue](https://github.com/dotnet/docs/labels/good-first-issue) label for, well, good first issues.
- Filter by the [up-for-grabs](https://github.com/dotnet/docs/labels/up-for-grabs) label for issues appropriate for community contribution. These issues usually require minimal context.
- Filter by the [good first issue](https://github.com/dotnet/docs/labels/good%20first%20issue) label for, well, good first issues.
- Filter by the [help wanted](https://github.com/dotnet/docs/labels/help%20wanted) label for issues appropriate for community contribution. These issues usually require minimal context.
- Experienced contributors can tackle any issues of interest.

When you find an issue to work on, add a comment to ask if it's open.
Expand Down
8 changes: 4 additions & 4 deletions Contribute/content/how-to-write-quick-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ We use PRs for all changes, even for contributors who have write access. Most re

1. Navigate to the documentation you want to edit. _Some_ docs pages allow you to edit content directly in the browser. If so, you'll see an **Edit** pencil icon like the one shown below. Choosing the **Edit** pencil icon takes you to the source file on GitHub.

:::image type="content" source="media/how-to-write-quick-edits/edit-article.png" alt-text="Screenshot of an Azure documentation article showing the edit pencil icon.":::
:::image type="content" source="media/how-to-write-quick-edits/edit-article.png" alt-text="Screenshot of an Azure documentation article showing the **Edit** pencil icon.":::

If the **Edit** button isn't present, it means the content isn't open to public contributions. Some pages are generated (for example, from inline documentation in code) and must be edited in the project they belong to.
If the **Edit** pencil icon isn't present, it means the content isn't open to public contributions. Some pages are generated (for example, from inline documentation in code) and must be edited in the project they belong to.

1. Select the pencil icon at the top of the GitHub file page. If the pencil icon is unavailable (appears dimmed) or doesn't display, you need to log in to your GitHub account.
1. Select the **Edit** pencil icon at the top of the GitHub file page. If the **Edit** pencil icon is unavailable (appears dimmed) or doesn't display, you need to log in to your GitHub account.

:::image type="content" source="media/how-to-write-quick-edits/edit-icon.png" alt-text="Screenshot of the Azure article within GitHub,showing the edit pencil icon.":::
:::image type="content" source="media/how-to-write-quick-edits/edit-icon.png" alt-text="Screenshot of the Azure article within GitHub,showing the **Edit** pencil icon.":::

At the top of the article is the article's metadata. Metadata is applied to articles for reporting, discoverability via search, and driving aspects of the site experience. If you're making minor updates to a published article, you probably won't need to change the metadata.

Expand Down