Merge pull request #1806 from qahmed1998/QA-major-update-toc

Updated ToC for entire ManageIQ + added already existing topics within ToC
ManageIQ · Sep 11, 2024 · 4eda9ef · 4eda9ef
2 parents 1dd3160 + 2557ad9
commit 4eda9ef
Showing 1 changed file with 114 additions and 98 deletions.
diff --git a/_data/site_menu.yml b/_data/site_menu.yml
@@ -1,77 +1,56 @@
 ---
 
-installation:
- title: Installation
+installing:
+ title: Installing
  children:
- - title: Amazon Web Services (AWS)
- path: "/docs/reference/latest/installing_on_aws/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)"
- - title: Kubernetes
- path: "/docs/reference/latest/installing_on_kubernetes/index.html"
- desc: "How to install and configure ManageIQ on Kubernetes"
- - title: IBM Cloud
- path: "/docs/reference/latest/installing_on_ibm_cloud/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud"
- - title: Microsoft Azure
- path: "/docs/reference/latest/installing_on_microsoft_azure/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure"
- - title: Google Compute Engine
- path: "/docs/reference/latest/installing_on_google_compute_engine/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine"
- - title: VMware vSphere
- path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere"
- - title: Red Hat Enterprise OpenStack Platform
- path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform"
- - title: Red Hat Enterprise Virtualization
- path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization"
- - title: Microsoft System Center Virtual Machine Manager (SCVMM)
- path: "/docs/reference/latest/installing_on_scvmm/index.html"
- desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)"
-
-appliances:
- title: Appliances
+ - title: Containerized (podified)
+ children:
+ - title: Kubernetes
+ path: "/docs/reference/latest/installing_on_kubernetes/index.html"
+ desc: "How to install and configure ManageIQ on Kubernetes"
+ - title: Appliance
+ children:
+ - title: Amazon Web Services (AWS)
+ path: "/docs/reference/latest/installing_on_aws/index.html"
+ desc: "How to install and configure the ManageIQ on Amazon Web Services (AWS)"
+ - title: IBM Cloud
+ path: "/docs/reference/latest/installing_on_ibm_cloud/index.html"
+ desc: "How to install and configure the ManageIQ on IBM Cloud"
+ - title: Microsoft Azure
+ path: "/docs/reference/latest/installing_on_microsoft_azure/index.html"
+ desc: "How to install and configure the ManageIQ on Microsoft Azure"
+ - title: Google Compute Engine
+ path: "/docs/reference/latest/installing_on_google_compute_engine/index.html"
+ desc: "How to install and configure the ManageIQ on Google Compute Engine"
+ - title: VMware vSphere
+ path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html"
+ desc: "How to install and configure the ManageIQ on VMware vSphere"
+ - title: Red Hat Enterprise OpenStack Platform
+ path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
+ desc: "How to install and configure the ManageIQ on Red Hat OpenStack Platform"
+ - title: Red Hat Enterprise Virtualization
+ path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html"
+ desc: "How to install and configure the ManageIQ on Red Hat Enterprise Virtualization"
+ - title: Microsoft System Center Virtual Machine Manager (SCVMM)
+ path: "/docs/reference/latest/installing_on_scvmm/index.html"
+ desc: "How to install and configure the ManageIQ on Microsoft System Center Virtual Machine Manager (SCVMM)"
+
+upgrading:
+ title: Upgrading
  children:
- - title: Backup and Restore
- path: "/docs/reference/latest/appliances/backup_and_restore.html"
- desc: "How to backup and restore appliances"
  - title: Upgrading
  path: "/docs/reference/latest/appliances/upgrading.html"
  desc: "How to upgrade appliances"
 
-configuration:
- title: Configuration
+using:
+ title: Using
  children:
- - title: Deployment Planning Guide
- path: "/docs/reference/latest/deployment_planning_guide/index.html"
- desc: "ManageIQ Deployment Planning Guide"
  - title: General Configuration
  path: "/docs/reference/latest/general_configuration/index.html"
  desc: "ManageIQ General Configuration"
- - title: High Availability Guide
- path: "/docs/reference/latest/high_availability_guide/index.html"
- desc: "ManageIQ High Availability Guide"
- - title: Appliance Hardening Guide
- path: "/docs/reference/latest/appliance_hardening_guide/index.html"
- desc: "ManageIQ Appliance Hardening Guide"
-
-administration:
- title: Administration
- children:
- - title: Monitoring, Alerts, and Reporting
- path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html"
- desc: "Information on the Cloud Intelligence area of ManageIQ: reporting, RSS, usage, timelines, and chargeback"
-
- - title: Policies and Profiles Guide
- path: "/docs/reference/latest/policies_and_profiles_guide/index.html"
- desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ
-
  - title: Managing Infrastructure and Inventory
  path: "/docs/reference/latest/managing_infrastructure_and_inventory/index.html"
  desc: "Viewing and collecting information from your clusters, hosts, virtual machines, and other resources"
-
  - title: Managing Providers
  children:
  - title: Overview
@@ -109,6 +88,10 @@ administration:
  path: "/docs/reference/latest/managing_providers/configuration_management_providers/red_hat_satellite_6.html"
  desc: "Managing Red Hat Satellite 6 Providers"
 
+ - title: Automation Management Providers
+ path: "/docs/reference/latest/managing_providers/index.html#automation-management-provider"
+ desc: "Management tool to simplify automation operators for resources"
+
  - title: Cloud Providers
  children:
  - title: Azure Providers
@@ -178,66 +161,99 @@ administration:
  - title: IBM Cloud Object Storage Providers
  path: "/docs/reference/latest/managing_providers/storage_providers/ibm_cloud_object_storage_managers.html"
  desc: "Managing IBM Cloud Object Storage Providers"
-
  - title: Provisioning Virtual Machines and Hosts
  path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html"
  desc: "Provisioning, workload management, and orchestration in ManageIQ"
-
+ - title: Creating a Service for Virtual Machine Provisioning
+ path: "/docs/reference/latest/creating_a_service_for_vm_provisioning/index.html"
+ desc: "How to create a service for virtual machine provisioning"
+ - title: Service Provisioning Using an Orchestration Template
+ path: "/docs/reference/latest/service_provisioning_using_an_orchestration_template/index.html"
+ desc: "How to create an orchestration template to deploy services"
+ - title: Managing controls
+ children:
+ - title: Monitoring, Alerts, and Reporting
+ path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html"
+ desc: "Information on the Cloud Intelligence area of ManageIQ: dashboards, widgets, reporting, chargeback, optimization, and alerts"
+ - title: Policies and Profiles Guide
+ path: "/docs/reference/latest/policies_and_profiles_guide/index.html"
+ desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ
+ - title: Chargeback
+ path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html#chargeback"
+ desc: Calculate monetary virtual machine charges based on owner or company tag
+ - title: Assigning a Custom Analysis Profile to a Virtual Machine
+ path: "/docs/reference/latest/assigning_custom_analysis_profile_to_vm/index.html"
+ desc: "How to assign custom analysis profile to a virtual machine"
  - title: Scripting Actions in ManageIQ
  path: "/docs/reference/latest/scripting_actions/index.html"
- desc: "Real-time, bi-directional process integration for ManageIQ Management Engine"
+ desc: "Real-time, bi-directional process integration for ManageIQ"
 
-troubleshooting:
- title: Troubleshooting
+administration:
+ title: Administering {{ site.data.product.title_short }}
  children:
- - title: Troubleshooting
- path: "/docs/reference/latest/troubleshooting/index.html"
- desc: "How to troubleshoot issues"
+ - title: Managing Authentication for {{ site.data.product.title_short }}
+ children:
+ - title: Active Directory
+ path: "/docs/reference/latest/auth/active_directory.html"
+ desc: "How to manually configure an Appliance’s external authentication to work against Active Directory."
+ - title: 2-Factor-Authentication with IPA
+ path: "/docs/reference/latest/auth/ipa_2fa.html"
+ desc: "How to manually configure an Appliance’s external authentication to work with 2-Factor Authentication with IPA."
+ - title: IPA/AD Trust
+ path: "/docs/reference/latest/auth/ipa_ad_trust.html"
+ desc: "How to manually configure an Appliance’s external authentication to work with AD Trust Authentication using IPA."
+ - title: LDAP
+ path: "/docs/reference/latest/auth/ldap.html"
+ desc: "How to manually configure an Appliance’s external authentication to work against LDAP."
+ - title: SAML
+ path: "/docs/reference/latest/auth/saml.html"
+ desc: "How to manually configure an Appliance’s external authentication to work with SAML."
+ - title: OpenID-Connect
+ path: "/docs/reference/latest/auth/openid_connect.html"
+ desc: "How to manually configure an Appliance’s external authentication to work with OIDC."
+ - title: Backup and Restore (appliances)
+ path: "/docs/reference/latest/appliances/backup_and_restore.html"
+ desc: "How to backup and restore appliances"
+ - title: Deployment Planning Guide
+ path: "/docs/reference/latest/deployment_planning_guide/index.html"
+ desc: "ManageIQ Deployment Planning Guide"
+ - title: High Availability Guide
+ path: "/docs/reference/latest/high_availability_guide/index.html"
+ desc: "ManageIQ High Availability Guide"
+ - title: Appliance Hardening Guide
+ path: "/docs/reference/latest/appliance_hardening_guide/index.html"
+ desc: "ManageIQ Appliance Hardening Guide"
 
-authentication:
- title: Authentication
- children:
- - title: Active Directory
- path: "/docs/reference/latest/auth/active_directory.html"
- desc: "How to manually configure an Appliance’s external authentication to work against Active Directory."
- - title: 2-Factor-Authentication with IPA
- path: "/docs/reference/latest/auth/ipa_2fa.html"
- desc: "How to manually configure an Appliance’s external authentication to work with 2-Factor Authentication with IPA."
- - title: IPA/AD Trust
- path: "/docs/reference/latest/auth/ipa_ad_trust.html"
- desc: "How to manually configure an Appliance’s external authentication to work with AD Trust Authentication using IPA."
- - title: LDAP
- path: "/docs/reference/latest/auth/ldap.html"
- desc: "How to manually configure an Appliance’s external authentication to work against LDAP."
- - title: SAML
- path: "/docs/reference/latest/auth/saml.html"
- desc: "How to manually configure an Appliance’s external authentication to work with SAML."
- - title: OpenID-Connect
- path: "/docs/reference/latest/auth/openid_connect.html"
- desc: "How to manually configure an Appliance’s external authentication to work with OIDC."
-
-integration:
- title: Integration
+Defining integrations:
+ title: Managing Integrations
  children:
  - title: AWS CloudFormation and OpenStack Heat
  path: "/docs/reference/latest/integration_with_aws_cloudformation_and_openstack_heat/index.html"
  desc: "How to install and configure Amazon CloudFormation and OpenStack Heat in a Red Hat ManageIQ environment"
-
  - title: ServiceNow
  path: "/docs/reference/latest/integration_with_servicenow/index.html"
  desc: A short guide to managing ManageIQ ServiceNow CMDB integration
 
+apis:
+ title: APIs
+ children:
+ - title: ManageIQ REST API
+ path: "/docs/api"
+ desc: REST API reference
+
 reference:
  title: Reference
  children:
  - title: Capabilities Matrix
  path: "/docs/reference/latest/capabilities_matrix/index.html"
  desc: Capabilities across Providers
-
- - title: ManageIQ REST API
- path: "/docs/api"
- desc: REST API reference
-
  - title: Methods Available for Automation
  path: "/docs/reference/latest/methods_available_for_automation/index.html"
- desc: Advanced automation methods for ManageIQ Management Engine
+ desc: Advanced automation methods for ManageIQ
+
+troubleshooting:
+ title: Troubleshooting
+ children:
+ - title: Troubleshooting
+ path: "/docs/reference/latest/troubleshooting/index.html"
+ desc: "How to troubleshoot issues"