diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dad15934ad..ab58df92e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ You've already completed this step. ## Editing topics -We've tried to make editing an existing file as simple as possible. +We've tried to make editing an existing, public file as simple as possible. **To edit a topic** @@ -19,38 +19,42 @@ We've tried to make editing an existing file as simple as possible. ![GitHub Web, showing the Contribute link](images/contribute-link.png) -2. Click the **Pencil** icon (in the red box) to edit the content. +2. Log 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. + +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) -3. 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 Open Publishing Guide Home](http://aka.ms/windows-op-guide) - **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) -4. 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) -5. 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** to create a fork in your personal GitHub account. ![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. -6. 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. If there are no problems, you’ll see the message, **Able to merge**. ![GitHub Web, showing the Comparing changes screen](images/compare-changes.png) -7. Click **Create pull request**. +8. Click **Create pull request**. -8. 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 give the approver the appropriate context about what’s in the request. -9. 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, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people. -10. Click **Create pull request**. +11. Click **Create pull request** again to actually submit the pull request. 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: diff --git a/windows/whats-new/contribute-to-a-topic.md b/windows/whats-new/contribute-to-a-topic.md new file mode 100644 index 0000000000..3fb9fa0055 --- /dev/null +++ b/windows/whats-new/contribute-to-a-topic.md @@ -0,0 +1,68 @@ +--- +title: Edit an existing topic using the Contribute link +description: Instructions about how to edit an existing topic by using the Contribute link. +keywords: contribute, edit a topic +ms.prod: w10 +ms.mktglfcycl: explore +ms.sitesec: library +--- + +# Edit an existing topic using the Contribute link +You can now make suggestions and update existing, public content with a GitHub account and a simple click of a link. + +**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 contributing to any Microsoft repositories. +If you've already contributed to Microsoft repositories in the past, congratulations! +You've already completed this step. + +2. Go to the page on TechNet that you want to update, and then click **Contribute**. + + ![GitHub Web, showing the Contribute link](images/contribute-link.png) + +3. Log 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. + + ![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: + - **If you're linked to the Microsoft organization in GitHub:** [Windows Open Publishing Guide Home](http://aka.ms/windows-op-guide) + + - **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. + + ![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. + + ![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. + +8. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. + + 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**. + +10. Enter a title and description to give the approver the appropriate context about 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. + +12. Click **Create pull request** again to actually submit the pull request. + + 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: + + - [Windows 10](https://technet.microsoft.com/itpro/windows) + - [Internet Explorer 11](https://technet.microsoft.com/itpro/internet-explorer) + - [Microsoft Edge](https://technet.microsoft.com/itpro/microsoft-edge) + - [Surface](https://technet.microsoft.com/itpro/surface) + - [Surface Hub](https://technet.microsoft.com/itpro/surface-hub) + - [Windows 10 for Education](https://technet.microsoft.com/edu/windows) + - [Microsoft Desktop Optimization Pack](https://technet.microsoft.com/itpro/mdop) \ No newline at end of file diff --git a/windows/whats-new/images/compare-changes.png b/windows/whats-new/images/compare-changes.png new file mode 100644 index 0000000000..0d86db70f5 Binary files /dev/null and b/windows/whats-new/images/compare-changes.png differ diff --git a/windows/whats-new/images/contribute-link.png b/windows/whats-new/images/contribute-link.png new file mode 100644 index 0000000000..6b17e6dd56 Binary files /dev/null and b/windows/whats-new/images/contribute-link.png differ diff --git a/windows/whats-new/images/pencil-icon.png b/windows/whats-new/images/pencil-icon.png new file mode 100644 index 0000000000..82fe7852dd Binary files /dev/null and b/windows/whats-new/images/pencil-icon.png differ diff --git a/windows/whats-new/images/preview-changes.png b/windows/whats-new/images/preview-changes.png new file mode 100644 index 0000000000..f98b2c6443 Binary files /dev/null and b/windows/whats-new/images/preview-changes.png differ diff --git a/windows/whats-new/images/propose-file-change.png b/windows/whats-new/images/propose-file-change.png new file mode 100644 index 0000000000..aedbc07b16 Binary files /dev/null and b/windows/whats-new/images/propose-file-change.png differ diff --git a/windows/whats-new/index.md b/windows/whats-new/index.md index 5c04da963b..ff170bce3b 100644 --- a/windows/whats-new/index.md +++ b/windows/whats-new/index.md @@ -2,7 +2,7 @@ title: What's new in Windows 10 (Windows 10) description: Learn about new features in Windows 10 for IT professionals, such as Enterprise Data Protection, Microsoft Passport, Device Guard, and more. ms.assetid: F1867017-76A1-4761-A200-7450B96AEF44 -keywords: ["What's new in Windows 10", "Windows 10", "anniversary update"] +keywords: ["What's new in Windows 10", "Windows 10", "anniversary update", "contribute", "edit topic"] ms.prod: w10 author: TrudyHa localizationpriority: high @@ -19,8 +19,7 @@ Windows 10 provides IT professionals with advanced protection against modern sec - [What's new in Windows 10, versions 1507 and 1511](whats-new-windows-10-version-1507-and-1511.md) - -  +- [Edit an existing topic using the Contribute link](contribute-to-a-topic.md) ## Learn more