Merge pull request #5 from Tompage1994/devel

Adds Table of Contents
redhat-cop · Apr 9, 2024 · 7bd0469 · 7bd0469
2 parents f6b387d + ea541f5
commit 7bd0469
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 201 deletions.
diff --git a/.github/collection_index.md.j2 b/.github/collection_index.md.j2
@@ -0,0 +1,7 @@
+---
+layout: default
+title: {{ collection_name }}
+has_children: true
+---
+
+# {{ collection_name }}
diff --git a/.github/fix_readme.yml b/.github/fix_readme.yml
@@ -6,7 +6,7 @@
 
 - name: Get collections
   ansible.builtin.find:
-    path: "{{ r_tempfile.path }}/{{ outer_item}}/roles/"
+    path: "{{ r_tempfile.path }}/{{ outer_item }}/roles/"
     file_type: directory
   register: r_roles
 
@@ -38,14 +38,23 @@
     line: |
       ---
       layout: default
+      parent: {{ outer_item }}
       ---
   loop: "{{ roles_list }}"
 
 - name: Copy and rename readme
   ansible.builtin.copy:
     src: "{{ r_tempfile['path'] }}/{{ outer_item }}/roles/{{ item }}/README.md"
-    dest: "../_collections/{{ outer_item }}/{{ item }}.md"
+    dest: "../collections/{{ outer_item }}/{{ item }}.md"
     remote_src: true
     mode: "0644"
   loop: "{{ roles_list }}"
+
+- name: Create collection index page
+  ansible.builtin.template:
+    src: collection_index.md.j2
+    dest: "../collections/{{ outer_item }}/index.md"
+    mode: "0644"
+  vars:
+    collection_name: "{{ outer_item }}"
 ...
diff --git a/.github/index.md.j2 b/.github/index.md.j2
diff --git a/.github/playbook.yml b/.github/playbook.yml
@@ -6,19 +6,19 @@
   tasks:
     - name: Delete directories
       ansible.builtin.file:
-        path: "../_collections"
+        path: "../collections"
         state: absent
         mode: "0755"
 
-    - name: Create _collections directory
+    - name: Create collections directory
       ansible.builtin.file:
-        path: "../_collections"
+        path: "../collections"
         state: directory
         mode: "0755"
 
     - name: Create sub directories
       ansible.builtin.file:
-        path: "../_collections/{{ item }}"
+        path: "../collections/{{ item }}"
         state: directory
         mode: "0755"
       loop:
@@ -100,7 +100,7 @@
 
     - name: Get list of files controller_config
       ansible.builtin.find:
-        path: ../_collections/controller_configuration
+        path: ../collections/controller_configuration
         file_type: file
         patterns: '*.md'
       register: r_controller_config
@@ -112,7 +112,7 @@
 
     - name: Get list of files galaxy_collection
       ansible.builtin.find:
-        path: ../_collections/galaxy_collection
+        path: ../collections/galaxy_collection
         file_type: file
         patterns: '*.md'
       register: r_galaxy_collection
@@ -124,7 +124,7 @@
 
     - name: Get list of files eda_config
       ansible.builtin.find:
-        path: ../_collections/eda_configuration
+        path: ../collections/eda_configuration
         file_type: file
         patterns: '*.md'
       register: r_eda_config
@@ -136,7 +136,7 @@
 
     - name: Get list of files aap_utilities
       ansible.builtin.find:
-        path: ../_collections/aap_utilities
+        path: ../collections/aap_utilities
         file_type: file
         patterns: '*.md'
       register: r_aap_utilities
@@ -148,7 +148,7 @@
 
     - name: Get list of files ee_utilities
       ansible.builtin.find:
-        path: ../_collections/ee_utilities
+        path: ../collections/ee_utilities
         file_type: file
         patterns: '*.md'
       register: r_ee_utilities
@@ -157,10 +157,4 @@
       ansible.builtin.set_fact:
         ee_utilities: "{{ ee_utilities | default([]) + [item | ansible.builtin.basename] }}"
       loop: "{{ r_ee_utilities['files'] | map(attribute='path') | flatten }}"
-
-    - name: Generate index template
-      ansible.builtin.template:
-        src: index.md.j2
-        dest: ../index.md
-        mode: "0644"
 ...
diff --git a/index.md b/index.md
@@ -1,5 +1,7 @@
 ---
-
+layout: default
+title: Home
+nav_order: 1
 ---
 
 # Ansible Automation Platform Configuration as Code Collections
@@ -27,104 +29,19 @@ Links to Ansible Automation Platform Collections
 
 |Collection Name|Purpose|
 |---------|---------|
-|[awx.awx/Ansible.controller repo](https://github.com/ansible/awx/tree/devel/awx_collection)|Automation controller modules|
-|[Ansible Hub Configuration](https://github.com/ansible/automation_hub_collection)|Automation hub configuration|
+|[awx.awx/Ansible.controller repo](https://github.com/ansible/awx/tree/devel/awx_collection)|Automation Controller modules|
+|[Ansible Hub Configuration](https://github.com/ansible/automation_hub_collection)|Automation Hub configuration|
 
 Links to other Validated Configuration Collections for Ansible Automation Platform
 
 |Collection Name|Purpose|
 |---------|---------|
-|[Controller Configuration](https://github.com/redhat-cop/controller_configuration)|Automation controller configuration|
+|[Controller Configuration](https://github.com/redhat-cop/controller_configuration)|Automation Controller configuration|
+|[EDA Configuration](https://github.com/redhat-cop/eda_configuration)|Event-Driven Ansible Controller configuration|
 |[EE Utilities](https://github.com/redhat-cop/ee_utilities)|Execution Environment creation utilities|
 |[AAP installation Utilities](https://github.com/redhat-cop/aap_utilities)|Ansible Automation Platform Utilities|
 |[AAP Configuration Template](https://github.com/redhat-cop/aap_configuration_template)|Configuration Template for this suite|
 
-### Controller Configuration:
-* [ad_hoc_command](collections/controller_configuration/ad_hoc_command.html)
-* [ad_hoc_command_cancel](collections/controller_configuration/ad_hoc_command_cancel.html)
-* [applications](collections/controller_configuration/applications.html)
-* [bulk_host_create](collections/controller_configuration/bulk_host_create.html)
-* [bulk_job_launch](collections/controller_configuration/bulk_job_launch.html)
-* [credential_input_sources](collections/controller_configuration/credential_input_sources.html)
-* [credential_types](collections/controller_configuration/credential_types.html)
-* [credentials](collections/controller_configuration/credentials.html)
-* [dispatch](collections/controller_configuration/dispatch.html)
-* [execution_environments](collections/controller_configuration/execution_environments.html)
-* [filetree_create](collections/controller_configuration/filetree_create.html)
-* [filetree_read](collections/controller_configuration/filetree_read.html)
-* [global_vars](collections/controller_configuration/global_vars.html)
-* [groups](collections/controller_configuration/groups.html)
-* [hosts](collections/controller_configuration/hosts.html)
-* [instance_groups](collections/controller_configuration/instance_groups.html)
-* [instances](collections/controller_configuration/instances.html)
-* [inventories](collections/controller_configuration/inventories.html)
-* [inventory_source_update](collections/controller_configuration/inventory_source_update.html)
-* [inventory_sources](collections/controller_configuration/inventory_sources.html)
-* [job_launch](collections/controller_configuration/job_launch.html)
-* [job_templates](collections/controller_configuration/job_templates.html)
-* [jobs_cancel](collections/controller_configuration/jobs_cancel.html)
-* [labels](collections/controller_configuration/labels.html)
-* [license](collections/controller_configuration/license.html)
-* [notification_templates](collections/controller_configuration/notification_templates.html)
-* [object_diff](collections/controller_configuration/object_diff.html)
-* [organizations](collections/controller_configuration/organizations.html)
-* [project_update](collections/controller_configuration/project_update.html)
-* [projects](collections/controller_configuration/projects.html)
-* [roles](collections/controller_configuration/roles.html)
-* [schedules](collections/controller_configuration/schedules.html)
-* [settings](collections/controller_configuration/settings.html)
-* [teams](collections/controller_configuration/teams.html)
-* [users](collections/controller_configuration/users.html)
-* [workflow_job_templates](collections/controller_configuration/workflow_job_templates.html)
-* [workflow_launch](collections/controller_configuration/workflow_launch.html)
-
-### Ansible Hub Configuration:
-* [ansible_config](collections/galaxy_collection/ansible_config.html)
-* [collection](collections/galaxy_collection/collection.html)
-* [collection_remote](collections/galaxy_collection/collection_remote.html)
-* [collection_repository](collections/galaxy_collection/collection_repository.html)
-* [collection_repository_sync](collections/galaxy_collection/collection_repository_sync.html)
-* [dispatch](collections/galaxy_collection/dispatch.html)
-* [ee_image](collections/galaxy_collection/ee_image.html)
-* [ee_namespace](collections/galaxy_collection/ee_namespace.html)
-* [ee_registry](collections/galaxy_collection/ee_registry.html)
-* [ee_registry_index](collections/galaxy_collection/ee_registry_index.html)
-* [ee_registry_sync](collections/galaxy_collection/ee_registry_sync.html)
-* [ee_repository](collections/galaxy_collection/ee_repository.html)
-* [ee_repository_sync](collections/galaxy_collection/ee_repository_sync.html)
-* [group](collections/galaxy_collection/group.html)
-* [group_roles](collections/galaxy_collection/group_roles.html)
-* [namespace](collections/galaxy_collection/namespace.html)
-* [publish](collections/galaxy_collection/publish.html)
-* [repository](collections/galaxy_collection/repository.html)
-* [repository_sync](collections/galaxy_collection/repository_sync.html)
-* [role](collections/galaxy_collection/role.html)
-* [user](collections/galaxy_collection/user.html)
-
-### Event Driven Ansible Configuration:
-* [credential](collections/eda_config/credential.html)
-* [decision_environment](collections/eda_config/decision_environment.html)
-* [project](collections/eda_config/project.html)
-* [project_sync](collections/eda_config/project_sync.html)
-* [rulebook_activation](collections/eda_config/rulebook_activation.html)
-* [user_token](collections/eda_config/user_token.html)
-
-### AAP Installation Utilities:
-* [aap_backup](collections/aap_utilities/aap_backup.html)
-* [aap_certs](collections/aap_utilities/aap_certs.html)
-* [aap_ocp_install](collections/aap_utilities/aap_ocp_install.html)
-* [aap_remove](collections/aap_utilities/aap_remove.html)
-* [aap_restore](collections/aap_utilities/aap_restore.html)
-* [aap_setup_download](collections/aap_utilities/aap_setup_download.html)
-* [aap_setup_install](collections/aap_utilities/aap_setup_install.html)
-* [aap_setup_prepare](collections/aap_utilities/aap_setup_prepare.html)
-* [git_ssh_setup](collections/aap_utilities/git_ssh_setup.html)
-* [kerberos](collections/aap_utilities/kerberos.html)
-
-### Execution Environment Utilities:
-* [ee_builder](collections/ee_utilities/ee_builder.html)
-* [virtualenv_migrate](collections/ee_utilities/virtualenv_migrate.html)
-
 ## Contributing to this Documentation
 We welcome community contributions to this documentation, or any of the mentioned collections. If you find problems, please open an issue and consider creating a PR against this, or any relevant, repository. More information about contributing can be found in our [Contribution Guidelines](CONTRIBUTE.html).