-
Notifications
You must be signed in to change notification settings - Fork 258
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
SamyOubouaziz
merged 2 commits into
main
from
int-docs-update-guidelines-troubleshooting
Mar 17, 2025
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
SamyOubouaziz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Resource ID | ||
| - Resource name | ||
| - Request type (PUT, GET, etc.) | ||
SamyOubouaziz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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 | ||
SamyOubouaziz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <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> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.