From d821edab99622b71872ee1282c58bdc448f3a650 Mon Sep 17 00:00:00 2001 From: Brian Lich Date: Tue, 9 Aug 2016 13:57:18 -0700 Subject: [PATCH] enhanced the readme and contributing files --- CONTRIBUTING.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 22 +++++++++++++++---- education/index.md | 4 +++- 3 files changed, 74 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..b909c0a74e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# 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 file as simple as possible. + +- If you're already in the repo, just navigate to the file you want to make the edits to and click the **Edit** button. +- Alternatively, if you're viewing a TechNet page in your browser, click the **Contribute** button on the top right of the page. You will be redirected to the relevant source file in the repo, where you can click the **Edit** button. + +When you're done, submit a pull request back to the master branch of the official repository. + +After you create the pull request, a member of the writing team will review your changes. + +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) + +## 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/). + diff --git a/README.md b/README.md index f5b28b423b..503b25df69 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ -# win-cpub-itpro-docs -This repo hosts the WDG ITPro content that is published to TechNet. +# Windows IT professional documentation + +Welcome! This repository houses the docs that are written for IT professionals for the following products: + +- [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) + +## Contributing + +We actively merge contributions into this repository via [pull request](https://help.github.com/articles/using-pull-requests/) into the *master* branch. +If not 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. - -English Handoff Folder Structure Demo! diff --git a/education/index.md b/education/index.md index beccdc8994..f468605351 100644 --- a/education/index.md +++ b/education/index.md @@ -1 +1,3 @@ -# Index test file for Open Publishing \ No newline at end of file +--- +redirect_url: https://technet.microsoft.com/edu/windows/ +---