Skip to content

Commit cafa5e5

Browse files
committed
feat(gen): add troubleshooting template
1 parent 0a99e57 commit cafa5e5

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

docs/TROUBLESHOOTING_TEMPLATE.mdx

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
meta:
3+
title: &title Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
4+
description: &desc Description for SEO and referencing purposes that complements the title
5+
content:
6+
h1: *title
7+
paragraph: *desc
8+
tags: fail error troubleshooting help unable cannot
9+
dates:
10+
validation: 2025-03-10
11+
posted: 2025-03-10
12+
categories:
13+
- XXXXX
14+
---
15+
16+
## Problem
17+
18+
A short explanation of the problem, including symptoms, error message/code, unexpected behavior, etc.
19+
20+
## Cause
21+
22+
Explain the reason(s) why this error happened. A problem can have several causes, in this case, list every possible cause.
23+
24+
## Possible solution
25+
26+
List the possible solution(s) to solve the issue. It can be a list of items to check, a procedure, links to other documentation, etc.
27+
28+
## Going further
29+
30+
Provide links to documentation pages that may be useful if the issue has not been solved.
31+
32+
If required, add a paragraph containing elements to provide the support with when creating a support ticket.
33+
34+
<Macro id="troubleshooting-ticket">
+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
macro: troubleshooting-ticket
3+
---
4+
5+
If you did not manage to identify the error and solve it by yourself, [open a support ticket](/account/how-to/open-a-support-tickets/#writing-an-effective-subject-and-description), and provide as many details as possible, along with the necessary information below:
6+
- Resource ID
7+
- Resource name
8+
- Request type (PUT, GET, etc.)
9+
- HTTP status code
10+
- Date and time (timestamp)
11+
- User-agent (SDK, client, console, etc.)
12+
- Transaction ID (if possible)
13+
- Log / trace of the error (if possible)
14+
- Screenshots
15+
16+
<Grid>
17+
<DefaultCard
18+
title="AI search"
19+
description="Use our AI assistant to find solutions."
20+
url="/ai-search/"
21+
label="Ask AI"
22+
/>
23+
<DefaultCard
24+
title="FAQ"
25+
description="Get general information on Scaleway products."
26+
url="/faq/"
27+
label="Read FAQ"
28+
/>
29+
</Grid>

0 commit comments

Comments
 (0)