Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Troubleshooting topics provide a condition that the reader may want to correct,

In the title, mention the symptom that needs fixing ("Cannot access...") or the error message. To quote an error message, start and end with `'` to escape `"` (because quotation marks `"` themselves do not display correctly on the website), for example, `title: '"FAILED" status for created ServiceInstances'`. Do not use the cause as the title ("Incompatible version"), because we also want to help users who have no idea about the cause and only know something's not working as expected.

It's good practice to use three standard headlines (like “Condition”, “Cause”, “Remedy”), each might have just one sentence or more as needed. For remedy, use a numbered list if there are multiple steps to follow, and a bullet list or sub-headlines if there are several equally valid solutions.
It's good practice to use three standard headlines (like “Condition”, “Cause”, "Solution"), each might have just one sentence or more as needed. For solution, use a numbered list if there are multiple steps to follow, and a bullet list or sub-headlines if there are several equally valid solutions.

For all troubleshooting topics, use the [troubleshooting topic template](https://github.com/kyma-project/community/blob/main/templates/resources/troubleshooting.md).

Expand Down
14 changes: 7 additions & 7 deletions templates/resources/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ As document title, mention the symptom that needs fixing ("Cannot access...") or

<!-- Briefly describe a possible cause for the condition.

For some conditions, there could be more than one cause-remedy pair. Typically, a cause is immediately followed by its remedy. Multiple cause-remedy pairs can provide a series of successive fall-backs for resolving a condition.
For some conditions, there could be more than one cause-solution pair. Typically, a cause is immediately followed by its solution. Multiple cause-solution pairs can provide a series of successive fall-backs for resolving a condition.

Cause and remedy might occur in combinations other than pairs. It is possible to have:
Cause and solution might occur in combinations other than pairs. It is possible to have:

- Multiple causes with the same remedy
- A single cause with more than one remedy
- A remedy with no known cause
- A cause with no known remedy
- Multiple causes with the same solution
- A single cause with more than one solution
- A solution with no known cause
- A cause with no known solution
-->

## Solution

<!-- Provide a solution for the condition.
If the user needs to execute more than one step, use a numbered list.

If there is more than one remedy for a cause, begin with the simplest one.
If there is more than one solution for a cause, begin with the simplest one.
-->

1.
Expand Down