Editing existing Windows IT professional documentation

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, 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:

To edit a topic

  1. Go to the article that you want to update, and then click Edit.

    GitHub Web, showing the Edit link

  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.

  3. Click the Pencil icon (in the red box) to edit the content.

    GitHub Web, showing the Pencil icon in the red box

  4. Using Markdown language, make your changes to the topic. For info about how to edit content using Markdown, see:

  5. Make your suggested change, and then click Preview Changes to make sure it looks correct.

    GitHub Web, showing the Preview Changes tab

  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

    The Comparing changes screen shows the changes between your version of the article and the original content.

  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

  8. Click Create pull request.

  9. Enter a title and description to let us know what’s in the request.

  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.

  11. Click Create pull request again to actually submit your edits.

  12. If you aren't a Microsoft employee, you need to sign a Microsoft Contribution Licensing Agreement (CLA) 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.

    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.