forked from MicrosoftDocs/memdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BULK UPDATE] DocuTune - Fix build validation issues: docs-link-absolute
- Loading branch information
1 parent
2ae62f8
commit 6be2a8a
Showing
9 changed files
with
87 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,48 +3,54 @@ | |
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 [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
# Docs.microsoft.com GitHub repository | ||
# GitHub repository for Microsoft technical documentation | ||
|
||
You've found one of the GitHub repositories that houses the source for content published to [https://docs.microsoft.com](https://docs.microsoft.com/.), home of all technical content for Microsoft's Cloud and Enterprise Division. | ||
You've found one of the GitHub repositories that houses the source for content published to [Microsoft Docs](https://docs.microsoft.com/), home of all technical content for Microsoft's Cloud and Enterprise Division. | ||
|
||
## Contribute to your documentation | ||
|
||
We **want and encourage contributions** from our community (users, customers, partners, friends on other planets) and Microsoft employees to improve your documentation. Here are some tips: | ||
|
||
* **Create a GitHub account**: Sign up is free at [GitHub.com](https://www.github.com). | ||
* **Create a GitHub account**: Sign up for free at [GitHub](https://www.github.com). | ||
|
||
* **Use your browser**: There are two options: | ||
|
||
* **Use your browser**: There are two options: | ||
**Option 1: Edit directly from Microsoft Docs** | ||
|
||
**Option 1: Edit directly from docs.microsoft.com** | ||
1. Go to the topic, such as [https://docs.microsoft.com/mem/intune/protect/troubleshoot-policies-in-microsoft-intune](mem/intune/protect/troubleshoot-policies-in-microsoft-intune.md). | ||
1. Browse to the [InTune](/mem/intune) article you want to edit. | ||
2. Select **Edit** (top right). This shows the markdown file in the GitHub repository. | ||
3. Select the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. | ||
4. Make your changes, and then **commit** your changes. | ||
3. Select the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. | ||
4. Make your changes, and then **commit** your changes. | ||
5. Create the pull request. | ||
|
||
**Option 2: Find the article in this repository, and update** | ||
1. Most topics are in `https://github.com/MicrosoftDocs/memdocs/tree/master/memdocs/intune`. In this folder, search for the topic name, such as `troubleshoot-policies-in-microsoft-intune`. | ||
2. Select the link, and click the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. | ||
3. Make your changes, and then **commit** your changes. | ||
4. Create the pull request. | ||
|
||
**Option 2: Find the article in this repository, and update** | ||
|
||
1. Most topics are in `https://github.com/MicrosoftDocs/memdocs/tree/master/memdocs/intune`. In this folder, search for the topic name, such as `troubleshoot-policies-in-microsoft-intune`. | ||
2. Select the link, and click the pencil icon. When you hover over the pencil icon, you'll see the **Edit this file** tooltip. | ||
3. Make your changes, and then **commit** your changes. | ||
4. Create the pull request. | ||
|
||
When you make an update, you may be prompted to sign a license agreement. This is a one-time task. So any future updates by your GitHub username won't need to sign again. | ||
|
||
The value in the `author` metadata (at the top of every topic) lists the GitHub author. In the `troubleshoot-policies-in-microsoft-intune` example, you'll see `MandiOhlinger`. In your pull request, you can also mention (@*authorValue*) the author if you like. | ||
|
||
* **MSFT Employees**: After you create a GitHub account, link it to your Microsoft email address. When your account is linked, you don't have to sign a license agreement to make an update. Steps: | ||
* **MSFT Employees**: After you create a GitHub account, link it to your Microsoft email address. When your account is linked, you don't have to sign a license agreement to make an update. Follow these steps: | ||
|
||
1. On a device with corpnet, go to [GitHub account setup](https://review.docs.microsoft.com/en-us/help/contribute/contribute-get-started-setup-github?branch=master). If you're not on corpnet, this link returns a 404. | ||
1. On a device with access to corpnet, go to [GitHub account setup](https://review.docs.microsoft.com/en-us/help/contribute/contribute-get-started-setup-github?branch=master). If you're not on corpnet, this link returns a 404. | ||
|
||
Creating a GitHub account, and linking to your Microsoft account is a one-time thing. When your account is linked, you don't have to sign a license agreement to make an update. | ||
Creating a GitHub account, and linking to your Microsoft account is a one-time thing. When your account is linked, you don't have to sign a license agreement to make an update. | ||
|
||
2. In your browser, go to the article, and select **Edit**. Switch to the private repo (IntuneDocs-pr): | ||
**From**: https://github.com/MicrosoftDocs/memdocs/... | ||
**To**: https://github.com/MicrosoftDocs/memdocs-pr/... | ||
2. In your browser, go to the article, and select **Edit**. Switch to the private repo (`IntuneDocs-pr`): | ||
|
||
**From**: `https://github.com/MicrosoftDocs/memdocs/...` | ||
|
||
**To**: `https://github.com/MicrosoftDocs/memdocs-pr/...` | ||
|
||
3. Select the pencil icon, and make your changes. | ||
3. Select the pencil icon, and make your changes. | ||
|
||
## Use markdown to format your topic | ||
All the articles in this repository use GitHub-flavored markdown. Here's a list of resources to get started: | ||
|
||
All the articles in this repository use GitHub-flavored Markdown. Here's a list of resources to get started: | ||
|
||
* [Markdown basics](https://help.github.com/articles/basic-writing-and-formatting-syntax/) | ||
* [Printable markdown cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.