Fix MD033 warnings
The following warnings are generated by using markdownlint analysis:
```
MD033/no-inline-html Inline HTML [Element: code]
MD033/no-inline-html Inline HTML [Element: pre]
MD033/no-inline-html Inline HTML [Element: b]
MD033/no-inline-html Inline HTML [Element: i]
```
Refer to markdown-lint [1] to fix MD033
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/033-no-inline-html.md
Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I7dfb63e9f3a663cfea60b5d0a0a4ae8540ddd1d6
diff --git a/docs/monitor/class.md b/docs/monitor/class.md
index 18a903d..29796a5 100644
--- a/docs/monitor/class.md
+++ b/docs/monitor/class.md
@@ -18,11 +18,11 @@
## Example
-<pre><code>
+```json
{
"sensor_trust_groups": [
{
- <b><i>"class": "NonzeroSpeed"</i></b>,
+ "class": "NonzeroSpeed",
"group": [
{
"name": "fan0_0"
@@ -38,4 +38,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/deviation.md b/docs/monitor/deviation.md
index ddedbea..0476f63 100644
--- a/docs/monitor/deviation.md
+++ b/docs/monitor/deviation.md
@@ -19,15 +19,15 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
"inventory": "/system/chassis/motherboard/fan0",
"allowed_out_of_range_time": 30,
"functional_delay": 5,
- <b><i>"deviation": 15</i></b>,
- <b><i>"upper_deviation": 30</i></b>,
+ "deviation": 15,
+ "upper_deviation": 30,
"num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
"fan_missing_error_delay": 20,
@@ -47,4 +47,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/fan_missing_error_delay.md b/docs/monitor/fan_missing_error_delay.md
index 4fc0cf7..17413cc 100644
--- a/docs/monitor/fan_missing_error_delay.md
+++ b/docs/monitor/fan_missing_error_delay.md
@@ -12,7 +12,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -22,7 +22,7 @@
"deviation": 15,
"num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
- <b><i>"fan_missing_error_delay": 20</i></b>,
+ "fan_missing_error_delay": 20,
"nonfunc_rotor_error_delay": 0,
"sensors": [
{
@@ -39,4 +39,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/group.md b/docs/monitor/group.md
index 9a6d3a1..5d5d0a6 100644
--- a/docs/monitor/group.md
+++ b/docs/monitor/group.md
@@ -19,12 +19,12 @@
## Example
-<pre><code>
+```json
{
"sensor_trust_groups": [
{
"class": "NonzeroSpeed",
- <b><i>"group": [
+ "group": [
{
"name": "fan0_0"
},
@@ -35,8 +35,8 @@
"name": "fan2_0",
"in_trust": false
}
- ]</i></b>
+ ]
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/inventory.md b/docs/monitor/inventory.md
index 551adba..a70a99d 100644
--- a/docs/monitor/inventory.md
+++ b/docs/monitor/inventory.md
@@ -13,11 +13,11 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
- <b><i>"inventory": "/system/chassis/motherboard/fan0"</i></b>,
+ "inventory": "/system/chassis/motherboard/fan0",
"allowed_out_of_range_time": 30,
"functional_delay": 5,
"deviation": 15,
@@ -40,4 +40,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/method.md b/docs/monitor/method.md
index b53c65e..38da92f 100644
--- a/docs/monitor/method.md
+++ b/docs/monitor/method.md
@@ -77,13 +77,13 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
"inventory": "/system/chassis/motherboard/fan0",
- <b><i>"allowed_out_of_range_time": 30,
- "functional_delay": 5</i></b>,
+ "allowed_out_of_range_time": 30,
+ "functional_delay": 5,
"deviation": 15,
"num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
@@ -104,8 +104,8 @@
},
{
"inventory": "/system/chassis/motherboard/fan1",
- <b><i>"method": "count",
- "count_interval": 1</i></b>,
+ "method": "count",
+ "count_interval": 1,
"deviation": 15,
"num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
@@ -115,17 +115,17 @@
{
"name": "fan0_0",
"has_target": true,
- <b><i>"threshold": 30</i></b>
+ "threshold": 30
},
{
"name": "fan0_1",
"has_target": false,
"factor": 1.45,
"offset": -909,
- <b><i>"threshold": 30</i></b>
+ "threshold": 30
}
]
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/monitor_start_delay.md b/docs/monitor/monitor_start_delay.md
index 1d99df2..175085a 100644
--- a/docs/monitor/monitor_start_delay.md
+++ b/docs/monitor/monitor_start_delay.md
@@ -13,7 +13,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -22,7 +22,7 @@
"functional_delay": 5,
"deviation": 15,
"num_sensors_nonfunc_for_fan_nonfunc": 1,
- <b><i>"monitor_start_delay": 30</i></b>,
+ "monitor_start_delay": 30,
"fan_missing_error_delay": 20,
"nonfunc_rotor_error_delay": 0,
"sensors": [
@@ -40,4 +40,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/nonfunc_rotor_error_delay.md b/docs/monitor/nonfunc_rotor_error_delay.md
index 05ad6a2..8abb3a7 100644
--- a/docs/monitor/nonfunc_rotor_error_delay.md
+++ b/docs/monitor/nonfunc_rotor_error_delay.md
@@ -16,7 +16,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -27,7 +27,7 @@
"num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
"fan_missing_error_delay": 20,
- <b><i>"nonfunc_rotor_error_delay": 0</i></b>,
+ "nonfunc_rotor_error_delay": 0,
"sensors": [
{
"name": "fan0_0",
@@ -43,4 +43,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/num_nonfunc_rotors_before_error.md b/docs/monitor/num_nonfunc_rotors_before_error.md
index c7b29ba..d0f0bd8 100644
--- a/docs/monitor/num_nonfunc_rotors_before_error.md
+++ b/docs/monitor/num_nonfunc_rotors_before_error.md
@@ -15,11 +15,11 @@
## Example
-<pre><code>
+```json
{
"fault_handling": [
{
- <b><i>"num_nonfunc_rotors_before_error": 1</i></b>,
+ "num_nonfunc_rotors_before_error": 1,
"power_off_config": [
{
"type": "hard",
@@ -46,4 +46,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
index 8988bc3..07e6b3a 100644
--- a/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
+++ b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
@@ -13,7 +13,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -21,7 +21,7 @@
"allowed_out_of_range_time": 30,
"functional_delay": 5,
"deviation": 15,
- <b><i>"num_sensors_nonfunc_for_fan_nonfunc": 1</i></b>,
+ "num_sensors_nonfunc_for_fan_nonfunc": 1,
"monitor_start_delay": 30,
"fan_missing_error_delay": 20,
"nonfunc_rotor_error_delay": 0,
@@ -40,4 +40,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/power_off_config.md b/docs/monitor/power_off_config.md
index 7c7fef6..73aeb08 100644
--- a/docs/monitor/power_off_config.md
+++ b/docs/monitor/power_off_config.md
@@ -50,12 +50,12 @@
## Example
-<pre><code>
+```json
{
"fault_handling": [
{
"num_nonfunc_rotors_before_error": 1,
- <b><i>"power_off_config": [
+ "power_off_config": [
{
"type": "hard",
"cause": "missing_fan_frus",
@@ -77,8 +77,8 @@
"service_mode_delay": 300,
"meltdown_delay": 300
}
- ]</i></b>
+ ]
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/sensors.md b/docs/monitor/sensors.md
index 3106d25..e58d9f4 100644
--- a/docs/monitor/sensors.md
+++ b/docs/monitor/sensors.md
@@ -41,7 +41,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -53,7 +53,7 @@
"monitor_start_delay": 30,
"fan_missing_error_delay": 20,
"nonfunc_rotor_error_delay": 0,
- <b><i>"sensors": [
+ "sensors": [
{
"name": "fan0_0",
"has_target": true,
@@ -66,8 +66,8 @@
"factor": 1.45,
"offset": -909
}
- ]</i></b>
+ ]
}
]
}
-</code></pre>
+```
diff --git a/docs/monitor/set_func_on_present.md b/docs/monitor/set_func_on_present.md
index 0aa5dff..ee8b04e 100644
--- a/docs/monitor/set_func_on_present.md
+++ b/docs/monitor/set_func_on_present.md
@@ -21,7 +21,7 @@
## Example
-<pre><code>
+```json
{
"fans": [
{
@@ -33,7 +33,7 @@
"monitor_start_delay": 30,
"fan_missing_error_delay": 20,
"nonfunc_rotor_error_delay": 0,
- <b><i>"set_func_on_present": true</i></b>,
+ "set_func_on_present": true,
"sensors": [
{
"name": "fan0_0",
@@ -49,4 +49,4 @@
}
]
}
-</code></pre>
+```
diff --git a/docs/presence/eeprom.md b/docs/presence/eeprom.md
index 4d8b57f..006a48b 100644
--- a/docs/presence/eeprom.md
+++ b/docs/presence/eeprom.md
@@ -44,7 +44,7 @@
## Example
-<pre><code>
+```json
[
{
"name": "fan0",
@@ -52,19 +52,17 @@
"methods": [
{
"type": "tach",
- "sensors": [
- "fan0_0"
- ]
+ "sensors": ["fan0_0"]
}
],
"rpolicy": {
"type": "anyof"
},
- <b><i>"eeprom": {
+ "eeprom": {
"bus_address": "30-0050",
"driver_name": "at24",
"bind_delay_ms": 1000
- }</i></b>
+ }
}
]
-</code></pre>
+```
diff --git a/docs/presence/methods.md b/docs/presence/methods.md
index 666a35a..f840052 100644
--- a/docs/presence/methods.md
+++ b/docs/presence/methods.md
@@ -41,22 +41,20 @@
## Example
-<pre><code>
+```json
[
{
"name": "fan0",
"path": "/system/chassis/motherboard/fan0",
- <b><i>"methods": [
+ "methods": [
{
"type": "tach",
- "sensors": [
- "fan0_0"
- ]
+ "sensors": ["fan0_0"]
}
- ]</i></b>,
+ ],
"rpolicy": {
"type": "anyof"
- }"
+ }
}
]
-</code></pre>
+```
diff --git a/docs/presence/name.md b/docs/presence/name.md
index be4f4ce..e0ed501 100644
--- a/docs/presence/name.md
+++ b/docs/presence/name.md
@@ -10,22 +10,20 @@
## Example
-<pre><code>
+```json
[
{
- <b><i>"name": "fan0"</i></b>,
+ "name": "fan0",
"path": "/system/chassis/motherboard/fan0",
"methods": [
{
"type": "tach",
- "sensors": [
- "fan0_0"
- ]
+ "sensors": ["fan0_0"]
}
],
"rpolicy": {
"type": "anyof"
- }"
+ }
}
]
-</code></pre>
+```
diff --git a/docs/presence/path.md b/docs/presence/path.md
index 9030cb0..d82352a 100644
--- a/docs/presence/path.md
+++ b/docs/presence/path.md
@@ -13,22 +13,20 @@
## Example
-<pre><code>
+```json
[
{
"name": "fan0",
- <b><i>"path": "/system/chassis/motherboard/fan0"</i></b>,
+ "path": "/system/chassis/motherboard/fan0",
"methods": [
{
"type": "tach",
- "sensors": [
- "fan0_0"
- ]
+ "sensors": ["fan0_0"]
}
],
"rpolicy": {
"type": "anyof"
- }"
+ }
}
]
-</code></pre>
+```