doc: Address recommendations and issues from doc review (#703)

Co-authored-by: Matthieu Tâche <mtache@arista.com>
aristanetworks · Jun 11, 2024 · 0202460 · 0202460
1 parent 76a1526
commit 0202460
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,7 +6,7 @@
 
 # Arista Network Test Automation (ANTA) Framework
 
-| **Code**       | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Numpy](https://img.shields.io/badge/Docstring_format-numpy-blue)](https://numpydoc.readthedocs.io/en/latest/format.html) |
+| **Code**       | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Numpy](https://img.shields.io/badge/Docstring_format-numpy-blue)](https://numpydoc.readthedocs.io/en/latest/format.html) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aristanetworks_anta&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aristanetworks_anta) |
 | :------------: | :-------|
 | **License**    | [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://github.com/aristanetworks/anta/blob/main/LICENSE) |
 | **GitHub**     | [![CI](https://github.com/aristanetworks/anta/actions/workflows/code-testing.yml/badge.svg)](https://github.com/aristanetworks/anta/actions/workflows/code-testing.yml) ![Coverage](https://raw.githubusercontent.com/aristanetworks/anta/coverage-badge/latest-release-coverage.svg) ![Commit](https://img.shields.io/github/last-commit/aristanetworks/anta) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/aristanetworks/anta) [![Github release](https://img.shields.io/github/release/aristanetworks/anta.svg)](https://github.com/aristanetworks/anta/releases/) [![Contributors](https://img.shields.io/github/contributors/aristanetworks/anta)](https://github.com/aristanetworks/anta/graphs/contributors) |

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -121,12 +121,6 @@ anta.tests.configuration:
 
 ## Test your network
 
-### Basic usage in a python script
-
-```python
---8<-- "anta_runner.py"
-```
-
 ### CLI
 
 ANTA comes with a generic CLI entrypoint to run tests in your network. It requires an inventory file as well as a test catalog.
@@ -264,3 +258,9 @@ $ anta nrfu \
 ```
 
 You can find more information under the __usage__ section of the website
+
+### Basic usage in a Python script
+
+```python
+--8<-- "anta_runner.py"
+```
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -11,9 +11,9 @@ A couple of things to check when hitting an issue with ANTA:
 ```mermaid
 flowchart LR
     A>Hitting an issue with ANTA] --> B{Is my issue <br >listed in the FAQ?}
-    B -- Yes --> C{Does the FAQ solution<<br />works for me?}
+    B -- Yes --> C{Does the FAQ solution<br />works for me?}
     C -- Yes --> V(((Victory)))
-    B -->|No| E{Is my problem<br />mentioned in one<<br />of the open issues?}
+    B -->|No| E{Is my problem<br />mentioned in one<br />of the open issues?}
     C -->|No| E
     E -- Yes --> F{Has the issue been<br />fixed in a newer<br />release or in main?}
     F -- Yes --> U[Upgrade]