Skip to content

Commit 42ed7b6

Browse files
committed
Update format
1 parent aa5130e commit 42ed7b6

File tree

2 files changed

+88
-42
lines changed

2 files changed

+88
-42
lines changed

docs/troubleshooting/troubleshooting.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

template.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: 'Known issues: Microsoft Desired State Configuration'
3+
description: "[Article description]."
4+
author: [your GitHub alias]
5+
ms.author: [your Microsoft alias or a team alias]
6+
ms.service: [the approved service name]
7+
ms.topic: troubleshooting-known-issue #Don't change.
8+
ms.date: [mm/dd/yyyy]
9+
10+
#customer intent: As a <role>, I want <what> so that <why>.
11+
12+
---
13+
14+
<!-- --------------------------------------
15+
16+
- Use this template with pattern instructions for:
17+
18+
Known Issues
19+
20+
- Before you sign off or merge:
21+
22+
Remove all comments except the customer intent.
23+
24+
-->
25+
26+
# Known issues: Microsoft Desired State Configuration
27+
28+
<!-- Required: Article headline - H1
29+
30+
Identify the product or service the article
31+
applies to.
32+
33+
-->
34+
35+
[Introduce and explain the purpose of the article.]
36+
37+
<!-- Required: Introductory paragraphs (no heading)
38+
39+
Write a brief introduction that can help the user
40+
determine whether the article is relevant for them
41+
and to describe the specific issue that the article
42+
covers.
43+
44+
-->
45+
46+
## [Issue]
47+
48+
<!-- Required: Issue - H2
49+
50+
Each known issue should be in its own section.
51+
Provide a title for the section so that users can
52+
easily identify the issue that they are experiencing.
53+
54+
-->
55+
56+
[Describe the issue.]
57+
58+
<!-- Required: Issue description (no heading)
59+
60+
Describe the issue.
61+
62+
-->
63+
64+
### Prerequisites
65+
66+
<!--Optional: Prerequisites - H3
67+
68+
Use clear and unambiguous language, and use
69+
an unordered list format.
70+
71+
-->
72+
73+
### Troubleshooting steps
74+
75+
<!-- Optional: Troubleshooting steps - H3
76+
77+
Not all known issues can be corrected, but if a solution
78+
is known, describe the steps to take to correct the issue.
79+
80+
-->
81+
82+
### Possible causes
83+
84+
<!-- Optional: Possible causes - H3
85+
86+
In an H3 section, describe potential causes.
87+
88+
-->

0 commit comments

Comments
 (0)