Doc: rename repo ansible-avd -> avd (#3513)

Co-authored-by: Claus Holbech <[email protected]>

.devcontainer/devcontainer.json

@@ -3,16 +3,16 @@
     "mounts": [
         "source=${localWorkspaceFolder}/ansible_collections/arista/avd,target=/home/avd/.ansible/collections/ansible_collections/arista/avd,type=bind"
     ],
-    "image": "ghcr.io/aristanetworks/ansible-avd/dev:python3.11",
+    "image": "ghcr.io/aristanetworks/avd/dev:python3.11",
     // The AVD collection can also be installed from any git branch.
     // Comment mount section if this is the case.
     //
     // "containerEnv": {
-    //     "AVD_GITHUB_REPO": "aristanetworks/ansible-avd",
+    //     "AVD_GITHUB_REPO": "aristanetworks/avd",
     //     "AVD_BRANCH_NAME": "devel"
     // },
     // Run entrypoint script manually as it's ignored by dev container CLI otherwise.
     // The dev entrypoint is used to install Ansible collections and requirements, as they are not included with the dev version.
     // "true" is required to exit "onCreateCommand" without entering ZSH.
     "onCreateCommand": "/bin/entrypoint.sh true"
-}
+}

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -32,4 +32,4 @@ Fixes #<ISSUE ID>
 - [ ] My code has been rebased from devel before I start
 - [ ] I have read the [**CONTRIBUTING**](https://avd.sh/en/latest/docs/contribution/overview.html) document.
 - [ ] My change requires a change to the documentation and documentation have been updated accordingly.
-- [ ] I have updated [molecule CI](https://github.com/aristanetworks/ansible-avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)
+- [ ] I have updated [molecule CI](https://github.com/aristanetworks/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)

.github/changelog.sh

@@ -192,7 +192,7 @@ function display-release {
     case "$output" in
     raw) printf "$hash" ;;
     text) printf "\e[33m$hash\e[0m" ;; # red
-    md) printf "[\`$hash\`](https://github.com/aristanetworks/ansible-avd/commit/$hash)" ;;
+    md) printf "[\`$hash\`](https://github.com/aristanetworks/avd/commit/$hash)" ;;
     esac
   }
 
@@ -262,7 +262,7 @@ function display-release {
     # In text mode, highlight (#<issue>) and dim text between `backticks`
     text) sed -E $'s|#([0-9]+)|\e[32m#\\1\e[0m|g;s|`([^`]+)`|`\e[2m\\1\e[0m`|g' <<< "$subject" ;;
     # In markdown mode, link to (#<issue>) issues
-    md) sed -E 's|#([0-9]+)|[#\1](https://github.com/aristanetworks/ansible-avd/issues/\1)|g' <<< "$subject" ;;
+    md) sed -E 's|#([0-9]+)|[#\1](https://github.com/aristanetworks/avd/issues/\1)|g' <<< "$subject" ;;
     esac
   }
 
@@ -368,7 +368,7 @@ function main {
     # If $since is not specified:
     # 1) try to find the version used before updating
     # 2) try to find the first version tag before $until
-    since=$(command git config --get ansible-avd.lastVersion 2>/dev/null) || \
+    since=$(command git config --get avd.lastVersion 2>/dev/null) || \
     since=$(command git describe --abbrev=0 --tags "$until^" 2>/dev/null) || \
     unset since
   elif [[ "$since" = --all ]]; then

.github/pull_request_template.md

@@ -32,4 +32,4 @@ Fixes #<ISSUE ID>
 - [ ] My code has been rebased from devel before I start
 - [ ] I have read the [**CONTRIBUTING**](https://avd.sh/en/latest/docs/contribution/overview.html) document.
 - [ ] My change requires a change to the documentation and documentation have been updated accordingly.
-- [ ] I have updated [molecule CI](https://github.com/aristanetworks/ansible-avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)
+- [ ] I have updated [molecule CI](https://github.com/aristanetworks/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)

.github/workflows/container_build_base.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build_base:
-    if: github.repository == 'aristanetworks/ansible-avd'
+    if: github.repository == 'aristanetworks/avd'
     uses: ./.github/workflows/container_build_template.yml
     strategy:
       matrix:

.github/workflows/container_build_dev.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build_dev_container:
-    if: github.repository == 'aristanetworks/ansible-avd'
+    if: github.repository == 'aristanetworks/avd'
     uses: ./.github/workflows/container_build_template.yml
     strategy:
       matrix:

.github/workflows/container_build_universal.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   build_universal_container:
-    if: github.repository == 'aristanetworks/ansible-avd'
+    if: github.repository == 'aristanetworks/avd'
     uses: ./.github/workflows/container_build_template.yml
     strategy:
       matrix:

.github/workflows/devel-push.yml

@@ -1,6 +1,6 @@
 ---
 # This workflow is conditionned to only run on the main repo
-# aristanetworks/ansible-avd and not on forks
+# aristanetworks/avd and not on forks
 # cf - https://github.com/actions/runner/issues/859
 # TODO - revisist if a feature is ever published
 name: "Devel Code Management"
@@ -28,7 +28,7 @@ jobs:
       docs: ${{ steps.filter.outputs.docs }}
     if: |
       github.event_name != 'workflow_dispatch' &&
-      github.repository == 'aristanetworks/ansible-avd'
+      github.repository == 'aristanetworks/avd'
     steps:
       - uses: actions/checkout@v3
       - uses: dorny/paths-filter@v2
@@ -94,7 +94,7 @@ jobs:
     #   * either there is a file change
     #   * or it is a manually triggered workflow on devel
     if: |
-      github.repository == 'aristanetworks/ansible-avd' &&
+      github.repository == 'aristanetworks/avd' &&
       (needs.file-changes.outputs.requirements == 'true' ||
        (github.ref == 'refs/heads/devel' && github.event_name == 'workflow_dispatch'))
     steps:

.github/workflows/installation-test.yml

@@ -7,7 +7,7 @@ jobs:
     name: 'One liner installation'
     runs-on: ubuntu-20.04
     container: avdteam/base:3.8-v2.0
-    if: github.repository == 'aristanetworks/ansible-avd'
+    if: github.repository == 'aristanetworks/avd'
     steps:
       - uses: actions/checkout@v3
       - name: Execute one-liner installation

.github/workflows/stale.yml

@@ -6,7 +6,7 @@ on:
 jobs:
   stale:
     runs-on: ubuntu-latest
-    if: github.repository == 'aristanetworks/ansible-avd'
+    if: github.repository == 'aristanetworks/avd'
     steps:
       # Issue stale management
     - uses: actions/stale@v6

README.md

@@ -6,7 +6,7 @@
 
 # Arista Validated Designs
 
-![Arista AVD](https://img.shields.io/badge/Arista-AVD%20Automation-blue) ![collection version](https://img.shields.io/github/v/release/aristanetworks/ansible-avd) ![License](https://img.shields.io/github/license/aristanetworks/ansible-avd)
+![Arista AVD](https://img.shields.io/badge/Arista-AVD%20Automation-blue) ![collection version](https://img.shields.io/github/v/release/aristanetworks/avd) ![License](https://img.shields.io/github/license/aristanetworks/avd)
 
 <center><img src="ansible_collections/arista/avd/media/avd-logo.png" alt="Arista AVD Overview" width="800"/></center>
 
@@ -45,13 +45,13 @@ AVD Documentation:
 
 ## Ask a question
 
-Support for this `arista.avd` collection is provided by the community directly in this repository. If you have any questions, please leverage the GitHub [discussions board](https://github.com/aristanetworks/ansible-avd/discussions).
+Support for this `arista.avd` collection is provided by the community directly in this repository. If you have any questions, please leverage the GitHub [discussions board](https://github.com/aristanetworks/avd/discussions).
 
 ## Contributing
 
 Contributing pull requests are gladly welcomed for this repository. If you are planning a big change, please start a discussion first to make sure we'll be able to merge it. Please see [contribution guide](./ansible_collections/arista/avd/docs/contribution/overview.md) for additional details.
 
-You can also open an [issue](https://github.com/aristanetworks/ansible-avd/issues) to report any problems or submit requests for enhancements.
+You can also open an [issue](https://github.com/aristanetworks/avd/issues) to report any problems or submit requests for enhancements.
 
 ## License
 

ansible_collections/arista/avd/README.md

@@ -67,7 +67,7 @@ See the section "Ansible Collection Plugins" on the menu to the left.
 
 ## Ask a question
 
-Support for the `arista.avd` collection is provided by the community directly in this repository. If you have any questions, please leverage the GitHub [discussions board](https://github.com/aristanetworks/ansible-avd/discussions).
+Support for the `arista.avd` collection is provided by the community directly in this repository. If you have any questions, please leverage the GitHub [discussions board](https://github.com/aristanetworks/avd/discussions).
 
 ### Official Arista support
 
@@ -77,8 +77,8 @@ AVD version 4.x releases with full support from Arista TAC. If your organization
 
 Contributing pull requests are gladly welcomed for this repository. If you are planning a big change, please start a discussion first to make sure we'll be able to merge it. Please see [contribution guide](https://avd.arista.com/stable/docs/contribution/overview.html) for additional details.
 
-You can also open an [issue](https://github.com/aristanetworks/ansible-avd/issues) to report any problems or submit enhancements.
+You can also open an [issue](https://github.com/aristanetworks/avd/issues) to report any problems or submit enhancements.
 
 ## License
 
-The project is published under [Apache 2.0 License](https://github.com/aristanetworks/ansible-avd/blob/devel/ansible_collections/arista/avd/LICENSE)
+The project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/ansible_collections/arista/avd/LICENSE)

ansible_collections/arista/avd/changelogs/README.md

@@ -26,13 +26,13 @@
     - converts
 
       ```md
-      * Fix(eos_designs): Fix schema for BGP peers to allow shutdown key by @ClausHolbechArista in https://github.com/aristanetworks/ansible-avd/pull/3100
+      * Fix(eos_designs): Fix schema for BGP peers to allow shutdown key by @ClausHolbechArista in https://github.com/aristanetworks/avd/pull/3100
       ```
 
     - to
 
       ```md
-      - Fix(eos_designs) - Fix schema for BGP peers to allow shutdown key (https://github.com/aristanetworks/ansible-avd/pull/3100)
+      - Fix(eos_designs) - Fix schema for BGP peers to allow shutdown key (https://github.com/aristanetworks/avd/pull/3100)
       ```
 
 - Copy the fragment to `changelogs/fragments_backup` *before* generating the changelog

ansible_collections/arista/avd/docs/_overrides/main.html

@@ -9,7 +9,7 @@
 {% set title = config.site_name ~ " - " ~ page.title | striptags %}
 {% endif %}
 
-{% set image = 'https://raw.githubusercontent.com/aristanetworks/ansible-avd/devel/ansible_collections/arista/avd/media/avd-logo.png' %}
+{% set image = 'https://raw.githubusercontent.com/aristanetworks/avd/devel/ansible_collections/arista/avd/media/avd-logo.png' %}
 
 <!-- Open graph meta tags -->
 <meta property="og:type" content="website" />

ansible_collections/arista/avd/docs/containers/overview.md

@@ -53,7 +53,7 @@ If you want to use a specific AVD release, use the following `devcontainer.json`
 ```json
 {
     "name": "AVD Universal",
-    "image": "ghcr.io/aristanetworks/ansible-avd/universal:python3.11-avd-v4.4.0"
+    "image": "ghcr.io/aristanetworks/avd/universal:python3.11-avd-v4.4.0"
 }
 ```
 
@@ -64,9 +64,9 @@ If you want to test specific AVD branch or fork without making any changes, use
 ```json
 {
     "name": "AVD Development",
-    "image": "ghcr.io/aristanetworks/ansible-avd/dev:python3.11",
+    "image": "ghcr.io/aristanetworks/avd/dev:python3.11",
     "containerEnv": {
-        "AVD_GITHUB_REPO": "aristanetworks/ansible-avd",
+        "AVD_GITHUB_REPO": "aristanetworks/avd",
         "AVD_BRANCH_NAME": "devel"
     },
     // Run entrypoint script manually as it's ignored by dev container CLI otherwise.

ansible_collections/arista/avd/docs/contribution/development.md

@@ -8,13 +8,13 @@
 
 ## Overview
 
-Two methods can be used to get Ansible up and running quickly with all the requirements to leverage ansible-avd: a Python Virtual Environment or a Docker container.
+Two methods can be used to get Ansible up and running quickly with all the requirements to leverage AVD: a Python Virtual Environment or a Docker container.
 
 The best way to use the development files is to copy them to the root directory where your repositories are cloned. For example, see the file/folder structure below.
 
 ```shell
 ├── git_projects
-│   ├── ansible-avd
+│   ├── avd
 │   ├── ansible-cvp
 │   ├── netdevops-examples
 |   ├── <YOUR OWN TESTING REPOSITORY>
@@ -44,13 +44,13 @@ Since the AVD Docker image is now automatically published on [**docker-hub**](ht
 ```shell
 # Start development stack
 $ make start
-docker-compose -f ansible-avd/development/docker-compose.yml up -d
+docker-compose -f avd/development/docker-compose.yml up -d
 Recreating development_ansible_1    ... done
 Recreating development_webdoc_cvp_1 ... done
 Recreating development_webdoc_avd_1 ... done
 
 # List containers started with stack
-$ docker-compose -f ansible-avd/development/docker-compose.yml ps
+$ docker-compose -f avd/development/docker-compose.yml ps
         Name                       Command               State           Ports
 -----------------------------------------------------------------------------
 ansible_avd   /bin/sh -c while true; do  ...   Up
@@ -59,7 +59,7 @@ webdoc_cvp    sh -c pip install -r ansib ...   Up      0.0.0.0:8001->8000/tcp
 
 # Get a shell with ansible (if not in shell from previous command)
 $ make dev-run
-docker-compose -f ansible-avd/development/docker-compose.yml exec ansible zsh
+docker-compose -f avd/development/docker-compose.yml exec ansible zsh
 Agent pid 52
 ➜  /projects
 
@@ -74,8 +74,8 @@ $ curl -s http://127.0.0.1:8000 | head -n 10
 
 # Stop development stack
 $ make dev-stop
-docker-compose -f ansible-avd/development/docker-compose.yml kill &&\
-        docker-compose -f ansible-avd/development/docker-compose.yml rm -f
+docker-compose -f avd/development/docker-compose.yml kill &&\
+        docker-compose -f avd/development/docker-compose.yml rm -f
 Killing development_ansible_1 ... done
 Killing development_webdoc_1  ... done
 Going to remove development_ansible_1, development_webdoc_1
@@ -87,7 +87,7 @@ Removing development_webdoc_1  ... done
 
 ### Pre-commit hook
 
-[pre-commit](https://github.com/aristanetworks/ansible-avd/blob/devel/.pre-commit-config.yaml) can run standard hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. Pointing these issues out before code review allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.
+[pre-commit](https://github.com/aristanetworks/avd/blob/devel/.pre-commit-config.yaml) can run standard hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. Pointing these issues out before code review allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.
 
 Repository implements the following hooks:
 
@@ -96,15 +96,15 @@ Repository implements the following hooks:
 - `check-yaml`: Checks that all YAML files are valid.
 - `check-added-large-files`: Check if no large file is included in the repository.
 - `check-merge-conflict`: Validate there is no `MERGE` syntax related to an invalid merge process.
-- `pylint`: Run Python linting with settings defined in [pylintrc](https://github.com/aristanetworks/ansible-avd/blob/devel/pylintrc).
-- `yamllint`: Validate all YAML files using configuration from [yamllintrc](https://github.com/aristanetworks/ansible-avd/blob/devel/.github/yamllintrc).
+- `pylint`: Run Python linting with settings defined in [pylintrc](https://github.com/aristanetworks/avd/blob/devel/pylintrc).
+- `yamllint`: Validate all YAML files using configuration from [yamllintrc](https://github.com/aristanetworks/avd/blob/devel/.github/yamllintrc).
 - `ansible-lint`: Validate YAML files with Ansible proven practices, patters, and behaviors.
 - `Flake8`: Style guide enforcement for Python code base.
 - `markdownlint-cli`: Validates markdown files for common errors as referenced [here](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md).
 
 #### Installation
 
-`pre-commit` is part of [**development requirements**](https://github.com/aristanetworks/ansible-avd/blob/devel/development/requirements-dev.txt). To install, run `pip command` in **ansible-avd** folder:
+`pre-commit` is part of [**development requirements**](https://github.com/aristanetworks/avd/blob/devel/development/requirements-dev.txt). To install, run `pip command` in **avd** folder:
 
 ```shell
 $ pip install -r development/requirements-dev.txt

ansible_collections/arista/avd/docs/contribution/getting-started.md

@@ -13,7 +13,7 @@
 
 ## Pull requests
 
-- **Before** you start working on a pull request, open an issue and discuss your ideas with the **ansible-avd** maintainers. This will help prevent wasting time on something we might be unable to implement. When suggesting a new feature, ensure it will be consistent with all work already in progress.
+- **Before** you start working on a pull request, open an issue and discuss your ideas with the **AVD** maintainers. This will help prevent wasting time on something we might be unable to implement. When suggesting a new feature, ensure it will be consistent with all work already in progress.
 
 - Any pull request which *doesn't* relate to an accepted issue will not be approved.
 
@@ -34,13 +34,13 @@ Adhering to the following process is the best way to get your work merged:
 
   ```bash
   # Clone your fork of the repo into the current directory
-  git clone https://github.com/<your-username>/ansible-avd
+  git clone https://github.com/<your-username>/avd
 
   # Navigate to the newly cloned directory
-  cd ansible-avd
+  cd avd
 
   # Assign the original repo to a remote called "upstream"
-  git remote add upstream https://github.com/aristanetworks/ansible-avd.git
+  git remote add upstream https://github.com/aristanetworks/avd.git
   ```
 
 - If you cloned a while ago, get the latest changes from upstream:
@@ -70,4 +70,4 @@ Adhering to the following process is the best way to get your work merged:
   git push origin <topic-branch-name>
   ```
 
-- [Open a Pull Request](https://github.com/aristanetworks/ansible-avd/pulls) with a clear title, description, and following the template.
+- [Open a Pull Request](https://github.com/aristanetworks/avd/pulls) with a clear title, description, and following the template.