Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/TROUBLESHOOTING_TEMPLATE.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
meta:
title: &title Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
description: &desc Description for SEO and referencing purposes that complements the title
content:
h1: *title
paragraph: *desc
tags: fail error troubleshooting help unable cannot
dates:
validation: 2025-03-10
posted: 2025-03-10
categories:
- XXXXX
---

## Problem

A short explanation of the problem, including symptoms, error message/code, unexpected behavior, etc.

## Cause

Explain the reason(s) why this error happened. A problem can have several causes, in this case, list every possible cause.

## Possible solution

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.

## Going further

Provide links to documentation pages that may be useful if the issue has not been solved.

If required, add a paragraph containing elements to provide the support with when creating a support ticket.

<Macro id="troubleshooting-ticket">
29 changes: 29 additions & 0 deletions macros/general/troubleshooting-ticket.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
macro: troubleshooting-ticket
---

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:
- Resource ID
- Resource name
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
- Screenshots

<Grid>
<DefaultCard
title="AI search"
description="Use our AI assistant to find solutions."
url="/ai-search/"
label="Ask AI"
/>
<DefaultCard
title="FAQ"
description="Get general information on Scaleway products."
url="/faq/"
label="Read FAQ"
/>
</Grid>