Skip to content

Commit adf6efd

Browse files
committed
docs(gen): update
1 parent cafa5e5 commit adf6efd

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

docs/TROUBLESHOOTING_TEMPLATE.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,23 @@ categories:
1717

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

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+
2037
## Cause
2138

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

macros/general/troubleshooting-ticket.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
macro: troubleshooting-ticket
33
---
44

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

1616
<Grid>
1717
<DefaultCard

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)