feat(gen): add troubleshooting template #4590
Conversation
There was a problem hiding this comment.
Maybe add a link to the template here in the troubleshooting row: https://www.scaleway.com/en/docs/guidelines/#page-types
| 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: |
There was a problem hiding this comment.
| 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: | |
| 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: |
| 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.) |
There was a problem hiding this comment.
Since request type and HTTP status code will not be relevant to all issues, I'd move them to the bottom of the list with an (if applicable) after each
|
|
||
| A short explanation of the problem, including symptoms, error message/code, unexpected behavior, etc. | ||
|
|
||
| ## Cause |
There was a problem hiding this comment.
I think the cause and solution etc should be H3 under the H2 problem (if including multiple problems per page)
But then I guess if only 1 problem per page it makes sense for them all to be H2
| - User-agent (SDK, client, console, etc.) | ||
| - Transaction ID (if possible) | ||
| - Log / trace of the error (if possible) | ||
| - Screenshots |
There was a problem hiding this comment.
Could we link to the tool they should use to provide screenshots? Maybe check with Support the service they generally ask clients to use (I can't remember it off the top of my head)
EDIT: I think it's https://privatebin.iliad.fr/.
Your checklist for this pull request
Description
Please describe what you added or changed.