Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
brianlic-msft committed Feb 17, 2017
1 parent 495a165 commit 8ea78f5
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
78 changes: 78 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,78 @@
# Contributing to Windows IT professional documentation

Thank you for your interest in the Windows IT professional documentation! We appreciate your feedback, edits, and additions to our docs.
This page covers the basic steps for contributing to our technical documentation.

## Sign a CLA

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.

## Editing topics

We've tried to make editing an existing, public file as simple as possible.

>**Note**<br>
>At this time, only the English (en-us) content is available for editing.
**To edit a topic**

1. Go to the page on TechNet that you want to update, and then click **Contribute**.

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.

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/)

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


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.

The **Comparing changes** screen appears to see what the changes are between your fork 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.

If there are no problems, you’ll see the message, **Able to merge**.

8. Click **Create pull request**.

9. Enter a title and description to give the approver the appropriate context about what’s in the request.

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.

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:

- [Windows 10 and Windows Server 2016 PowerShell module reference](https://technet.microsoft.com/itpro/powershell/windows)
- [MDOP PowerShell module reference](https://technet.microsoft.com/itpro/powershell/mdop)

## Making more substantial changes

To make substantial changes to an existing article, add or change images, or contribute a new article, you will need to create a local clone of the content.
For info about creating a fork or clone, see the GitHub help topic, [Fork a Repo](https://help.github.com/articles/fork-a-repo/).

Fork the official repo into your personal GitHub account, and then clone the fork down to your local device. Work locally, then push your changes back into your fork. Then open a pull request back to the master branch of the official repo.

## Using issues to provide feedback on documentation

If you just want to provide feedback rather than directly modifying actual documentation pages, you can create an issue in the repository.

At the top of a topic page you'll see an **Issues** tab. Click the tab and then click the **New issue** button.

Be sure to include the topic title and the URL for the page you're submitting the issue for, if that page is different from the page you launched the **New issue** dialog from.

## Resources

You can use your favorite text editor to edit Markdown. We recommend [Visual Studio Code](https://code.visualstudio.com/), a free lightweight open source editor from Microsoft.

You can learn the basics of Markdown in just a few minutes. To get started, check out [Mastering Markdown](https://guides.github.com/features/mastering-markdown/).

17 changes: 17 additions & 0 deletions README.md
@@ -0,0 +1,17 @@
# Windows IT professional documentation

Welcome! This repository houses the Windows 10, Windows Server 2016, and MDOP PowerShell module docs that are written for IT professionals.

Edits to this content are published in the following places:

- [Windows 10 and Windows Server 2016](https://technet.microsoft.com/itpro/powershell/windows)
- [Microsoft Desktop Optimization Pack](https://technet.microsoft.com/itpro/powershell/mdop)

## Contributing

We actively merge contributions into this repository via [pull request](https://help.github.com/articles/using-pull-requests/) into the *master* branch.
If you are not a Microsoft employee, before you submit a pull request you must [sign a Contribution License Agreement](https://cla.microsoft.com/) to ensure that the community is free to use your submissions.
For more information on contributing, read our [contributions guide](CONTRIBUTING.md).


This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
7 changes: 7 additions & 0 deletions license.md
@@ -0,0 +1,7 @@
Copyright (c) Microsoft Corporation. Distributed under the following terms:

1. Microsoft and any contributors to this project each grants you a license, under its respective copyrights, to the documentation under the [Creative Commons Attribution 3.0 United States License](http://creativecommons.org/licenses/by/3.0/us/legalcode). In addition, with respect to any sample code contained in the documentation, Microsoft and any such contributors grants you an additional license, under its respective intellectual property rights, to use the code to develop or design your software for Microsoft Windows.

2. Microsoft, Windows, and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. This license does not grant you rights to use any names, logos, or trademarks. For Microsoft’s general trademark guidelines, go to [https://go.microsoft.com/fwlink/?LinkID=254653](https://go.microsoft.com/fwlink/?LinkID=254653).

3. Microsoft and any contributors reserves all others rights, whether under copyrights, patents, or trademarks, or by implication, estoppel or otherwise.

0 comments on commit 8ea78f5

Please sign in to comment.