deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-14 06:17:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'master' of https://cpubwin.visualstudio.com/_git/it-client into minusevents

Browse Source
This commit is contained in:
jaimeo 2017-10-13 14:03:08 -07:00
commit 8a32cfa795
1 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
windows/whats-new/contribute-to-a-topic.md
View File

@ -1,73 +1,79 @@
---
title: Edit an existing topic using the Edit link
description: Instructions about how to edit an existing topic by using the Edit link on TechNet.
description: Instructions about how to edit an existing topic by using the Edit link on docs.microsoft.com.
keywords: contribute, edit a topic
ms.prod: w10
ms.mktglfcycl: explore
ms.sitesec: library
ms.date: 10/09/2017
---
# Editing existing Windows IT professional documentation
You can now make suggestions and update existing, public content with a GitHub account and a simple click of a link.
You can make suggestions and update existing, public content with just a GitHub account and a simple click of a link. You can use GitHub pull requests to edit the technical articles in the Windows IT libraries and then ask us to "pull" your changes into the published articles.
>[!NOTE]
>At this time, only the English (en-us) content is available for editing.
>At this time, you can only edit the English (en-us) content.
Across the docs.microsoft.com site, if you see **Edit** in the right-hand corner of an article, you can suggest changes to it. You can specifically edit articles in the following libraries:
- [Windows 10](https://docs.microsoft.com/windows/windows-10)
- [Windows Server](/windows-server/)
- [Microsoft Edge](https://docs.microsoft.com/microsoft-edge/deploy)
- [Surface](https://docs.microsoft.com/surface)
- [Surface Hub](https://docs.microsoft.com/surface-hub)
- [HoloLens](https://docs.microsoft.com/hololens)
- [Microsoft Store](https://docs.microsoft.com/microsoft-store)
- [Windows 10 for Education](https://docs.microsoft.com/education/windows)
- [Windows 10 for SMB](https://docs.microsoft.com/windows/smb)
- [Internet Explorer 11](https://docs.microsoft.com/internet-explorer)
- [Microsoft Desktop Optimization Pack](https://docs.microsoft.com/microsoft-desktop-optimization-pack)
**To edit a topic**
1. All contributors who are ***not*** a Microsoft employee must [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) before updating or adding to any Microsoft repositories.
If you've previously contributed to topics in the Microsoft repositories, congratulations! You've already completed this step.
2. Go to the page on TechNet that you want to update, and then click **Edit**.
1. Go to the article that you want to update, and then click **Edit**.
![GitHub Web, showing the Edit link](images/contribute-link.png)
3. Log into (or sign up for) a GitHub account.
2. Sign into (or sign up for) a GitHub account.
You must have a GitHub account to get to the page that lets you edit a topic.
4. Click the **Pencil** icon (in the red box) to edit the content.
3. Click the **Pencil** icon (in the red box) to edit the content.
![GitHub Web, showing the Pencil icon in the red box](images/pencil-icon.png)
5. Using Markdown language, make your changes to the topic. For info about how to edit content using Markdown, see:
4. Using Markdown language, make your changes to the topic. For info about how to edit content using Markdown, see:
- **If you're linked to the Microsoft organization in GitHub:** [Windows authoring guide](https://aka.ms/WindowsAuthoring)
- **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
6. Make your suggested change, and then click **Preview Changes** to make sure it looks correct.
5. Make your suggested change, and then click **Preview Changes** to make sure it looks correct.
![GitHub Web, showing the Preview Changes tab](images/preview-changes.png)
7. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account.
6. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change**.
![GitHub Web, showing the Propose file change button](images/propose-file-change.png)
The **Comparing changes** screen appears to see what the changes are between your fork and the original content.
The **Comparing changes** screen shows the changes between your version of the article and the original content.
8. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in.
7. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. (Occasionally there are merge conflicts, where you've edited the file one way, while someone else edited the same lines in the same file in a different way. Before you can propose your changes, you need to fix those conflicts.)
If there are no problems, you’ll see the message, **Able to merge**.
![GitHub Web, showing the Comparing changes screen](images/compare-changes.png)
9. Click **Create pull request**.
8. Click **Create pull request**.
10. Enter a title and description to give the approver the appropriate context about what’s in the request.
9. Enter a title and description to let us know what’s in the request.
11. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people.
10. Scroll to the bottom of the page, and make sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people.
12. Click **Create pull request** again to actually submit the pull request.
11. Click **Create pull request** again to actually submit your edits.
The pull request is sent to the writer of the topic and your edits are reviewed. If your request is accepted, updates are published to one of the following places:
12. If you aren't a Microsoft employee, you need to [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) before updating or adding to any Microsoft repositories. A bot running in GitHub checks whether you've signed the CLA - if not, you'll be prompted, in the pull request, to sign it.
- [Windows 10](https://docs.microsoft.com/windows/windows-10)
- [Microsoft Edge](https://docs.microsoft.com/microsoft-edge/deploy)
- [Surface](https://docs.microsoft.com/surface)
- [Surface Hub](https://docs.microsoft.com/surface-hub)
- [HoloLens](https://docs.microsoft.com/hololens)
- [Microsoft Store](https://docs.microsoft.com/microsoft-store)
- [Windows 10 for Education](https://docs.microsoft.com/education/windows)
- [Windows 10 for SMB](https://docs.microsoft.com/windows/smb)
- [Internet Explorer 11](https://docs.microsoft.com/internet-explorer)
- [Microsoft Desktop Optimization Pack](https://docs.microsoft.com/microsoft-desktop-optimization-pack)
If you've previously contributed to topics in the Microsoft repositories, congratulations! You've already completed this step.
Next, the pull request is sent to one of our writers to review your edits for technical and editorial accuracy. If we have any suggestions or questions, we'll add them to the pull request where we can discuss them with you. If we accept your edits, you'll see your changes the next time the article is published.