From 822e5e0449baa9aaab856b8c606f043b5bf10433 Mon Sep 17 00:00:00 2001 From: Thomas Grimonet Date: Fri, 7 Jun 2024 08:42:39 +0200 Subject: [PATCH] doc: Update all references to old GH org (#698) --- .github/release.md | 2 +- Dockerfile | 2 +- anta/__init__.py | 2 +- anta/cli/debug/utils.py | 2 +- docs/README.md | 4 ++-- docs/contribution.md | 6 +++--- docs/faq.md | 2 +- docs/requirements-and-installation.md | 18 +++++++++--------- docs/troubleshooting.md | 4 ++-- docs/usage-inventory-catalog.md | 2 +- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/release.md b/.github/release.md index 15db22694..14c7d44da 100644 --- a/.github/release.md +++ b/.github/release.md @@ -83,7 +83,7 @@ This is to be executed at the top of the repo git push origin HEAD gh pr create --title 'bump: ANTA vx.x.x' ``` -9. Merge PR after review and wait for [workflow](https://github.com/arista-netdevops-community/anta/actions/workflows/release.yml) to be executed. +9. Merge PR after review and wait for [workflow](https://github.com/aristanetworks/anta/actions/workflows/release.yml) to be executed. ```bash gh pr merge --squash diff --git a/Dockerfile b/Dockerfile index 85ffff01a..c7cdf656c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -37,7 +37,7 @@ RUN adduser --system anta LABEL "org.opencontainers.image.title"="anta" \ "org.opencontainers.artifact.description"="network-test-automation in a Python package and Python scripts to test Arista devices." \ "org.opencontainers.image.description"="network-test-automation in a Python package and Python scripts to test Arista devices." \ - "org.opencontainers.image.source"="https://github.com/arista-netdevops-community/anta" \ + "org.opencontainers.image.source"="https://github.com/aristanetworks/anta" \ "org.opencontainers.image.url"="https://www.anta.ninja" \ "org.opencontainers.image.documentation"="https://anta.arista.com" \ "org.opencontainers.image.licenses"="Apache-2.0" \ diff --git a/anta/__init__.py b/anta/__init__.py index 4dbc107cc..e7111e94b 100644 --- a/anta/__init__.py +++ b/anta/__init__.py @@ -45,4 +45,4 @@ class RICH_COLOR_PALETTE: "unset": RICH_COLOR_PALETTE.UNSET, } -GITHUB_SUGGESTION = "Please reach out to the maintainer team or open an issue on Github: https://github.com/arista-netdevops-community/anta." +GITHUB_SUGGESTION = "Please reach out to the maintainer team or open an issue on Github: https://github.com/aristanetworks/anta." diff --git a/anta/cli/debug/utils.py b/anta/cli/debug/utils.py index 26fef45ab..04a7a38b1 100644 --- a/anta/cli/debug/utils.py +++ b/anta/cli/debug/utils.py @@ -48,7 +48,7 @@ def wrapper( device: str, **kwargs: Any, ) -> Any: - # TODO: @gmuloc - tags come from context https://github.com/arista-netdevops-community/anta/issues/584 + # TODO: @gmuloc - tags come from context https://github.com/aristanetworks/anta/issues/584 # pylint: disable=unused-argument # ruff: noqa: ARG001 if (d := inventory.get(device)) is None: diff --git a/docs/README.md b/docs/README.md index 92aea5b7d..a040f5a33 100755 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ | **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) | | :------------: | :-------| -| **License** | [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://github.com/arista-netdevops-community/anta/blob/main/LICENSE) | +| **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) | | **PyPi** | ![PyPi Version](https://img.shields.io/pypi/v/anta) ![Python Versions](https://img.shields.io/pypi/pyversions/anta) ![Python format](https://img.shields.io/pypi/format/anta) ![PyPI - Downloads](https://img.shields.io/pypi/dm/anta) | @@ -22,7 +22,7 @@ ANTA is Python framework that automates tests for Arista devices. - As a [Python library](advanced_usages/as-python-lib.md) in your own application - The [ANTA CLI](cli/overview.md) -![anta nrfu](https://raw.githubusercontent.com/arista-netdevops-community/anta/main/docs/imgs/anta-nrfu.svg) +![anta nrfu](https://raw.githubusercontent.com/aristanetworks/anta/main/docs/imgs/anta-nrfu.svg) ## Install ANTA library diff --git a/docs/contribution.md b/docs/contribution.md index cc3a1c006..91052355d 100644 --- a/docs/contribution.md +++ b/docs/contribution.md @@ -6,7 +6,7 @@ # How to contribute to ANTA -Contribution model is based on a fork-model. Don't push to arista-netdevops-community/anta directly. Always do a branch in your forked repository and create a PR. +Contribution model is based on a fork-model. Don't push to aristanetworks/anta directly. Always do a branch in your forked repository and create a PR. 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. @@ -16,7 +16,7 @@ Run the following commands to create an ANTA development environment: ```bash # Clone repository -$ git clone https://github.com/arista-netdevops-community/anta.git +$ git clone https://github.com/aristanetworks/anta.git $ cd anta # Install ANTA in editable mode and its development tools @@ -229,4 +229,4 @@ muffet -c 2 --color=always http://127.0.0.1:8000 -e fonts.gstatic.com -b 8192 ## Continuous Integration -GitHub actions is used to test git pushes and pull requests. The workflows are defined in this [directory](https://github.com/arista-netdevops-community/anta/tree/main/.github/workflows). We can view the results [here](https://github.com/arista-netdevops-community/anta/actions). +GitHub actions is used to test git pushes and pull requests. The workflows are defined in this [directory](https://github.com/aristanetworks/anta/tree/main/.github/workflows). We can view the results [here](https://github.com/aristanetworks/anta/actions). diff --git a/docs/faq.md b/docs/faq.md index c71d1c6f2..a699c8431 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -126,4 +126,4 @@ toc_depth: 2 # Still facing issues? -If you've tried the above solutions and continue to experience problems, please follow the [troubleshooting](troubleshooting.md) instructions and report the issue in our [GitHub repository](https://github.com/arista-netdevops-community/anta). +If you've tried the above solutions and continue to experience problems, please follow the [troubleshooting](troubleshooting.md) instructions and report the issue in our [GitHub repository](https://github.com/aristanetworks/anta). diff --git a/docs/requirements-and-installation.md b/docs/requirements-and-installation.md index 75560d3aa..5bdbf01fe 100644 --- a/docs/requirements-and-installation.md +++ b/docs/requirements-and-installation.md @@ -19,7 +19,7 @@ Python 3.11.8 This installation will deploy tests collection, scripts and all their Python requirements. -The ANTA package and the cli require some packages that are not part of the Python standard library. They are indicated in the [pyproject.toml](https://github.com/arista-netdevops-community/anta/blob/main/pyproject.toml) file, under dependencies. +The ANTA package and the cli require some packages that are not part of the Python standard library. They are indicated in the [pyproject.toml](https://github.com/aristanetworks/anta/blob/main/pyproject.toml) file, under dependencies. ### Install library from Pypi server @@ -59,18 +59,18 @@ pip install anta[cli] ```bash -pip install git+https://github.com/arista-netdevops-community/anta.git -pip install git+https://github.com/arista-netdevops-community/anta.git#egg=anta[cli] +pip install git+https://github.com/aristanetworks/anta.git +pip install git+https://github.com/aristanetworks/anta.git#egg=anta[cli] # You can even specify the branch, tag or commit: -pip install git+https://github.com/arista-netdevops-community/anta.git@ -pip install git+https://github.com/arista-netdevops-community/anta.git@#egg=anta[cli] +pip install git+https://github.com/aristanetworks/anta.git@ +pip install git+https://github.com/aristanetworks/anta.git@#egg=anta[cli] -pip install git+https://github.com/arista-netdevops-community/anta.git@ -pip install git+https://github.com/arista-netdevops-community/anta.git@#egg=anta[cli] +pip install git+https://github.com/aristanetworks/anta.git@ +pip install git+https://github.com/aristanetworks/anta.git@#egg=anta[cli] -pip install git+https://github.com/arista-netdevops-community/anta.git@ -pip install git+https://github.com/arista-netdevops-community/anta.git@#egg=anta[cli] +pip install git+https://github.com/aristanetworks/anta.git@ +pip install git+https://github.com/aristanetworks/anta.git@#egg=anta[cli] ``` ### Check installation diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f27de7aee..7cd6ae90b 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -24,8 +24,8 @@ flowchart LR F -- No ----> G((Add a comment on the
issue indicating you
are hitting this and
describing your setup
and adding your logs.)) click B "../faq" "FAQ" - click E "https://github.com/arista-netdevops-community/anta/issues" - click H "https://github.com/arista-netdevops-community/anta/issues" + click E "https://github.com/aristanetworks/anta/issues" + click H "https://github.com/aristanetworks/anta/issues" style A stroke:#f00,stroke-width:2px ``` diff --git a/docs/usage-inventory-catalog.md b/docs/usage-inventory-catalog.md index 30f458498..71b05b032 100644 --- a/docs/usage-inventory-catalog.md +++ b/docs/usage-inventory-catalog.md @@ -129,7 +129,7 @@ anta.tests: custom_field: "Test run by John Doe" ``` -[This test catalog example](https://github.com/arista-netdevops-community/anta/blob/main/examples/tests.yaml) is maintained with all the tests defined in the `anta.tests` Python module. +[This test catalog example](https://github.com/aristanetworks/anta/blob/main/examples/tests.yaml) is maintained with all the tests defined in the `anta.tests` Python module. ### Test tags