From 0202460a3743ac7a2d4a1f65825a43d74ec84d3a Mon Sep 17 00:00:00 2001 From: Guillaume Mulocher Date: Tue, 11 Jun 2024 20:19:47 +0200 Subject: [PATCH] doc: Address recommendations and issues from doc review (#703) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthieu Tâche --- docs/README.md | 2 +- docs/getting-started.md | 12 ++++++------ docs/troubleshooting.md | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2944df80c..44b445550 100755 --- 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 index bab1cea59..39b270ce1 100644 --- 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 index 7cd6ae90b..40fc07fa0 100644 --- 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
listed in the FAQ?} - B -- Yes --> C{Does the FAQ solution<
works for me?} + B -- Yes --> C{Does the FAQ solution
works for me?} C -- Yes --> V(((Victory))) - B -->|No| E{Is my problem
mentioned in one<
of the open issues?} + B -->|No| E{Is my problem
mentioned in one
of the open issues?} C -->|No| E E -- Yes --> F{Has the issue been
fixed in a newer
release or in main?} F -- Yes --> U[Upgrade]