KubeVirt
/
user-guide
mirror of https://github.com/kubevirt/user-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Workaround: adding mkdocs-redirects build and redirect map to mkdocs.yml (#802) 

Signed-off-by: Andrew Burden <aburden@redhat.com>
This commit is contained in:
aburdenthehand 2024-05-29 09:32:39 +02:00 committed by GitHub
parent dde7f54b2b
commit 09bf4c8399
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 77 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -114,7 +114,7 @@ build: envvar
@echo "${GREEN}Makefile: Build mkdocs site${RESET}"
$(PYTHON) -m venv /tmp/venv
. /tmp/venv/bin/activate
$(PIP) install mkdocs mkdocs-awesome-pages-plugin mkdocs-htmlproofer-plugin mkdocs-material
$(PIP) install mkdocs mkdocs-awesome-pages-plugin mkdocs-htmlproofer-plugin mkdocs-material mkdocs-redirects
@echo
@echo '*** BEGIN cat mkdocs.yml ***'
@cat mkdocs.yml

73
_redirects
View File

@ -1,73 +0,0 @@
/operations/customize_components /cluster_admin/customize_components
/operations/installation /cluster_admin/installation
/operations/updating_and_deletion /cluster_admin/updating_and_deletion
/operations/basic_use /user_workloads/basic_use
/operations/customize_components /cluster_admin/customize_components
/operations/deploy_common_instancetypes /user_workloads/deploy_common_instancetypes
/operations/api_validation /cluster_admin/api_validation
/operations/debug /debug_virt_stack/debug
/operations/virtctl_client_tool /user_workloads/virtctl_client_tool
/operations/live_migration /compute/live_migration
/operations/hotplug_interfaces /network/hotplug_interfaces
/operations/hotplug_volumes /storage/hotplug_volumes
/operations/client_passthrough /compute/client_passthrough
/operations/snapshot_restore_api /storage/snapshot_restore_api
/operations/scheduler /cluster_admin/scheduler
/operations/hugepages /compute/hugepages
/operations/component_monitoring /user_workloads/component_monitoring
/operations/authorization /cluster_admin/authorization
/operations/annotations_and_labels /cluster_admin/annotations_and_labels
/operations/node_assignment /compute/node_assignment
/operations/node_maintenance /cluster_admin/node_maintenance
/operations/node_overcommit /compute/node_overcommit
/operations/unresponsive_nodes /cluster_admin/unresponsive_nodes
/operations/containerized_data_importer /storage/containerized_data_importer
/operations/activating_feature_gates /cluster_admin/activating_feature_gates
/operations/export_api /storage/export_api
/operations/clone_api /storage/clone_api
/operations/memory_dump /compute/memory_dump
/operations/mediated_devices_configuration /compute/mediated_devices_configuration
/operations/migration_policies /cluster_admin/migration_policies
/operations/ksm /cluster_admin/ksm
/operations/gitops /cluster_admin/gitops
/operations/operations_on_Arm64 /cluster_admin/operations_on_Arm64
/operations/feature_gate_status_on_Arm64 /cluster_admin/feature_gate_status_on_Arm64
/operations/cpu_hotplug /compute/cpu_hotplug
/operations/memory_hotplug /compute/memory_hotplug
/operations/vm_rollout_strategies /user_workloads/vm_rollout_strategies
/operations/hook-sidecar /user_workloads/hook-sidecar
/virtual_machines/virtual_machine_instances /user_workloads/virtual_machine_instances
/virtual_machines/creating_vms /user_workloads/creating_vms
/virtual_machines/lifecycle /user_workloads/lifecycle
/virtual_machines/run_strategies /compute/run_strategies
/virtual_machines/instancetypes /user_workloads/instancetypes
/virtual_machines/presets /user_workloads/presets
/virtual_machines/virtual_hardware /compute/virtual_hardware
/virtual_machines/dedicated_cpu_resources /compute/dedicated_cpu_resources
/virtual_machines/numa /compute/numa
/virtual_machines/disks_and_volumes /storage/disks_and_volumes
/virtual_machines/interfaces_and_networks /network/interfaces_and_networks
/virtual_machines/network_binding_plugins /network/network_binding_plugins
/virtual_machines/istio_service_mesh /network/istio_service_mesh
/virtual_machines/networkpolicy /network/networkpolicy
/virtual_machines/host-devices /compute/host-devices
/virtual_machines/windows_virtio_drivers /user_workloads/windows_virtio_drivers
/virtual_machines/guest_operating_system_information /user_workloads/guest_operating_system_information
/virtual_machines/guest_agent_information /user_workloads/guest_agent_information
/virtual_machines/liveness_and_readiness_probes /user_workloads/liveness_and_readiness_probes
/virtual_machines/accessing_virtual_machines /user_workloads/accessing_virtual_machines
/virtual_machines/startup_scripts /user_workloads/startup_scripts
/virtual_machines/service_objects /network/service_objects
/virtual_machines/templates /user_workloads/templates
/virtual_machines/tekton_tasks /cluster_admin/tekton_tasks
/virtual_machines/replicaset /user_workloads/replicaset
/virtual_machines/pool /user_workloads/pool
/virtual_machines/dns /network/dns
/virtual_machines/boot_from_external_source /user_workloads/boot_from_external_source
/virtual_machines/confidential_computing /cluster_admin/confidential_computing
/virtual_machines/vsock /compute/vsock
/virtual_machines/virtual_machines_on_Arm64 /cluster_admin/virtual_machines_on_Arm64
/virtual_machines/device_status_on_Arm64 /cluster_admin/device_status_on_Arm64
/virtual_machines/persistent_tpm_and_uefi_state /compute/persistent_tpm_and_uefi_state
/virtual_machines/resources_requests_and_limits /compute/resources_requests_and_limits
/virtual_machines/guestfs /storage/guestfs

75
mkdocs.yml
View File

@ -8,6 +8,81 @@ plugins:
- search:
separator: '[\s\-,:!=\[\]\(\)"/]+|\.(?!\d)'
- awesome-pages
- redirects:
redirect_maps:
'operations/customize_components.md': 'cluster_admin/customize_components.md'
'operations/installation.md': 'cluster_admin/installation.md'
'operations/updating_and_deletion.md': 'cluster_admin/updating_and_deletion.md'
'operations/basic_use.md': 'user_workloads/basic_use.md'
'operations/customize_components.md': 'cluster_admin/customize_components.md'
'operations/deploy_common_instancetypes.md': 'user_workloads/deploy_common_instancetypes.md'
'operations/api_validation.md': 'cluster_admin/api_validation.md'
'operations/debug.md': 'debug_virt_stack/debug.md'
'operations/virtctl_client_tool.md': 'user_workloads/virtctl_client_tool.md'
'operations/live_migration.md': 'compute/live_migration.md'
'operations/hotplug_interfaces.md': 'network/hotplug_interfaces.md'
'operations/hotplug_volumes.md': 'storage/hotplug_volumes.md'
'operations/client_passthrough.md': 'compute/client_passthrough.md'
'operations/snapshot_restore_api.md': 'storage/snapshot_restore_api.md'
'operations/scheduler.md': 'cluster_admin/scheduler.md'
'operations/hugepages.md': 'compute/hugepages.md'
'operations/component_monitoring.md': 'user_workloads/component_monitoring.md'
'operations/authorization.md': 'cluster_admin/authorization.md'
'operations/annotations_and_labels.md': 'cluster_admin/annotations_and_labels.md'
'operations/node_assignment.md': 'compute/node_assignment.md'
'operations/node_maintenance.md': 'cluster_admin/node_maintenance.md'
'operations/node_overcommit.md': 'compute/node_overcommit.md'
'operations/unresponsive_nodes.md': 'cluster_admin/unresponsive_nodes.md'
'operations/containerized_data_importer.md': 'storage/containerized_data_importer.md'
'operations/activating_feature_gates.md': 'cluster_admin/activating_feature_gates.md'
'operations/export_api.md': 'storage/export_api.md'
'operations/clone_api.md': 'storage/clone_api.md'
'operations/memory_dump.md': 'compute/memory_dump.md'
'operations/mediated_devices_configuration.md': 'compute/mediated_devices_configuration.md'
'operations/migration_policies.md': 'cluster_admin/migration_policies.md'
'operations/ksm.md': 'cluster_admin/ksm.md'
'operations/gitops.md': 'cluster_admin/gitops.md'
'operations/operations_on_Arm64.md': 'cluster_admin/operations_on_Arm64.md'
'operations/feature_gate_status_on_Arm64.md': 'cluster_admin/feature_gate_status_on_Arm64.md'
'operations/cpu_hotplug.md': 'compute/cpu_hotplug.md'
'operations/memory_hotplug.md': 'compute/memory_hotplug.md'
'operations/vm_rollout_strategies.md': 'user_workloads/vm_rollout_strategies.md'
'operations/hook-sidecar.md': 'user_workloads/hook-sidecar.md'
'virtual_machines/virtual_machine_instances.md': 'user_workloads/virtual_machine_instances.md'
'virtual_machines/creating_vms.md': 'user_workloads/creating_vms.md'
'virtual_machines/lifecycle.md': 'user_workloads/lifecycle.md'
'virtual_machines/run_strategies.md': 'compute/run_strategies.md'
'virtual_machines/instancetypes.md': 'user_workloads/instancetypes.md'
'virtual_machines/presets.md': 'user_workloads/presets.md'
'virtual_machines/virtual_hardware.md': 'compute/virtual_hardware.md'
'virtual_machines/dedicated_cpu_resources.md': 'compute/dedicated_cpu_resources.md'
'virtual_machines/numa.md': 'compute/numa.md'
'virtual_machines/disks_and_volumes.md': 'storage/disks_and_volumes.md'
'virtual_machines/interfaces_and_networks.md': 'network/interfaces_and_networks.md'
'virtual_machines/network_binding_plugins.md': 'network/network_binding_plugins.md'
'virtual_machines/istio_service_mesh.md': 'network/istio_service_mesh.md'
'virtual_machines/networkpolicy.md': 'network/networkpolicy.md'
'virtual_machines/host-devices.md': 'compute/host-devices.md'
'virtual_machines/windows_virtio_drivers.md': 'user_workloads/windows_virtio_drivers.md'
'virtual_machines/guest_operating_system_information.md': 'user_workloads/guest_operating_system_information.md'
'virtual_machines/guest_agent_information.md': 'user_workloads/guest_agent_information.md'
'virtual_machines/liveness_and_readiness_probes.md': 'user_workloads/liveness_and_readiness_probes.md'
'virtual_machines/accessing_virtual_machines.md': 'user_workloads/accessing_virtual_machines.md'
'virtual_machines/startup_scripts.md': 'user_workloads/startup_scripts.md'
'virtual_machines/service_objects.md': 'network/service_objects.md'
'virtual_machines/templates.md': 'user_workloads/templates.md'
'virtual_machines/tekton_tasks.md': 'cluster_admin/tekton_tasks.md'
'virtual_machines/replicaset.md': 'user_workloads/replicaset.md'
'virtual_machines/pool.md': 'user_workloads/pool.md'
'virtual_machines/dns.md': 'network/dns.md'
'virtual_machines/boot_from_external_source.md': 'user_workloads/boot_from_external_source.md'
'virtual_machines/confidential_computing.md': 'cluster_admin/confidential_computing.md'
'virtual_machines/vsock.md': 'compute/vsock.md'
'virtual_machines/virtual_machines_on_Arm64.md': 'cluster_admin/virtual_machines_on_Arm64.md'
'virtual_machines/device_status_on_Arm64.md': 'cluster_admin/device_status_on_Arm64.md'
'virtual_machines/persistent_tpm_and_uefi_state.md': 'compute/persistent_tpm_and_uefi_state.md'
'virtual_machines/resources_requests_and_limits.md': 'compute/resources_requests_and_limits.md'
'virtual_machines/guestfs.md': 'storage/guestfs.md'
remote_branch: main
site_favicon: assets/favicon.ico

2
netlify.toml
View File

@ -2,7 +2,7 @@
publish = "./site"
command = """
source /opt/buildhome/python3.8/bin/activate;
pip3 install mkdocs mkdocs-awesome-pages-plugin mkdocs-material;
pip3 install mkdocs mkdocs-awesome-pages-plugin mkdocs-material mkdocs-redirects;
sed -i 's|site_url: https://kubevirt.io/docs|site_url: https://kubevirt.io/|' /opt/build/repo/mkdocs.yml;
sed -i 's/docs_dir: docs/docs_dir:/' /opt/build/repo/mkdocs.yml;
echo '*** BEGIN /opt/build/repo/mkdocs.yml ***';