Skip to content

Commit 76e0845

Browse files
authored
change Remedy to Solution (#974)
1 parent a297d1b commit 76e0845

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/guidelines/content-guidelines/00-content-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Troubleshooting topics provide a condition that the reader may want to correct,
4848

4949
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.
5050

51-
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.
51+
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.
5252

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

templates/resources/troubleshooting.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@ As document title, mention the symptom that needs fixing ("Cannot access...") or
1818

1919
<!-- Briefly describe a possible cause for the condition.
2020
21-
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.
21+
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.
2222
23-
Cause and remedy might occur in combinations other than pairs. It is possible to have:
23+
Cause and solution might occur in combinations other than pairs. It is possible to have:
2424
25-
- Multiple causes with the same remedy
26-
- A single cause with more than one remedy
27-
- A remedy with no known cause
28-
- A cause with no known remedy
25+
- Multiple causes with the same solution
26+
- A single cause with more than one solution
27+
- A solution with no known cause
28+
- A cause with no known solution
2929
-->
3030

3131
## Solution
3232

3333
<!-- Provide a solution for the condition.
3434
If the user needs to execute more than one step, use a numbered list.
3535
36-
If there is more than one remedy for a cause, begin with the simplest one.
36+
If there is more than one solution for a cause, begin with the simplest one.
3737
-->
3838

3939
1.

0 commit comments

Comments
 (0)