|
3 | 3 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
4 | 4 | For more information see the [Code of Conduct FAQ ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
5 | 5 |
|
6 | | -# Docs.microsoft.com GitHub repository |
| 6 | +# GitHub repository for Microsoft technical documentation |
7 | 7 |
|
8 | | -You've found one of the GitHub repositories that houses the source for content published to [https://docs.microsoft.com](https://docs.microsoft.com/.), home of all technical content for Microsoft's Cloud and Enterprise Division. |
| 8 | +You've found one of the GitHub repositories that houses the source for content published to [Microsoft Docs](https://docs.microsoft.com/), home of all technical content for Microsoft's Cloud and Enterprise Division. |
9 | 9 |
|
10 | 10 | ## Contribute to your documentation |
| 11 | + |
11 | 12 | We **want and encourage contributions** from our community (users, customers, partners, friends on other planets) and Microsoft employees to improve your documentation. Here are some tips: |
12 | 13 |
|
13 | | -* **Create a GitHub account**: Sign up is free at [GitHub.com](https://www.github.com). |
| 14 | +* **Create a GitHub account**: Sign up for free at [GitHub](https://www.github.com). |
| 15 | + |
| 16 | +* **Use your browser**: There are two options: |
14 | 17 |
|
15 | | -* **Use your browser**: There are two options: |
| 18 | + **Option 1: Edit directly from Microsoft Docs** |
16 | 19 |
|
17 | | - **Option 1: Edit directly from docs.microsoft.com** |
18 | | - 1. Go to the topic, such as [https://docs.microsoft.com/mem/intune/protect/troubleshoot-policies-in-microsoft-intune](mem/intune/protect/troubleshoot-policies-in-microsoft-intune.md). |
| 20 | + 1. Browse to the [InTune](/mem/intune) article you want to edit. |
19 | 21 | 2. Select **Edit** (top right). This shows the markdown file in the GitHub repository. |
20 | | - 3. Select the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. |
21 | | - 4. Make your changes, and then **commit** your changes. |
| 22 | + 3. Select the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. |
| 23 | + 4. Make your changes, and then **commit** your changes. |
22 | 24 | 5. Create the pull request. |
23 | | - |
24 | | - **Option 2: Find the article in this repository, and update** |
25 | | - 1. Most topics are in `https://github.com/MicrosoftDocs/memdocs/tree/master/memdocs/intune`. In this folder, search for the topic name, such as `troubleshoot-policies-in-microsoft-intune`. |
26 | | - 2. Select the link, and click the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. |
27 | | - 3. Make your changes, and then **commit** your changes. |
28 | | - 4. Create the pull request. |
| 25 | + |
| 26 | + **Option 2: Find the article in this repository, and update** |
| 27 | + |
| 28 | + 1. Most topics are in `https://github.com/MicrosoftDocs/memdocs/tree/master/memdocs/intune`. In this folder, search for the topic name, such as `troubleshoot-policies-in-microsoft-intune`. |
| 29 | + 2. Select the link, and click the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. |
| 30 | + 3. Make your changes, and then **commit** your changes. |
| 31 | + 4. Create the pull request. |
29 | 32 |
|
30 | 33 | When you make an update, you may be prompted to sign a license agreement. This is a one-time task. So any future updates by your GitHub username won't need to sign again. |
31 | 34 |
|
32 | 35 | The value in the `author` metadata (at the top of every topic) lists the GitHub author. In the `troubleshoot-policies-in-microsoft-intune` example, you'll see `MandiOhlinger`. In your pull request, you can also mention (@*authorValue*) the author if you like. |
33 | 36 |
|
34 | | -* **MSFT Employees**: After you create a GitHub account, link it to your Microsoft email address. When your account is linked, you don't have to sign a license agreement to make an update. Steps: |
| 37 | +* **MSFT Employees**: After you create a GitHub account, link it to your Microsoft email address. When your account is linked, you don't have to sign a license agreement to make an update. Follow these steps: |
35 | 38 |
|
36 | | - 1. On a device with corpnet, go to [GitHub account setup](https://review.docs.microsoft.com/en-us/help/contribute/contribute-get-started-setup-github?branch=master). If you're not on corpnet, this link returns a 404. |
| 39 | + 1. On a device with access to corpnet, go to [GitHub account setup](https://review.docs.microsoft.com/en-us/help/contribute/contribute-get-started-setup-github?branch=master). If you're not on corpnet, this link returns a 404. |
37 | 40 |
|
38 | | - Creating a GitHub account, and linking to your Microsoft account is a one-time thing. When your account is linked, you don't have to sign a license agreement to make an update. |
| 41 | + Creating a GitHub account, and linking to your Microsoft account is a one-time thing. When your account is linked, you don't have to sign a license agreement to make an update. |
39 | 42 |
|
40 | | - 2. In your browser, go to the article, and select **Edit**. Switch to the private repo (IntuneDocs-pr): |
41 | | - **From**: https://github.com/MicrosoftDocs/memdocs/... |
42 | | - **To**: https://github.com/MicrosoftDocs/memdocs-pr/... |
| 43 | + 2. In your browser, go to the article, and select **Edit**. Switch to the private repo (`IntuneDocs-pr`): |
| 44 | + |
| 45 | + **From**: `https://github.com/MicrosoftDocs/memdocs/...` |
| 46 | + |
| 47 | + **To**: `https://github.com/MicrosoftDocs/memdocs-pr/...` |
43 | 48 |
|
44 | | - 3. Select the pencil icon, and make your changes. |
| 49 | + 3. Select the pencil icon, and make your changes. |
45 | 50 |
|
46 | 51 | ## Use markdown to format your topic |
47 | | -All the articles in this repository use GitHub-flavored markdown. Here's a list of resources to get started: |
| 52 | + |
| 53 | +All the articles in this repository use GitHub-flavored Markdown. Here's a list of resources to get started: |
48 | 54 |
|
49 | 55 | * [Markdown basics](https://help.github.com/articles/basic-writing-and-formatting-syntax/) |
50 | 56 | * [Printable markdown cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf) |
0 commit comments