|
1 | | -# Contributing to UWP Conceptual Documentation |
| 1 | +# Contributing to this documentation |
2 | 2 |
|
3 | | -Thank you for your interest in the Universal Windows Platform (UWP) documentation! We appreciate your feedback, edits, and additions to our docs. |
4 | | - |
5 | | -## Writing content |
6 | | - |
7 | | -Our documentation is written in Markdown, a lightweight text style syntax. If you're not familiar with Markdown, you can [learn the basics on GitHub](https://guides.github.com/features/mastering-markdown/). When unsure, you can always copy the formatting style from other pages in our docs. |
8 | | - |
9 | | -## Public contributions |
10 | | - |
11 | | -If you are **not** a Microsoft employee, you can contribute through the [public content repository](https://github.com/MicrosoftDocs/windows-uwp). Public contributions are appropriate for changes and clarifications to existing pages. |
12 | | - |
13 | | -### Editing a file |
14 | | - |
15 | | -If you're already in the public content repository, start by navigating to the file you want to change. From there, select the pencil icon above the displayed content to begin editing. |
16 | | - |
17 | | -Alternately, if you're viewing a published article on [Microsoft Learn](https://learn.microsoft.com/), you can select the **Edit** button on the upper-right portion of the page. This will redirect you to the associated source file in the repository. |
18 | | - |
19 | | -When you begin editing, GitHub automatically forks the official repo into your personal GitHub account, where you can make your changes. When you're done, submit a pull request back to the **docs** branch. |
20 | | - |
21 | | -### Pull requests |
22 | | - |
23 | | -After you submit your pull request, it is evaluated against a content quality checklist to ensure it meets our basic standards. If it passes, it is assigned to a member of the UWP documentation team for further review. If it fails, you'll be told what changes to make. |
24 | | - |
25 | | -The assigned reviewer(s) may approve or reject the PR, or work with you to make further changes. |
| 3 | +Thank you for your interest in contributing to our documentation! We appreciate your feedback, edits, and additions to our docs. Please see the [Microsoft Learn documentation contributor guide](https://learn.microsoft.com/contribute/) for information on how to do quick edits, get a local contribution environment set up, review open pull requests, and create quality issues, along with some "Microsoft writing essentials", the Learn site authoring pack for VS Code, and info about Hacktoberfest. |
26 | 4 |
|
27 | 5 | ## Internal contributions |
28 | 6 |
|
29 | | -If you are a Microsoft employee, you can contribute through the [private content repository](https://github.com/microsoftdocs/windows-uwp-pr). You can find guidance on using this repo in the [Windows Authoring Guide](https://review.learn.microsoft.com/windows-authoring-guide/uwp/?branch=main). Documentation on upcoming features must be contributed via the private repository only. |
30 | | - |
31 | | -### Editing a file |
32 | | - |
33 | | -As in the public repository, you can make small changes to the private repository in your browser, without needing to create a local clone. You **must** ensure that you are contributing on the correct branch. For more information about creating your personal branch, see [the instructions in the Windows Authoring Guide](https://review.learn.microsoft.com/windows-authoring-guide/uwp/conceptual/branches?branch=main). |
34 | | - |
35 | | -### Making substantial changes |
36 | | - |
37 | | -To make more extensive changes to an existing article, add or change images, or contribute a new article, create a local clone of the private content repo. Fore more information, follow [the instructions in the Windows Authoring Guide](https://review.learn.microsoft.com/windows-authoring-guide/uwp/conceptual/). |
38 | | - |
39 | | -### Pull requests |
40 | | - |
41 | | -When creating a pull request in the internal repo, make sure you're merging your personal branch into the branch it was created from. |
42 | | - |
43 | | -After you submit your pull request, it is evaluated with [PR Merger](https://review.learn.microsoft.com/help/contribute/prmerger-overview?branch=main) to ensure it meets our basic standards. If it passes, you can comment `#sign-off` to pass it to member of the UWP documentation team for further review. If it fails, you'll be told what changes to make before you can sign off. |
44 | | - |
45 | | -The assigned reviewer(s) may approve or reject the PR, or work with you to make further changes. Reviewers will not merge the PR until you have approved it yourself. |
46 | | - |
47 | | -## Using issues to provide feedback on UWP Conceptual documentation |
48 | | - |
49 | | -If you want to provide feedback on the docs instead of making edits yourself, you can [create an issue in the public repo](https://github.com/MicrosoftDocs/windows-uwp/issues). Select the **Issues** tab and select the **New issue** button. Be sure to include the topic title and the URL for the page. Your issue will be assigned to members of the UWP documentation team for review. |
50 | | - |
51 | | -* For internal issues, use the [WDG Content Request Tool](http://sesuw2-iis02a/WSCPubRequest/WindowsContentRequestTool.aspx). |
| 7 | +If you are a Microsoft employee, please contribute through the [private content repository](https://github.com/microsoftdocs/windows-dev-docs-pr). |
0 commit comments