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

Improve formatting and accuracy

Browse Source
This commit is contained in:
Anthony Swierkosz 2022-05-15 14:24:09 -04:00
parent 022117f547
commit a6c5b09910
No known key found for this signature in database
GPG Key ID: FA653BCC2CE12624
1 changed files with 17 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
CONTRIBUTING.md
View File

@ -2,11 +2,11 @@
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 editing our technical documentation.
For a more up-to-date and general contribution guide, see the main [Microsoft Docs contributor guide overview](https://docs.microsoft.com/contribute/).
For a more up-to-date and complete contribution guide, see the main [Microsoft Docs contributor guide overview](https://docs.microsoft.com/contribute/).
## Sign a CLA
All contributors who are ***not*** a Microsoft employee must [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) before editing any Microsoft repositories.
All contributors who are ***not*** a Microsoft employee must [sign a Microsoft Contributor License Agreement (CLA)](https://cla.microsoft.com/) before editing any Microsoft repositories.
If you've already edited within Microsoft repositories in the past, congratulations!
You've already completed this step.
@ -29,63 +29,45 @@ We've tried to make editing an existing, public file as simple as possible.
![GitHub Web, showing the Pencil icon.](images/pencil-icon.png)
3. 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)
3. Using Markdown language, make your changes to the file. 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:** [Microsoft Docs Markdown reference](https://docs.microsoft.com/contribute/markdown-reference), [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
4. Make your suggested change, and then select **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, scroll to the bottom of the page, and then select **Propose changes** to create a fork in your personal GitHub account.
5. When you're finished editing, scroll to the bottom of the page. In the **Propose changes** area, enter a title and optionally a description for your changes. The title will be the first line of the commit message. Select **Propose changes** to commit your changes:
![GitHub Web, showing the Propose changes button.](images/propose-changes.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.
If there are no problems, you’ll see the message, **Able to merge**.
6. The **Comparing changes** screen appears to show what the changes are between your fork and the original content. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking. 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. Select **Create pull request**.
Select **Create pull request**. Next, enter a title and description to give the approver the appropriate context about what’s in the request. Make sure that only your changed files are in this pull request; otherwise, you could overwrite changes from other people.
8. Enter a title and description to give the approver the appropriate context about what’s in the request.
7. Click **Create pull request** again to actually submit the pull 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. 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://docs.microsoft.com/windows/windows-10)
- [Microsoft Edge](https://docs.microsoft.com/microsoft-edge/deploy)
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 their respective article. This repository contains articles in some of the following topics:
- [Windows client documentation for IT Pros](https://docs.microsoft.com/windows/)
- [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)
- [Internet Explorer 11](https://docs.microsoft.com/internet-explorer/)
- [Microsoft Desktop Optimization Pack](https://docs.microsoft.com/microsoft-desktop-optimization-pack)
## 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/).
For info about creating a fork or clone, see [Set up a local Git repository](https://docs.microsoft.com/contribute/get-started-setup-local). The GitHub docs topic, [Fork a Repo](https://docs.github.com/articles/fork-a-repo), is also insightful.
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.
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. Finally, open a pull request back to the main branch of the official repo.
## Using issues to provide feedback on documentation
@ -93,12 +75,10 @@ If you just want to provide feedback rather than directly modifying actual docum
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.
Be sure to include the topic title and the URL for the page you're submitting the issue for.
## 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/).
Microsoft Docs uses several custom Markdown extensions. To learn more, see the [Microsoft Docs Markdown reference](https://docs.microsoft.com/contribute/markdown-reference).
- You can use your favorite text editor to edit Markdown files. 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/).
- Microsoft Docs uses several custom Markdown extensions. To learn more, see the [Microsoft Docs Markdown reference](https://docs.microsoft.com/contribute/markdown-reference).