Doc: Move docs folder to root of repo (#4923)

Co-authored-by: Guillaume Mulocher <[email protected]>
aristanetworks · Jan 24, 2025 · 11b7a06 · 11b7a06
1 parent 6fa781b
commit 11b7a06
Show file tree

Hide file tree

Showing 206 changed files with 580 additions and 542 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -64,7 +64,7 @@ body:
     id: terms
     attributes:
       label: Contributing Guide
-      description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.sh/en/latest/docs/contribution/overview.html)
+      description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.arista.com/devel/docs/contribution/overview.html)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -71,7 +71,7 @@ body:
     id: terms
     attributes:
       label: Contributing Guide
-      description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.sh/en/latest/docs/contribution/overview.html)
+      description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.arista.com/devel/docs/contribution/overview.html)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -30,6 +30,6 @@ Fixes #<ISSUE ID>
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
 - [ ] 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.
+- [ ] I have read the [**CONTRIBUTING**](https://avd.arista.com/devel/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/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)
diff --git a/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md b/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md
@@ -10,7 +10,7 @@
   - README.md is most complete with all keys. README_v4.0 includes partial data models after conversion to lists.
   - Schema fragment path is `roles/eos_cli_config_gen/schemas/schema_fragments/<data_model_key>.schema.yml`.
   - Copy line 1-5 from another schema (comments and outer type:dict).
-  - Refer to [schema documentation](https://avd.sh/en/devel/docs/input-variable-validation.html) for syntax and/or use YAML Lint plugin from Redhat in VSCode.
+  - Refer to [schema documentation](https://avd.arista.com/devel/docs/contribution/input-variable-validation.html) for syntax and/or use YAML Lint plugin from Redhat in VSCode.
   - Use `convert_types` on value that could be mixed type or misinterpreted like integers and numeric strings.
 - [ ] If the data model has been converted from wildcard dicts:
   - Add `convert_types: ['dict']` to the schema.

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -30,6 +30,6 @@ Fixes #<ISSUE ID>
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
 - [ ] 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.
+- [ ] I have read the [**CONTRIBUTING**](https://avd.arista.com/stable/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/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -139,7 +139,7 @@ repos:
             python-avd/pyavd/.*/schema/.*schema\.yml| # Exclude YAML schemas file
             python-avd/pyavd/_cv/api/.*| # Exclude auto generated files for CV API
             python-avd/pyavd/_cv/extra_cv_protos/.*| # Exclude extra CV proto files
-            ansible-avd/ansible_collections/arista/avd/docs/plugins/.* | # Excluded auto generated doc for Ansible plugins
+            docs/plugins/.* | # Excluded auto generated doc for Ansible plugins
           )$
 
   - repo: local
@@ -148,8 +148,8 @@ repos:
       - id: docs-plugin-modules
         name: Build documentation for collection modules and action plugins.
         entry: >-
-          ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2
-          --markdown "ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/"
+          ansible-doc-extractor --template docs/templates/plugin-docs.j2
+          --markdown "docs/plugins/Modules_and_action_plugins/"
         language: python
         types: [python]
         additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
@@ -158,8 +158,8 @@ repos:
       - id: docs-plugin-filter
         name: Build documentation for collection filter plugins.
         entry: >-
-          ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2
-          --markdown "ansible_collections/arista/avd/docs/plugins/Filter_plugins/"
+          ansible-doc-extractor --template docs/templates/plugin-docs.j2
+          --markdown "docs/plugins/Filter_plugins/"
         language: python
         types_or: [python, yaml]
         additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
@@ -169,8 +169,8 @@ repos:
       - id: docs-plugin-lookup
         name: Build documentation for collection lookup plugins.
         entry: >-
-          ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2
-          --markdown "ansible_collections/arista/avd/docs/plugins/Lookup_plugins/"
+          ansible-doc-extractor --template docs/templates/plugin-docs.j2
+          --markdown "docs/plugins/Lookup_plugins/"
         language: python
         types: [python]
         additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
@@ -179,8 +179,8 @@ repos:
       - id: docs-plugin-test
         name: Build documentation for collection test plugins.
         entry: >-
-          ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2
-          --markdown "ansible_collections/arista/avd/docs/plugins/Test_plugins/"
+          ansible-doc-extractor --template docs/templates/plugin-docs.j2
+          --markdown "docs/plugins/Test_plugins/"
         language: python
         types: [python]
         additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
@@ -189,8 +189,8 @@ repos:
       - id: docs-plugin-vars
         name: Build documentation for collection var plugins.
         entry: >-
-          ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2
-          --markdown "ansible_collections/arista/avd/docs/plugins/Vars_plugins/"
+          ansible-doc-extractor --template docs/templates/plugin-docs.j2
+          --markdown "docs/plugins/Vars_plugins/"
         language: python
         types: [python]
         additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']

diff --git a/ansible_collections/arista/avd/CNAME b/ansible_collections/arista/avd/CNAME
@@ -1 +1 @@
-www.avd.sh
+avd.arista.com
diff --git a/ansible_collections/arista/avd/docs/requirements.txt b/ansible_collections/arista/avd/docs/requirements.txt
@@ -1,6 +1,7 @@
 mkdocs
 mkdocs-material<10
 mkdocs-material-extensions
+mkdocs-same-dir
 pymdown-extensions
 mdx_truly_sane_lists
 mike==1.1.2

diff --git a/ansible_collections/arista/avd/examples/campus-fabric/README.md b/ansible_collections/arista/avd/examples/campus-fabric/README.md
@@ -17,7 +17,7 @@ This example describes and includes all the AVD files used to build a Campus Fab
 ## Installation & Requirements
 
 --8<--
-examples/common/installation.md
+ansible_collections/arista/avd/examples/common/example-installation.md
 --8<--
 
 ``` shell
@@ -69,7 +69,7 @@ Below is the basic configuration file for SPINE1:
 
 ``` shell
 --8<--
-examples/campus-fabric/switch-basic-configurations/SPINE1.cfg
+ansible_collections/arista/avd/examples/campus-fabric/switch-basic-configurations/SPINE1.cfg
 --8<--
 ```
 
@@ -106,7 +106,7 @@ If DNS is unavailable, define the variable ansible_host as an IP address for eac
 
 ``` yaml
 --8<--
-examples/campus-fabric/inventory.yml
+ansible_collections/arista/avd/examples/campus-fabric/inventory.yml
 --8<--
 ```
 
@@ -172,7 +172,7 @@ The tabs below show the Ansible **group_vars** used in this example.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1.yml
     --8<--
     ```
 
@@ -185,7 +185,7 @@ The tabs below show the Ansible **group_vars** used in this example.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1_FABRIC.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_FABRIC.yml
     --8<--
     ```
 
@@ -194,7 +194,7 @@ The tabs below show the Ansible **group_vars** used in this example.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1_SPINES.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_SPINES.yml
     --8<--
     ```
 
@@ -203,7 +203,7 @@ The tabs below show the Ansible **group_vars** used in this example.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1_LEAFS.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_LEAFS.yml
     --8<--
     ```
 
@@ -212,16 +212,16 @@ The tabs below show the Ansible **group_vars** used in this example.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1_NETWORK_SERVICES.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_NETWORK_SERVICES.yml
     --8<--
     ```
 
 === "DC1_NETWORK_PORTS"
-    Our fabric would not be complete without connecting some devices to it. Therefore, we define port profiles and network port ranges in the  **group_vars/DC1_NETWORKS_PORTS.yml** file. A single port_profile may be used across several switches and port ranges. In our example, we create a port profile called `PP-DOT1X` to define generic 802.1x (NAC) settings we wish to apply to a range of ports. The `network_ports` data model defines which switches and ports to apply the port profile. This data model allows a single regex statement to define a list of switches. In addition, the variable `switch_ports` expands into a range of ports. You can view more details of the `range_expand` filter [here](../../docs/plugins/Filter_plugins/range_expand.md). These variables are applied to the spine and leaf nodes since they are a part of this inventory group.
+    Our fabric would not be complete without connecting some devices to it. Therefore, we define port profiles and network port ranges in the  **group_vars/DC1_NETWORKS_PORTS.yml** file. A single port_profile may be used across several switches and port ranges. In our example, we create a port profile called `PP-DOT1X` to define generic 802.1x (NAC) settings we wish to apply to a range of ports. The `network_ports` data model defines which switches and ports to apply the port profile. This data model allows a single regex statement to define a list of switches. In addition, the variable `switch_ports` expands into a range of ports. You can view more details of the `range_expand` filter [here](../../../../../docs/plugins/Filter_plugins/range_expand.md). These variables are applied to the spine and leaf nodes since they are a part of this inventory group.
 
     ``` yaml
     --8<--
-    examples/campus-fabric/group_vars/DC1_NETWORK_PORTS.yml
+    ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_NETWORK_PORTS.yml
     --8<--
     ```
 
@@ -276,15 +276,15 @@ Now that we have defined all of our Ansible variables (AVD inputs), it is time t
 
     ``` yaml
     --8<--
-    examples/campus-fabric/build.yml
+    ansible_collections/arista/avd/examples/campus-fabric/build.yml
     --8<--
     ```
 
 === "deploy.yml"
 
     ``` yaml
     --8<--
-    examples/campus-fabric/deploy.yml
+    ansible_collections/arista/avd/examples/campus-fabric/deploy.yml
     --8<--
     ```
 
@@ -314,79 +314,79 @@ Your configuration files should be similar to these.
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/SPINE1.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE1.cfg
     --8<--
     ```
 
 === "SPINE2"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/SPINE2.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE2.cfg
     --8<--
     ```
 
 === "LEAF1A"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF1A.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF1A.cfg
     --8<--
     ```
 
 === "LEAF1B"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF1B.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF1B.cfg
     --8<--
     ```
 
 === "LEAF2A"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF2A.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF2A.cfg
     --8<--
     ```
 
 === "LEAF3A"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF3A.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3A.cfg
     --8<--
     ```
 
 === "LEAF3B"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF3B.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3B.cfg
     --8<--
     ```
 
 === "LEAF3C"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF3C.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3C.cfg
     --8<--
     ```
 
 === "LEAF3D"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF3D.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3D.cfg
     --8<--
     ```
 
 === "LEAF3E"
 
     ``` shell
     --8<--
-    examples/campus-fabric/intended/configs/LEAF3E.cfg
+    ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3E.cfg
     --8<--
     ```
 

diff --git a/...rista/avd/examples/common/installation.md → ...d/examples/common/example-installation.md b/...rista/avd/examples/common/installation.md → ...d/examples/common/example-installation.md
@@ -6,7 +6,7 @@
 
 Requirements to use this example:
 
-- Follow the [installation guide](../../docs/installation/collection-installation.md) for AVD
+- 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