Skip to content

feat(gen): add troubleshooting template #4590

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

Merged
merged 2 commits into from
Mar 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
51 changes: 51 additions & 0 deletions docs/TROUBLESHOOTING_TEMPLATE.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
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.

<Message type="note">
If several problems are listed, use the following structure for the page:
```
## Problem 1
### Cause
### Solution

## Problem 2
### Cause
### Solution

[...]

## Going further
```
</Message>

## 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 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:
- Resource ID
- Resource name
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
- Screenshots (using our secure [pastebin tool](https://privatebin.iliad.fr/))
- HTTP status code (if applicable)
- Request type (PUT, GET, etc., if applicable)

<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>
2 changes: 1 addition & 1 deletion pages/guidelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ All documentation pages must fall into one of the following categories:
| 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/) |
| 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/) |
| Concepts | Defines and briefly explains the main terminology associated with a Scaleway product, e.g. [Kubernetes Concepts](/kubernetes/concepts/) |
| 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/) |
| 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 |
| 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/). |
| 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/) |
| 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/) |
Expand Down
Loading