summaryrefslogtreecommitdiffstats
path: root/docs/contribution.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 08:35:51 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 08:35:51 +0000
commit641d0d615623d4818993e1967fc96af1eefc4605 (patch)
treec40f205eb559c8a495489262190a0be4f1829740 /docs/contribution.md
parentAdding upstream version 0.13.0. (diff)
downloadanta-641d0d615623d4818993e1967fc96af1eefc4605.tar.xz
anta-641d0d615623d4818993e1967fc96af1eefc4605.zip
Adding upstream version 0.14.0.upstream/0.14.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/contribution.md')
-rw-r--r--docs/contribution.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/contribution.md b/docs/contribution.md
index 49df256..5c6ae8e 100644
--- a/docs/contribution.md
+++ b/docs/contribution.md
@@ -10,9 +10,9 @@ Contribution model is based on a fork-model. Don't push to arista-netdevops-comm
To help development, open your PR as soon as possible even in draft mode. It helps other to know on what you are working on and avoid duplicate PRs.
-## Create a development environement
+## Create a development environment
-Run the following commands to create an ANTA development environement:
+Run the following commands to create an ANTA development environment:
```bash
# Clone repository
@@ -26,10 +26,10 @@ $ pip install -e .[dev]
$ pip list -e
Package Version Editable project location
------- ------- -------------------------
-anta 0.13.0 /mnt/lab/projects/anta
+anta 0.14.0 /mnt/lab/projects/anta
```
-Then, [`tox`](https://tox.wiki/) is configued with few environments to run CI locally:
+Then, [`tox`](https://tox.wiki/) is configured with few environments to run CI locally:
```bash
$ tox list -d
@@ -219,7 +219,7 @@ Image will be generated under `docs/imgs/uml/` and can be inserted in your docum
Writing documentation is crucial but managing links can be cumbersome. To be sure there is no dead links, you can use [`muffet`](https://github.com/raviqqe/muffet) with the following command:
```bash
-muffet -c 2 --color=always http://127.0.0.1:8000 -e fonts.gstatic.com
+muffet -c 2 --color=always http://127.0.0.1:8000 -e fonts.gstatic.com -b 8192
```
## Continuous Integration