Doc: Add CV Pathfinder AVD example

.github/workflows/pull-request-management.yml

@@ -215,6 +215,7 @@ jobs:
           - 'example-isis-ldp-ipvpn'
           - 'example-l2ls-fabric'
           - 'example-single-dc-l3ls'
+          - 'example-cv-pathfinder'
         ansible_version:
           # Testing all scenario with 2.16.x, due to bug with in 2.17.0 with and the way we test eos_designs_negative_unit_tests https://github.com/ansible/ansible/issues/83292
           - 'ansible-core>=2.16.0,<2.17.0 --upgrade'

ansible_collections/arista/avd/examples/campus-fabric/README.md

@@ -16,31 +16,9 @@ This example describes and includes all the AVD files used to build a Campus Fab
 
 ## Installation & Requirements
 
-1. Install AVD - Installation guide found [here](../../docs/installation/collection-installation.md).
-2. Install Ansible module requirements - Instructions found [here](../../docs/installation/collection-installation.md).
-3. Run the following playbook to copy the Getting Started examples to your working directory.
-
-``` bash
-# current working directory: ~/ansible-avd-examples
-ansible-playbook arista.avd.install_examples
-```
-
-The output will show something similar to the following. If not, please ensure that AVD and all requirements are correctly installed.
-
-``` shell
- ~/ansible-avd-examples# ansible-playbook arista.avd.install_examples
-
-PLAY [Install Examples]***************************************************************************************************************************************************************************************************************************************************************
-
-TASK [Copy all examples to ~/ansible-avd-examples]*****************************************************************************************************************************************************
-changed: [localhost]
-
-PLAY RECAP
-****************************************************************************************************************************************************************************************************************************************************************************
-localhost                  : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-```
-
-After the playbook has run successfully, the following directory structure will be created.
+--8<--
+examples/common/installation.md
+--8<--
 
 ``` shell
 ansible-avd-examples/     (directory where playbook was run)
@@ -57,10 +35,6 @@ ansible-avd-examples/     (directory where playbook was run)
     └── README.md (this document)
 ```
 
-???+ info
-
-    If the content of any file in the example is ***modified*** and the playbook is run again, the file ***will not*** be overwritten. However, if any file in the example is ***deleted*** and the playbook is run again, the file will be re-created.
-
 ## Design Overview
 
 ### Physical Campus Fabric Topology

ansible_collections/arista/avd/examples/common/installation.md

@@ -0,0 +1,34 @@
+<!--
+  ~ Copyright (c) 2024 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+Requirements to use this example:
+
+- Follow the [installation guide](../../docs/installation/collection-installation.md) for AVD
+- Run the following playbook to copy the AVD **examples** to your current working directory, for example `ansible-avd-examples`:
+
+```shell
+ansible-playbook arista.avd.install_examples
+```
+
+This will show the following:
+
+```shell
+ ~/ansible-avd-examples# ansible-playbook arista.avd.install_examples
+
+PLAY [Install Examples]**********************************************************************************************
+
+TASK [Copy all examples to ~/ansible-avd-examples]*******************************************************************
+changed: [localhost]
+
+PLAY RECAP
+*********************************************************************************************************************
+localhost                  : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
+```
+
+!!! info
+    If the content of any file is ***modified*** and the playbook is rerun, the file ***will not*** be overwritten. However, if any file in the example is ***deleted*** and the playbook is rerun, Ansible will re-create the file.
+
+After the playbook has run successfully, the directory structure of the example should look like below, the contents of which will be covered in later sections:

ansible_collections/arista/avd/examples/cv-pathfinder/.vault

@@ -0,0 +1 @@
+ThisShouldNeverBeCommitedToGitButThisIsAnExample