Fix role naming conventions in the README files to be consistent with…

… the ansible-role-template https://github.com/CyVerse-Ansible/ansible-role-template/blob/master/README.md Signed-off-by: Danielle Barda <dbarda@redhat.com>
redhat-cop · Aug 18, 2024 · c36f204 · c36f204
1 parent b2ba96d
commit c36f204
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 8 deletions.
diff --git a/changelogs/fragments/92_issue_fixes.yml b/changelogs/fragments/92_issue_fixes.yml
@@ -0,0 +1,3 @@
+minor_changes:
+  - Fix role names in the README files to be consistent with the ansible-role-template
+  - Fix the example of guest_os in provision_vm README role to use RHEL guest OS
diff --git a/roles/cluster_settings/README.md b/roles/cluster_settings/README.md
@@ -1,4 +1,4 @@
-# Cluster settings role
+# cluster_settings
 
 A role to define cluster settings in vCenter.
 

diff --git a/roles/content_library/README.md b/roles/content_library/README.md
@@ -1,4 +1,4 @@
-# Content Library Role
+# content_library
 
 A role to manage VMWare content libaries. You can create or delete both local and subscribed content libraries.
 

diff --git a/roles/deploy_ovf/README.md b/roles/deploy_ovf/README.md
@@ -1,4 +1,4 @@
-# Deploy OVF role
+# deploy_ovf
 
 A role to deploy a VM from an OVF file. The OVF can be located on the `ansible_host` filesystem, at a URL, or located in a content library.
 

diff --git a/roles/export_vm_as_ovf/README.md b/roles/export_vm_as_ovf/README.md
@@ -1,4 +1,4 @@
-# Export VM As OVF Role
+# export_vm_as_ovf
 
 A role to export a VM from VCenter or ESXi as an OVF. The VM is exported to the local filesystem of the host running the tasks (anisble_host).
 

diff --git a/roles/info/README.md b/roles/info/README.md
@@ -1,4 +1,4 @@
-# Gather information from vcenter 
+# info
 
 A role that gather information from vcenter.
 

diff --git a/roles/manage_folder/README.md b/roles/manage_folder/README.md
@@ -1,4 +1,4 @@
-# Manage Folder Role
+# manage_folder
 
 A role to create, delete, or update a folder or folder tree in VCenter.
 

diff --git a/roles/provision_vm/README.md b/roles/provision_vm/README.md
@@ -1,4 +1,4 @@
-# Provision virtual machine
+# provision_vm
 A role to provision a virtual machine, create associated resources if they don't exist (subnets, vCPU, memory configuration, storage configuration, etc)
 This includes cloning and building from VM templates.
 

diff --git a/roles/system_settings/README.md b/roles/system_settings/README.md
@@ -1,4 +1,4 @@
-# System settings role
+# system_settings
 
 A role to define system settings for vCenter.