Skip to content

Commit a6e498a

Browse files
SamyOubouazizbene2k1
authored andcommitted
feat(gen): add troubleshooting template (#4590)
* feat(gen): add troubleshooting template * docs(gen): update
1 parent f31afcc commit a6e498a

File tree

3 files changed

+81
-1
lines changed

3 files changed

+81
-1
lines changed

docs/TROUBLESHOOTING_TEMPLATE.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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+
<Message type="note">
21+
If several problems are listed, use the following structure for the page:
22+
```
23+
## Problem 1
24+
### Cause
25+
### Solution
26+
27+
## Problem 2
28+
### Cause
29+
### Solution
30+
31+
[...]
32+
33+
## Going further
34+
```
35+
</Message>
36+
37+
## Cause
38+
39+
Explain the reason(s) why this error happened. A problem can have several causes, in this case, list every possible cause.
40+
41+
## Possible solution
42+
43+
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.
44+
45+
## Going further
46+
47+
Provide links to documentation pages that may be useful if the issue has not been solved.
48+
49+
If required, add a paragraph containing elements to provide the support with when creating a support ticket.
50+
51+
<Macro id="troubleshooting-ticket">
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
macro: troubleshooting-ticket
3+
---
4+
5+
If you still cannot solve your problem, [open a support ticket](/account/how-to/open-a-support-tickets/#writing-an-effective-subject-and-description), providing as many details as possible including the information below:
6+
- Resource ID
7+
- Resource name
8+
- Date and time (timestamp)
9+
- User-agent (SDK, client, console, etc.)
10+
- Transaction ID (if possible)
11+
- Log / trace of the error (if possible)
12+
- Screenshots (using our secure [pastebin tool](https://privatebin.iliad.fr/))
13+
- HTTP status code (if applicable)
14+
- Request type (PUT, GET, etc., if applicable)
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>

pages/guidelines.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ All documentation pages must fall into one of the following categories:
6161
| How to | Shows how to do a core action (e.g. create, configure, delete, use features) for a Scaleway product via the console, e.g. [How to create a Load Balancer](/load-balancer/how-to/create-load-balancer/) |
6262
| Quickstart | Shows how to do the main series of actions necessary to start using a Scaleway product via the console, e.g. [Instances Quickstart](/instances/quickstart/) |
6363
| Concepts | Defines and briefly explains the main terminology associated with a Scaleway product, e.g. [Kubernetes Concepts](/kubernetes/concepts/) |
64-
| Troubleshooting | Gives solutions to help resolve a common issue with a Scaleway product, e.g. [VPC auto-config is not working](/vpc/troubleshooting/autoconfig-not-working/) |
64+
| Troubleshooting | Gives solutions to help resolve a common issue with a Scaleway product, e.g. [VPC auto-config is not working](/vpc/troubleshooting/autoconfig-not-working/). Refer to the [troubleshooting template](https://github.com/scaleway/docs-content/blob/main/docs/TROUBLESHOOTING_TEMPLATE.mdx) for more information |
6565
| API/CLI | Presents information and tips for creating and configuring a Scaleway product via both official and third-party APIs, CLIs, SDKs and other developer tools, e.g. Terraform/OpenTofu, e.g. [Using Object Storage with the AWS-CLI](/object-storage/api-cli/object-storage-aws-cli/). These pages complement the [main developer reference documentation](https://www.scaleway.com/en/developers/). |
6666
| Additional Content | Provides detailed information on specific subjects and features associated with a Scaleway product, e.g. [Optimize your Object Storage performance](/object-storage/reference-content/optimize-object-storage-performance/) |
6767
| Tutorial | Explains how to use a Scaleway product with a third-party tool, or how to use multiple Scaleway products together for a specific use-case, e.g. [Deploying Strapi on an Instance](/tutorials/strapi/) |

0 commit comments

Comments
 (0)