CNV-52669: documentation file

kubevirt-ui · Dec 9, 2024 · 1677411 · 1677411
1 parent c0b910f
commit 1677411
Show file tree

Hide file tree

Showing 55 changed files with 179 additions and 169 deletions.
diff --git a/locales/en/plugin__kubevirt-plugin.json b/locales/en/plugin__kubevirt-plugin.json
@@ -707,7 +707,7 @@
   "Map of string keys and values that can be used to organize and categorize (scope and select) objects": "Map of string keys and values that can be used to organize and categorize (scope and select) objects",
   "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.",
   "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. ": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. ",
-  "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: <2>http://kubernetes.io/docs/user-guide/labels</2>": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: <2>http://kubernetes.io/docs/user-guide/labels</2>",
+  "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info:": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info:",
   "masquerade": "masquerade",
   "Masquerade": "Masquerade",
   "Match label": "Match label",

diff --git a/src/utils/components/AddBootableVolumeModal/components/SchedulingSettings.tsx b/src/utils/components/AddBootableVolumeModal/components/SchedulingSettings.tsx
@@ -2,6 +2,7 @@ import React, { FC } from 'react';
 
 import ExternalLink from '@kubevirt-utils/components/ExternalLink/ExternalLink';
 import FormGroupHelperText from '@kubevirt-utils/components/FormGroupHelperText/FormGroupHelperText';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { FormGroup, NumberInput, Text, TextInput, Title } from '@patternfly/react-core';
 
@@ -51,10 +52,7 @@ const SchedulingSettings: FC<SchedulingSettingsProps> = ({
         </Title>
         <Text>
           {t('Use cron formatting to set when and how often to look for new imports.')}{' '}
-          <ExternalLink
-            href={'https://www.redhat.com/sysadmin/automate-linux-tasks-cron'}
-            text={t('Learn more')}
-          />
+          <ExternalLink href={documentationURL.CRON_INFO} text={t('Learn more')} />
         </Text>
       </div>
       <FormGroup

diff --git a/...eModal/components/VolumeMetadata/components/PreferenceSelect/PreferencePopoverContent.tsx b/...eModal/components/VolumeMetadata/components/PreferenceSelect/PreferencePopoverContent.tsx
@@ -1,18 +1,15 @@
 import React, { FC } from 'react';
 
 import ExternalLink from '@kubevirt-utils/components/ExternalLink/ExternalLink';
-import { INSTANCE_TYPES_USER_GUIDE_LINK } from '@kubevirt-utils/constants/url-constants';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 
 const PreferencePopoverContent: FC = () => {
   const { t } = useKubevirtTranslation();
   return (
     <>
       {t('The preferred VirtualMachine attribute values required to run a given workload.')}{' '}
-      <ExternalLink
-        href={`${INSTANCE_TYPES_USER_GUIDE_LINK}#virtualmachinepreference`}
-        text={t('Read more')}
-      />
+      <ExternalLink href={documentationURL.INSTANCE_TYPES_USER_GUIDE} text={t('Read more')} />
     </>
   );
 };

diff --git a/src/utils/components/CloneVMModal/utils/constants.ts b/src/utils/components/CloneVMModal/utils/constants.ts
@@ -1,8 +1,6 @@
 import { ProgressStepVariant } from '@patternfly/react-core';
 
 export const TEMPLATE_VM_NAME_LABEL = 'vm.kubevirt.io/name';
-export const DOC_URL_ENABLING_USER_CLONE_PERMISSIONS =
-  'https://docs.openshift.com/container-platform/latest/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.html';
 
 export enum CLONING_STATUSES {
   CREATING_TARGET_VM = 'CreatingTargetVM',

diff --git a/src/utils/components/CloudinitDescription/CloudinitInfoHelper.tsx b/src/utils/components/CloudinitDescription/CloudinitInfoHelper.tsx
@@ -1,11 +1,10 @@
 import React from 'react';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Button, Stack, StackItem } from '@patternfly/react-core';
 import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
 
-const CLOUD_INIT_DOC_LINK = 'https://cloudinit.readthedocs.io/en/latest/index.html';
-
 const CloudInitInfoHelper = () => {
   const { t } = useKubevirtTranslation();
   return (
@@ -25,7 +24,7 @@ const CloudInitInfoHelper = () => {
             size="sm"
             variant="link"
           >
-            <a href={CLOUD_INIT_DOC_LINK} rel="noopener noreferrer" target="_blank">
+            <a href={documentationURL.CLOUDINIT_INFO} rel="noopener noreferrer" target="_blank">
               {t('Learn more')}
             </a>
           </Button>

diff --git a/src/utils/components/Consoles/components/DesktopViewer/Components/MoreInformationDefault.tsx b/src/utils/components/Consoles/components/DesktopViewer/Components/MoreInformationDefault.tsx
@@ -34,7 +34,7 @@ const MoreInformationDefault: React.FC<MoreInformationDefaultProps> = ({ textMor
             <div>
               {t('Download the MSI from ')}
               <a
-                href="https://virt-manager.org/download/"
+                href="https://virt-manager.org/download.html"
                 rel="noopener noreferrer"
                 target="_blank"
               >

diff --git a/src/utils/components/Consoles/components/DesktopViewer/Components/RDPServiceModal.tsx b/src/utils/components/Consoles/components/DesktopViewer/Components/RDPServiceModal.tsx
@@ -3,6 +3,7 @@ import React, { FC, useState } from 'react';
 import { V1VirtualMachine, V1VirtualMachineInstance } from '@kubevirt-ui/kubevirt-api/kubevirt';
 import ExternalLink from '@kubevirt-utils/components/ExternalLink/ExternalLink';
 import TabModal from '@kubevirt-utils/components/TabModal/TabModal';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import {
   Alert,
@@ -13,7 +14,6 @@ import {
   StackItem,
 } from '@patternfly/react-core';
 
-import { NODE_PORTS_LINK } from '../utils/constants';
 import { createRDPService } from '../utils/utils';
 
 type RDPServiceModalProps = {
@@ -52,7 +52,7 @@ const RDPServiceModal: FC<RDPServiceModalProps> = ({ isOpen, onClose, vm, vmi })
             <div>
               {t('RDP Service is using a node port. Node port requires additional port resources.')}
               <div>
-                <ExternalLink href={NODE_PORTS_LINK} text={t('Learn more')} />
+                <ExternalLink href={documentationURL.NODEPORTS} text={t('Learn more')} />
               </div>
             </div>
           </Alert>

diff --git a/src/utils/components/Consoles/components/DesktopViewer/utils/constants.ts b/src/utils/components/Consoles/components/DesktopViewer/utils/constants.ts
@@ -5,8 +5,6 @@ export const DEFAULT_VV_MIMETYPE = 'application/x-virt-viewer';
 export const DEFAULT_RDP_FILENAME = 'console.rdp';
 export const DEFAULT_RDP_MIMETYPE = 'application/rdp';
 export const VMI_LABEL_AS_RDP_SERVICE_SELECTOR = 'vm.kubevirt.io/name';
-export const NODE_PORTS_LINK =
-  'https://access.redhat.com/documentation/en-us/openshift_container_platform/4.10/html/networking/configuring-ingress-cluster-traffic#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport';
 
 export const POD = 'POD';
 export const MULTUS = 'MULTUS';
diff --git a/src/utils/components/CreateProjectModal/CreateProjectModal.tsx b/src/utils/components/CreateProjectModal/CreateProjectModal.tsx
@@ -2,6 +2,7 @@ import React, { useState } from 'react';
 import { Trans } from 'react-i18next';
 
 import { ProjectRequestModel } from '@kubevirt-ui/kubevirt-api/console';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { isEmpty } from '@kubevirt-utils/utils/utils';
 import { k8sCreate, K8sResourceCommon } from '@openshift-console/dynamic-plugin-sdk';
@@ -54,7 +55,7 @@ const CreateProjectModal: React.FC<CreateProjectModalProps> = ({
         {t('An OpenShift project is an alternative representation of a Kubernetes namespace.')}
       </Text>
       <br />
-      <ExternalLink href="https://docs.okd.io/latest/applications/projects/working-with-projects.html">
+      <ExternalLink href={documentationURL.PROJECTS}>
         {t('Learn more about working with projects')}
       </ExternalLink>
       <br />

diff --git a/...ponents/DiskModal/components/StorageClassAndPreallocation/EnablePreallocationCheckbox.tsx b/...ponents/DiskModal/components/StorageClassAndPreallocation/EnablePreallocationCheckbox.tsx
@@ -4,6 +4,7 @@ import { Trans } from 'react-i18next';
 import { Link } from 'react-router-dom-v5-compat';
 
 import HelpTextIcon from '@kubevirt-utils/components/HelpTextIcon/HelpTextIcon';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Checkbox, Flex, FlexItem, FormGroup, PopoverPosition } from '@patternfly/react-core';
 
@@ -44,8 +45,7 @@ const EnablePreallocationCheckbox: FC<EnablePreallocationCheckboxProps> = ({ isD
                   Refer to the
                   <Link
                     to={{
-                      pathname:
-                        'https://docs.openshift.com/container-platform/4.15/virt/storage/virt-using-preallocation-for-datavolumes.html',
+                      pathname: documentationURL.DATAVOLUME_PREALLOCATIONS,
                     }}
                     target="_blank"
                   >

diff --git a/src/utils/components/DynamicSSHKeyInjection/constants/constants.ts b/src/utils/components/DynamicSSHKeyInjection/constants/constants.ts
@@ -1,4 +1 @@
 export const DYNAMIC_CREDENTIALS_SUPPORT = 'kubevirt.io/dynamic-credentials-support';
-
-export const DYNAMIC_SSH_KEY_INJECTION_LINK =
-  'https://docs.openshift.com/container-platform/4.15/virt/virtual_machines/virt-accessing-vm-ssh.html';
diff --git a/src/utils/components/GuidedTour/components/EndTourContent/EndTourContent.tsx b/src/utils/components/GuidedTour/components/EndTourContent/EndTourContent.tsx
@@ -2,6 +2,7 @@ import React, { FC } from 'react';
 import { Trans } from 'react-i18next';
 import { Link } from 'react-router-dom-v5-compat';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 
 const EndTourContent: FC = () => {
@@ -12,14 +13,11 @@ const EndTourContent: FC = () => {
       Thank you for taking the tour.
       <br />
       Stay up-to-date with Openshift Virtualization on our{' '}
-      <Link target="_blank" to="https://www.redhat.com/en/blog/channel/red-hat-openshift">
+      <Link target="_blank" to={documentationURL.REDHAT_BLOG}>
         Blog
       </Link>{' '}
       or continue to learn more in our{' '}
-      <Link
-        target="_blank"
-        to="https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/virtualization/about#virt-what-you-can-do-with-virt_about-virt"
-      >
+      <Link target="_blank" to={documentationURL.VIRTUALIZATION_WHAT_YOU_CAN_DO}>
         documentation
       </Link>
       .

diff --git a/...terfaceNetworkSelect/components/NetworkSelectHelperPopover/NetworkSelectHelperPopover.tsx b/...terfaceNetworkSelect/components/NetworkSelectHelperPopover/NetworkSelectHelperPopover.tsx
@@ -2,6 +2,7 @@ import React, { FC } from 'react';
 import { Trans } from 'react-i18next';
 
 import ExternalLink from '@kubevirt-utils/components/ExternalLink/ExternalLink';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Button, ButtonVariant, Popover } from '@patternfly/react-core';
 import { HelpIcon } from '@patternfly/react-icons';
@@ -25,10 +26,7 @@ const NetworkSelectHelperPopover: FC = () => {
               VirtualMachine for high performance.
             </div>
           </Trans>
-          <ExternalLink
-            href="https://docs.openshift.com/container-platform/4.15/virt/vm_networking/virt-networking-overview.html#secondary-network-config"
-            text={t('Learn more')}
-          />
+          <ExternalLink href={documentationURL.VIRT_SECONDARY_NETWORK} text={t('Learn more')} />
         </>
       }
       headerContent={t('Network binding types')}

diff --git a/src/utils/components/SSHAccess/components/ConsoleOverVirtctl.tsx b/src/utils/components/SSHAccess/components/ConsoleOverVirtctl.tsx
@@ -4,6 +4,7 @@ import { Link } from 'react-router-dom-v5-compat';
 
 import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
 import { getConsoleVirtctlCommand } from '@kubevirt-utils/components/SSHAccess/utils';
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import {
   DescriptionListDescription,
@@ -41,14 +42,8 @@ const ConsoleOverVirtctl: FC<ConsoleOverVirtctlProps> = ({ vm }) => {
                 <br />
                 <div>
                   For more details, see{' '}
-                  <Link
-                    to={
-                      'https://docs.openshift.com/container-platform/4.15/virt/getting_started/virt-using-the-cli-tools.html'
-                    }
-                  >
-                    Installing virtctl
-                  </Link>{' '}
-                  in Getting started with OpenShift Virtualization.
+                  <Link to={documentationURL.VIRT_CTL}>Installing virtctl</Link> in Getting started
+                  with OpenShift Virtualization.
                 </div>
               </Trans>
               <br />

diff --git a/src/utils/components/SSHAccess/constants.ts b/src/utils/components/SSHAccess/constants.ts
@@ -5,9 +5,6 @@ export const SSH_PORT = 22;
 
 export const VMI_LABEL_AS_SSH_SERVICE_SELECTOR = 'kubevirt.io/domain';
 
-export const NODE_PORTS_LINK =
-  'https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/networking/configuring-ingress-cluster-traffic#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport';
-
 export enum SERVICE_TYPES {
   LOAD_BALANCER = 'LoadBalancer',
   NODE_PORT = 'NodePort',

diff --git a/src/utils/components/SnapshotModal/SnapshotSupportLink/SnapshotSupportLink.tsx b/src/utils/components/SnapshotModal/SnapshotSupportLink/SnapshotSupportLink.tsx
@@ -1,17 +1,12 @@
 import * as React from 'react';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 
 const SnapshotSupportLink: React.FC = () => {
   const { t } = useKubevirtTranslation();
   return (
-    <a
-      href={
-        'https://access.redhat.com/documentation/en-us/openshift_container_platform/4.10/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots'
-      }
-      rel="noreferrer"
-      target="_blank"
-    >
+    <a href={documentationURL.SNAPSHOT} rel="noreferrer" target="_blank">
       {t('Learn more about snapshots')}
     </a>
   );

diff --git a/src/utils/components/SysprepModal/SysprepInfo.tsx b/src/utils/components/SysprepModal/SysprepInfo.tsx
@@ -1,11 +1,10 @@
 import React, { FC } from 'react';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Button, Stack, StackItem, Text, TextVariants } from '@patternfly/react-core';
 import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
 
-import { SYSPREP_DOC_URL } from './consts';
-
 const SysprepInfo: FC = () => {
   const { t } = useKubevirtTranslation();
 
@@ -30,7 +29,7 @@ const SysprepInfo: FC = () => {
             size="sm"
             variant="link"
           >
-            <a href={SYSPREP_DOC_URL} rel="noopener noreferrer" target="_blank">
+            <a href={documentationURL.SYSPREP} rel="noopener noreferrer" target="_blank">
               {t('Learn more')}
             </a>
           </Button>

diff --git a/src/utils/components/SysprepModal/consts.ts b/src/utils/components/SysprepModal/consts.ts
@@ -1,3 +1 @@
 export const SYSPREP = 'sysprep';
-export const SYSPREP_DOC_URL =
-  'https://docs.openshift.com/container-platform/4.10/virt/virtual_machines/virt-automating-windows-sysprep.html';
diff --git a/src/utils/components/SysprepModal/sysprep-autounattend/SysprepAutounattendHelperPopup.tsx b/src/utils/components/SysprepModal/sysprep-autounattend/SysprepAutounattendHelperPopup.tsx
@@ -1,12 +1,11 @@
 import React, { FC } from 'react';
 import { Trans } from 'react-i18next';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Button, Popover, Text, TextVariants } from '@patternfly/react-core';
 import { ExternalLinkSquareAltIcon, OutlinedQuestionCircleIcon } from '@patternfly/react-icons';
 
-import { SYSPREP_DOC_URL } from '../consts';
-
 const SysprepUnattendHelperPopup: FC = () => {
   const { t } = useKubevirtTranslation();
   return (
@@ -27,7 +26,7 @@ const SysprepUnattendHelperPopup: FC = () => {
               size="sm"
               variant="link"
             >
-              <a href={SYSPREP_DOC_URL} rel="noopener noreferrer" target="_blank">
+              <a href={documentationURL.SYSPREP} rel="noopener noreferrer" target="_blank">
                 {t('Learn more')}
               </a>
             </Button>

diff --git a/src/utils/components/SysprepModal/sysprep-unattend/SysprepUnattendHelperPopup.tsx b/src/utils/components/SysprepModal/sysprep-unattend/SysprepUnattendHelperPopup.tsx
@@ -1,12 +1,11 @@
 import React, { FC } from 'react';
 import { Trans } from 'react-i18next';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Button, Popover, Text, TextVariants } from '@patternfly/react-core';
 import { ExternalLinkSquareAltIcon, OutlinedQuestionCircleIcon } from '@patternfly/react-icons';
 
-import { SYSPREP_DOC_URL } from '../consts';
-
 const SysprepUnattendHelperPopup: FC = () => {
   const { t } = useKubevirtTranslation();
   return (
@@ -26,7 +25,7 @@ const SysprepUnattendHelperPopup: FC = () => {
               size="sm"
               variant="link"
             >
-              <a href={SYSPREP_DOC_URL} rel="noopener noreferrer" target="_blank">
+              <a href={documentationURL.SYSPREP} rel="noopener noreferrer" target="_blank">
                 {t('Learn more')}
               </a>
             </Button>

diff --git a/src/utils/components/TolerationsModal/TolerationModalDescriptionText.tsx b/src/utils/components/TolerationsModal/TolerationModalDescriptionText.tsx
@@ -1,5 +1,6 @@
 import * as React from 'react';
 
+import { documentationURL } from '@kubevirt-utils/constants/documentation';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
 import { Text, TextVariants } from '@patternfly/react-core';
 import { ExternalLinkAltIcon } from '@patternfly/react-icons';
@@ -18,11 +19,7 @@ const TolerationModalDescriptionText: React.FC = () => {
           'Add tolerations to allow a VirtualMachine to schedule onto Nodes with matching taints.',
         )}
       </Text>
-      <Text
-        component={TextVariants.a}
-        href="https://docs.openshift.com/container-platform/4.10/virt/virtual_machines/advanced_vm_management/virt-specifying-nodes-for-vms.html#virt-about-node-placement-vms_virt-specifying-nodes-for-vms"
-        target="_blank"
-      >
+      <Text component={TextVariants.a} href={documentationURL.TAINTS_TOLERATION} target="_blank">
         {t('Taints and Tolerations documentation')} <ExternalLinkAltIcon />
       </Text>
     </>