Skip to content

Commit 814da63

Browse files
committed
template update
1 parent ad7bfad commit 814da63

File tree

13 files changed

+36
-223
lines changed

13 files changed

+36
-223
lines changed

markdown templates/markdown-template-for-support-articles-cause-resolution.md

-97
This file was deleted.

markdown templates/new-markdown-template-for-support-articles-cause-resolution.md markdown templates/markdown-template-for-support-articles-symptom-cause-resolution.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ _Select one of the following disclaimers depending on your scenario. If your art
5454
- _Add screenshots if possible._
5555
- _If there are multiple solutions, put them in the order of complexity and provide instructions on how to choose from among them._
5656

57-
| <em>Version 1: Your article is deployment model agnostic</em> | <em>Version 2: Steps for ARM and Classic are largely the same</em> | <em>Version 3: Steps for ARM and Classic are mostly different. <br />In this case, use the <a href="https://github.com/Azure/azure-content-pr/blob/master/contributor-guide/custom-markdown-extensions.md#simple-selectors">Simple Selector technique in Github</a> and check with Tyson Nevil to see if it is applicable.</em> |
57+
| <em>Version 1: Your article is deployment model agnostic</em> | <em>Version 2: Steps for ARM and Classic are largely the same</em> | <em>Version 3: Steps for ARM and Classic are mostly different. <br />In this case, use the <a href="https://github.com/Azure/azure-content-pr/blob/master/contributor-guide/custom-markdown-extensions.md#simple-selectors">Simple Selectors technique in Github</a>.</em> |
5858
|:------------------------------------------------------|:-----------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
59-
| <p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /><br /><br /><br /> | <p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol> | <img src="media/new-markdown-template-for-support-articles-cause-resolution/rm-classic.png" alt="ARM-Classic"><p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /> |
59+
| <p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /><br /><br /><br /><br /> | <p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol> | <img src="media/markdown-template-for-support-articles-symptom-cause-resolution/rm-classic.png" alt="ARM-Classic"><p><h3>Solution 1</h3><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>Solution 2</h3><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /> |
6060

6161
## Next steps
6262
_Include this section if there are 1 -3 concrete, highly relevant next steps the user should take. Delete if there are no next steps. This is not a place for a list of links. If you include links to next steps, make sure to include text to explain why the next steps are relevant/ important._
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<properties
2-
pageTitle="Page title that displays in the browser tab and search results"
3-
description="Article description that will be displayed on landing pages and in most search results"
2+
pageTitle="42 characters followed by | Microsoft Azure to equal 60 characters. This title is displayed in search engines which will cut you off at 60 characters. Use keywords but don’t waste space"
3+
description="Displayed in search engines under the title. You have more room here, use more keywords and a more descriptive explanation than the title"
44
services="service-name"
55
documentationCenter="dev-center-name"
66
authors="GitHub-alias-of-only-one-author"
77
manager="manager-alias"
88
editor=""
9-
tags="top-support-issue,comma-separates-additional-tags-if-required"/>
9+
tags="top-support-issue"/>
1010

1111
<tags
1212
ms.service="required"
@@ -17,74 +17,53 @@
1717
ms.date="mm/dd/yyyy"
1818
ms.author="Your MSFT alias or your full email address;semicolon separates two or more"/>
1919

20-
# This is the title that will be displayed on the web page and the article index on ACOM
20+
# Title (Maximum 120 characters, target the primary keyword)
2121

22-
To copy the markdown from this template, copy the article in your local repo, or click the Raw button in the GitHub UI and copy the markdown.
22+
_Use 2-3 secondary keywords in the description._
2323

24-
![Alt text; do not leave blank. Describe image.][1]
24+
_Select one of the following disclaimers depending on your scenario. If your article is deployment model agnostic, ignore this._
2525

26-
Intro paragraph: Lorem dolor amet, adipiscing elit. Phasellus interdum nulla risus, lacinia porta nisl imperdiet sed. Mauris dolor mauris, tempus sed lacinia nec, euismod non felis. Nunc semper porta ultrices. Maecenas neque nulla, condimentum vitae ipsum sit amet, dignissim aliquet nisi.
26+
[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-rm-include.md)] classic deployment model.
2727

28-
## Contact Azure Customer Support
28+
[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-classic-include.md)] Resource Manager model.
2929

30-
If you need more help at any point in this article, you can contact the Azure experts on [the MSDN Azure and the Stack Overflow forums](http://azure.microsoft.com/support/forums/).
30+
[AZURE.INCLUDE [learn-about-deployment-models](../../learn-about-deployment-models-both-include.md)]
3131

32-
Alternatively, you can also file an Azure support incident. Go to the [Azure Support site](http://azure.microsoft.com/support/options/) and click on **Get Support**. For information about using Azure Support, read the [Microsoft Azure Support FAQ](http://azure.microsoft.com/support/faq/).
32+
[Opening paragraph]
33+
- _Briefly describe the specific issue(s) that this article will help troubleshoot, and the common root cause(s)._
34+
- _The opening paragraph is a good place to use different keywords from those in the title, but make sure to not make it very wordy. The sentences should flow well and be easy to understand._
35+
- _Exceptions (optional) - List the relevant scenarios that are not covered in this article. For example, ” Linux/OSS scenarios aren't covered in this article”._
3336

34-
## First troubleshooting section
37+
These {errors}|{Issues} occur because {a very general reason}.
3538

36-
Aenean sit amet leo nec purus placerat fermentum ac gravida odio. Aenean tellus lectus, faucibus in rhoncus in, faucibus sed urna. volutpat mi id purus ultrices iaculis nec non neque. [Link text for link outside of azure.microsoft.com](http://weblogs.asp.net/scottgu). Nullam dictum dolor at aliquam pharetra. Vivamus ac hendrerit mauris [example link text for link to an article in a service folder](../articles/expressroute/expressroute-bandwidth-upgrade.md).
39+
_Here is an example of an opening paragraph._
3740

38-
I get 10 times more traffic from [Google] [gog] than from [Yahoo] [yah] or [MSN] [msn].
41+
_When you try to connect to Azure SQL Database, the common connection errors you encounter are:_
42+
- _The login failed for the user. The password change failed._
43+
- _Password validation failed._
44+
- _Failed to authorize access to the specified subscription._
3945

40-
> [AZURE.NOTE] Indented note text. The word 'note' will be added during publication. Ut eu pretium lacus. Nullam purus est, iaculis sed est vel, euismod vehicula odio. Curabitur lacinia, erat tristique iaculis rutrum, erat sem sodales nisi, eu condimentum turpis nisi a purus.
46+
_These errors occur because you don’t have permission to access the data source._
4147

42-
1. Aenean sit amet leo nec **Purus** placerat fermentum ac gravida odio.
48+
[AZURE.INCLUDE [support-disclaimer](../../includes/support-disclaimer.md)]
4349

44-
2. Aenean tellus lectus, faucius in **Rhoncus** in, faucibus sed urna. Suspendisse volutpat mi id purus ultrices iaculis nec non neque.
50+
## Troubleshooting guidance (optional)
51+
- _Use this section when the guidance applies across the board._
52+
- _Don’t go into details. Keep it high level to serve as a guidance._
4553

46-
![Alt text; do not leave blank. Collector car in racing red.][2]
54+
_Here is an example of a troubleshooting guidance._
4755

48-
3. Nullam dictum dolor at aliquam pharetra. Vivamus ac hendrerit mauris. Sed dolor dui, condimentum et varius a, vehicula at nisl.
56+
_In general, as long as the error does not indicate "the requested VM size is not supported", you can always retry at a later time, as enough resource may have been freed up in the cluster to accommodate your request. If the problem is the requested VM size is not supported, try a different VM size; otherwise, the only option is to remove the pinning constraint._
4957

50-
![Alt text; do not leave blank][3]
58+
## Troubleshooting steps
59+
_List the solutions in the order of usability and simplicity, meaning the simplest, the most effective and useful solution should go first._
5160

61+
_Select one of the versions that apply to your situation._
5262

53-
Suspendisse volutpat mi id purus ultrices iaculis nec non neque. Nullam dictum dolor at aliquam pharetra. Vivamus ac hendrerit mauris. Otrus informatus: [Link 1 to another azure.microsoft.com documentation topic](virtual-machines-windows-hero-tutorial.md)
63+
| <em>Version 1: Your article is deployment model agnostic</em> | <em>Version 2: Steps for ARM and Classic are largely the same</em> | <em>Version 3: Steps for ARM and Classic are mostly different. <br />In this case, use the <a href="https://github.com/Azure/azure-content-pr/blob/master/contributor-guide/custom-markdown-extensions.md#simple-selectors">Simple Selectors technique in Github</a>.</em> |
64+
|:------------------------------------------------------|:-----------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
65+
| <p><h3>[Issue 1] \| [Error 1]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h4>Solution 2</h4><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>[Issue 2] \| [Error 2]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h4>Solution 2</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /> | <p><h3>[Issue 1] \| [Error 1]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol><p><h4>Solution 2</h4><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol><p><h3>[Issue 2] \| [Error 2]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol><p><h4>Solution 2</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>If you use the classic deployment model, [do this].<br />If you use the ARM deployment model, [do this].</li><li>[Step 3]</li></ol> | <img src="media/markdown-template-for-support-articles-troubleshoot/rm-classic.png" alt="ARM-Classic"><p><h3>[Issue 1] \| [Error 1]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h4>Solution 2</h4><em>(the less simple or effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h3>[Issue 2] \| [Error 2]</h3><h4>Cause</h4>[Cause details]</p><p><h4>Solution 1</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><p><h4>Solution 2</h4><em>(the simplest and most effective)</em></p><ol><li>[Step 1]</li><li>[Step 2]</li></ol><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /> |
5466

55-
## Second troubleshooting section
5667

57-
Ut eu pretium lacus. Nullam purus est, iaculis sed est vel, euismod vehicula odio.
58-
59-
1. Maecenas sed condimentum nisi. Suspendisse potenti.
60-
61-
+ Fusce
62-
+ Malesuada
63-
+ Sem
64-
65-
2. Nullam in massa eu tellus tempus hendrerit.
66-
67-
![Alt text; do not leave blank. Example of a Channel 9 video.][4]
68-
69-
3. Quisque felis enim, fermentum ut aliquam nec, pellentesque pulvinar magna.
70-
71-
<!-- Add more such troubleshooting sections as needed -->
72-
73-
<!-- Add links to additional resources at the end -->
74-
## Additional resources
75-
76-
Optional introduction here:
77-
[Link 1 to another azure.microsoft.com documentation topic](storage-whatis-account.md).
78-
[Link 2 to another azure.microsoft.com documentation topic](dotnet-sdk.md).
79-
80-
<!-- The following sections will not appear in the content -->
81-
<!--Image references-->
82-
[1]: ./media/markdown-template-for-new-articles/octocats.png
83-
[2]: ./media/markdown-template-for-new-articles/pretty49.png
84-
[3]: ./media/markdown-template-for-new-articles/channel-9.png
85-
[4]: ./media/markdown-template-for-new-articles/copytemplate.png
86-
87-
<!--Reference style links - using these makes the source content way more readable than using inline links-->
88-
[gog]: http://google.com/
89-
[yah]: http://search.yahoo.com/
90-
[msn]: http://search.msn.com/
68+
## Next steps
69+
_Include this section if there are 1 -3 concrete, highly relevant next steps the user should take. Delete if there are no next steps. This is not a place for a list of links. If you include links to next steps, make sure to include text to explain why the next steps are relevant/ important._

0 commit comments

Comments
 (0)