Merge pull request #10539 from aisgbnok/link-main-guide

Refresh Repository Contribution Guide
This commit is contained in:
Aaron Czechowski 2022-05-24 17:13:54 -07:00 committed by GitHub
commit cadb807d32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 37 additions and 57 deletions

View File

@ -2,10 +2,11 @@
Thank you for your interest in the Windows IT professional documentation! We appreciate your feedback, edits, and additions to our docs. 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. This page covers the basic steps for editing our technical documentation.
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 ## 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 or vendor 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! If you've already edited within Microsoft repositories in the past, congratulations!
You've already completed this step. You've already completed this step.
@ -13,93 +14,72 @@ You've already completed this step.
We've tried to make editing an existing, public file as simple as possible. We've tried to make editing an existing, public file as simple as possible.
>**Note**<br> > **Note**<br>
>At this time, only the English (en-us) content is available for editing. > At this time, only the English (en-us) content is available for editing. If you have suggestions for edits to localized content, file feedback on the article.
**To edit a topic** ### To edit a topic
1. Go to the page on docs.microsoft.com that you want to update, and then click **Edit**. 1. Go to the page on [docs.microsoft.com](https://docs.microsoft.com/) that you want to update.
![GitHub Web, showing the Edit link.](images/contribute-link.png) > **Note**<br>
> If you're a Microsoft employee or vendor, before you edit the article, append `review.` to the beginning of the URL. This action lets you use the private repository, **windows-docs-pr**. For more information, see the [internal contributor guide](https://review.docs.microsoft.com/help/get-started/edit-article-in-github?branch=main).
2. Log into (or sign up for) a GitHub account. 1. Then select the **Pencil** icon.
You must have a GitHub account to get to the page that lets you edit a topic. ![Microsoft Docs Web, showing the Edit This Document link.](images/contribute-link.png)
3. Click the **Pencil** icon (in the red box) to edit the content. If the pencil icon isn't present, the content might not be open to public contributions. Some pages are generated (for example, from inline documentation in code) and must be edited in the project they belong to. This isn't always the case and you might be able to find the documentation by searching the [Microsoft Docs Organization on GitHub](https://github.com/MicrosoftDocs).
![GitHub Web, showing the Pencil icon in the red box.](images/pencil-icon.png) > **TIP**<br>
> View the page source in your browser, and look for the following metadata: `original_content_git_url`. This path always points to the source markdown file for the article.
4. Using Markdown language, make your changes to the topic. For info about how to edit content using Markdown, see: 1. In GitHub, select the **Pencil** icon to edit the article. If the pencil icon is grayed out, you need to either sign in to your GitHub account or create a new account.
- **If you're linked to the Microsoft organization in GitHub:** [Windows authoring guide](https://aka.ms/WindowsAuthoring)
- **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) ![GitHub Web, showing the Pencil icon.](images/pencil-icon.png)
5. Make your suggested change, and then click **Preview Changes** to make sure it looks correct. 1. Using Markdown language, make your changes to the file. For info about how to edit content using Markdown, see the [Microsoft Docs Markdown reference](https://docs.microsoft.com/contribute/markdown-reference) and GitHub's [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) documentation.
![GitHub Web, showing the Preview Changes tab.](images/preview-changes.png) 1. Make your suggested change, and then select **Preview changes** to make sure it looks correct.
6. When youre 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 Preview changes tab.](images/preview-changes.png)
![GitHub Web, showing the Propose file change button.](images/propose-file-change.png) 1. 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. Briefly state _what_ you changed. Select **Propose changes** to commit your changes:
The **Comparing changes** screen appears to see what the changes are between your fork and the original content. ![GitHub Web, showing the Propose changes button.](images/propose-changes.png)
7. On the **Comparing changes** screen, youll see if there are any problems with the file youre checking in. 1. 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**.
If there are no problems, youll see the message, **Able to merge**.
![GitHub Web, showing the Comparing changes screen.](images/compare-changes.png) ![GitHub Web, showing the Comparing changes screen.](images/compare-changes.png)
8. Click **Create pull request**. Select **Create pull request**. Next, enter a title and description to give the approver the appropriate context about _why_ you're suggesting this change. Make sure that only your changed files are in this pull request; otherwise, you could overwrite changes from other people.
9. Enter a title and description to give the approver the appropriate context about whats in the request. 1. Select **Create pull request** again to actually submit the pull 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. 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 on some of the following topics:
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](https://docs.microsoft.com/windows/windows-10)
- [Microsoft Edge](https://docs.microsoft.com/microsoft-edge/deploy)
- [Surface](https://docs.microsoft.com/surface)
- [Surface Hub](https://docs.microsoft.com/surface-hub)
- [HoloLens](https://docs.microsoft.com/hololens)
- [Windows client documentation for IT Pros](https://docs.microsoft.com/windows/resources/)
- [Microsoft Store](https://docs.microsoft.com/microsoft-store) - [Microsoft Store](https://docs.microsoft.com/microsoft-store)
- [Windows 10 for Education](https://docs.microsoft.com/education/windows) - [Windows 10 for Education](https://docs.microsoft.com/education/windows)
- [Windows 10 for SMB](https://docs.microsoft.com/windows/smb) - [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 ## 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. To make substantial changes to an existing article, add or change images, or contribute a new article, you'll 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 ## 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. 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. At the top of an article, you'll see a feedback icon. Select the icon to go to the **Feedback** section at the bottom of the article. Then select **This page** to file feedback for the current article.
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. In the new issue form, enter a brief title. In the body of the form, describe the concern, but don't modify the **Document Details** section. You can use markdown in this form. When you're ready, select **Submit new issue**.
## Resources ## 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 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/).
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).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
images/propose-changes.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB