-
Notifications
You must be signed in to change notification settings - Fork 43
Troubleshoot issues #926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Troubleshoot issues #926
Conversation
4ed714e
to
8106df4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this contribution, @Gijsreyn!
We actually have a template for known issues on the docs site. Could you please rework your article from this template and rename the file to known-issues.md
? Don't worry about the frontmatter, I'll handle that afterward.
---
title: 'Known issues: Microsoft Desired State Configuration'
description: "[Article description]."
author: [your GitHub alias]
ms.author: [your Microsoft alias or a team alias]
ms.service: [the approved service name]
ms.topic: troubleshooting-known-issue #Don't change.
ms.date: [mm/dd/yyyy]
#customer intent: As a <role>, I want <what> so that <why>.
---
<!-- --------------------------------------
- Use this template with pattern instructions for:
Known Issues
- Before you sign off or merge:
Remove all comments except the customer intent.
-->
# Known issues: Microsoft Desired State Configuration
<!-- Required: Article headline - H1
Identify the product or service the article
applies to.
-->
[Introduce and explain the purpose of the article.]
<!-- Required: Introductory paragraphs (no heading)
Write a brief introduction that can help the user
determine whether the article is relevant for them
and to describe the specific issue that the article
covers.
-->
## [Issue]
<!-- Required: Issue - H2
Each known issue should be in its own section.
Provide a title for the section so that users can
easily identify the issue that they are experiencing.
-->
[Describe the issue.]
<!-- Required: Issue description (no heading)
Describe the issue.
-->
### Prerequisites
<!--Optional: Prerequisites - H3
Use clear and unambiguous language, and use
an unordered list format.
-->
### Troubleshooting steps
<!-- Optional: Troubleshooting steps - H3
Not all known issues can be corrected, but if a solution
is known, describe the steps to take to correct the issue.
-->
### Possible causes
<!-- Optional: Possible causes - H3
In an H3 section, describe potential causes.
-->
I think it would also be helpful to add a troubleshooting section for PSDSC resources that aren't installed in the AllUsers scope for Windows PowerShell.
Fully agreed Mikey and thanks for the share! I'll pick it up. I tried mimicking it from the PSDesiredStateConfiguration one. Did a quick search on the document, but couldn't find a reference one. Perhaps if you got a URL, can you share it? Else I will give it a shot what you posted here :) |
Unfortunately the templates aren't publicly hosted, but the snippet I gave is the full template for this kind of troubleshooting doc. I'll scaffold the other documents when I have a chance. |
PR Summary
Instead of updating all resource manifest examples, I thought of creating a PR to add a troubleshooting article.
PR Context