docs: change simple cards to use versioned link DOC-1502 (#4971)

* docs: change simple cards to use versioned link DOC-1502 * docs: fix bad link * docs: add versioned link test cases * docs: add readme to used images list * docs: skip vale on additional capabilities page * Optimised images with calibre/image-actions * docs: adjust readme * docs: remove wrongly added div --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> (cherry picked from commit ab95159)
spectrocloud · Dec 13, 2024 · 81b6030 · 81b6030
1 parent 83b6fef
commit 81b6030
Show file tree

Hide file tree

Showing 16 changed files with 132 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -541,7 +541,9 @@ To add a video, use the following syntax. Ensure you capitalize the letter "V":
 ### Simple Card Grid
 
 This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
-scheme. The rows of cards are dynamically created according to the list of specified cards.
+scheme. The rows of cards are dynamically created according to the list of specified cards. This component uses the
+`VersionedLink` under the covers. URLs should be specified as discussed in the [Internal Links](#internal-links)
+section.
 
 ```js
 <SimpleCardGrid
@@ -550,19 +552,19 @@ scheme. The rows of cards are dynamically created according to the list of speci
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
     {
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
     {
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
   ]}
 />

diff --git a/...docs-content/getting-started/additional-capabilities/additional-capabilities.md b/...docs-content/getting-started/additional-capabilities/additional-capabilities.md
@@ -55,26 +55,28 @@ Started section to learn how they can grow with Palette and have a long-term rel
 In this section, you get an overview of other parts of Palette not yet covered by your Getting Started journey so far.
 Explore more through the following pages.
 
+<!-- vale off -->
+
 <SimpleCardGrid
   hideNumber="true"
   cards={[
     {
       title: "Palette Edge",
       description: "Explore Palette's Edge Capabilities.",
       buttonText: "Learn more",
-      relativeURL: "./edge",
+      url: "/getting-started/additional-capabilities/edge",
     },
     {
       title: "VerteX and Self-Hosted Palette",
       description: "Read about our dedicated Palette offerings, VerteX and Self-Hosted Palette.",
       buttonText: "Learn more",
-      relativeURL: "./self-hosted",
+      url: "/getting-started/additional-capabilities/self-hosted",
     },
     {
       title: "Virtual Machine Orchestrator",
       description: "Learn about Palette's Virtual Machine Orchestrator (VMO) and its management capabilities.",
       buttonText: "Learn more",
-      relativeURL: "./vmo",
+      url: "/getting-started/additional-capabilities/vmo",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/aws/aws.md b/docs/docs-content/getting-started/aws/aws.md
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
       title: "Set up Palette with AWS",
       description: "Set up the prerequisites of using Palette with AWS.",
       buttonText: "Learn more",
-      relativeURL: "./setup",
+      url: "/getting-started/aws/setup",
     },
     {
       title: "Create a Cluster Profile",
       description: "Create a full cluster profile in Palette.",
       buttonText: "Learn more",
-      relativeURL: "./create-cluster-profile",
+      url: "/getting-started/aws/create-cluster-profile",
     },
     {
       title: "Deploy a Cluster",
       description: "Deploy a Palette host cluster to AWS.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-k8s-cluster",
+      url: "/getting-started/aws/deploy-k8s-cluster",
     },
     {
       title: "Deploy Cluster Profile Updates",
       description: "Update your deployed clusters using Palette Cluster Profiles.",
       buttonText: "Learn more",
-      relativeURL: "./update-k8s-cluster",
+      url: "/getting-started/aws/update-k8s-cluster",
     },
     {
       title: "Cluster Management with Terraform",
       description: "Deploy and update a Palette host cluster with Terraform.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-manage-k8s-cluster-tf",
+      url: "/getting-started/aws/deploy-manage-k8s-cluster-tf",
     },
     {
       title: "Scale, Upgrade, and Secure Clusters",
       description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to AWS.",
       buttonText: "Learn more",
-      relativeURL: "./scale-secure-cluster",
+      url: "/getting-started/aws/scale-secure-cluster",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/azure/azure.md b/docs/docs-content/getting-started/azure/azure.md
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
       title: "Set up Palette with Azure",
       description: "Set up the prerequisites of using Palette with Azure.",
       buttonText: "Learn more",
-      relativeURL: "./setup",
+      url: "/getting-started/azure/setup",
     },
     {
       title: "Create a Cluster Profile",
       description: "Create a full cluster profile in Palette.",
       buttonText: "Learn more",
-      relativeURL: "./create-cluster-profile",
+      url: "/getting-started/azure/create-cluster-profile",
     },
     {
       title: "Deploy a Cluster",
       description: "Deploy a Palette host cluster to Azure.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-k8s-cluster",
+      url: "/getting-started/azure/deploy-k8s-cluster",
     },
     {
       title: "Deploy Cluster Profile Updates",
       description: "Update your deployed clusters using Palette Cluster Profiles.",
       buttonText: "Learn more",
-      relativeURL: "./update-k8s-cluster",
+      url: "/getting-started/azure/update-k8s-cluster",
     },
     {
       title: "Cluster Management with Terraform",
       description: "Deploy and update a Palette host cluster with Terraform.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-manage-k8s-cluster-tf",
+      url: "/getting-started/azure/deploy-manage-k8s-cluster-tf",
     },
     {
       title: "Scale, Upgrade, and Secure Clusters",
       description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to Azure.",
       buttonText: "Learn more",
-      relativeURL: "./scale-secure-cluster",
+      url: "/getting-started/azure/scale-secure-cluster",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/gcp/gcp.md b/docs/docs-content/getting-started/gcp/gcp.md
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
       title: "Set up Palette with GCP",
       description: "Set up the prerequisites of using Palette with GCP.",
       buttonText: "Learn more",
-      relativeURL: "./setup",
+      url: "/getting-started/gcp/setup",
     },
     {
       title: "Create a Cluster Profile",
       description: "Create a full cluster profile in Palette.",
       buttonText: "Learn more",
-      relativeURL: "./create-cluster-profile",
+      url: "/getting-started/gcp/create-cluster-profile",
     },
     {
       title: "Deploy a Cluster",
       description: "Deploy a Palette host cluster to GCP.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-k8s-cluster",
+      url: "/getting-started/gcp/deploy-k8s-cluster",
     },
     {
       title: "Deploy Cluster Profile Updates",
       description: "Update your deployed clusters using Palette Cluster Profiles.",
       buttonText: "Learn more",
-      relativeURL: "./update-k8s-cluster",
+      url: "/getting-started/gcp/update-k8s-cluster",
     },
     {
       title: "Cluster Management with Terraform",
       description: "Deploy and update a Palette host cluster with Terraform.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-manage-k8s-cluster-tf",
+      url: "/getting-started/gcp/deploy-manage-k8s-cluster-tf",
     },
     {
       title: "Scale, Upgrade, and Secure Clusters",
       description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to GCP.",
       buttonText: "Learn more",
-      relativeURL: "./scale-secure-cluster",
+      url: "/getting-started/gcp/scale-secure-cluster",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/getting-started.md b/docs/docs-content/getting-started/getting-started.md
@@ -57,37 +57,37 @@ Explore more through the following pages.
       title: "Introduction to Palette",
       description: "Learn about what makes Palette different.",
       buttonText: "Learn more",
-      relativeURL: "./introduction",
+      url: "/getting-started/introduction",
     },
     {
       title: "Deploy a Cluster to Amazon Web Services (AWS)",
       description: "Deploy and update a Palette host cluster to AWS.",
       buttonText: "Learn more",
-      relativeURL: "./aws",
+      url: "/getting-started/aws",
     },
     {
       title: "Deploy a Cluster to Microsoft Azure",
       description: "Deploy and update a Palette host cluster to Azure.",
       buttonText: "Learn more",
-      relativeURL: "./azure",
+      url: "/getting-started/azure",
     },
     {
       title: "Deploy a Cluster to Google Cloud Platform (GCP)",
       description: "Deploy and update a Palette host cluster to Google Cloud.",
       buttonText: "Learn more",
-      relativeURL: "./gcp",
+      url: "/getting-started/gcp",
     },
     {
       title: "Deploy a Cluster to VMware",
       description: "Deploy and update a Palette host cluster to VMware vSphere.",
       buttonText: "Learn more",
-      relativeURL: "./vmware",
+      url: "/getting-started/vmware",
     },
     {
       title: "Additional Capabilities",
       description: "Learn about Palette's additional capabilities.",
       buttonText: "Learn more",
-      relativeURL: "./additional-capabilities",
+      url: "/getting-started/additional-capabilities",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/introduction.md b/docs/docs-content/getting-started/introduction.md
@@ -89,25 +89,25 @@ Select your infrastructure provider to start exploring Palette.
       title: "Deploy a Cluster to Amazon Web Services (AWS)",
       description: "Deploy and update a Palette host cluster to AWS.",
       buttonText: "Learn more",
-      relativeURL: "../aws",
+      url: "/getting-started/aws",
     },
     {
       title: "Deploy a Cluster to Microsoft Azure",
       description: "Deploy and update a Palette host cluster to Azure.",
       buttonText: "Learn more",
-      relativeURL: "../azure",
+      url: "/getting-started/azure",
     },
     {
       title: "Deploy a Cluster to Google Cloud Platform (GCP)",
       description: "Deploy and update a Palette host cluster to Google Cloud.",
       buttonText: "Learn more",
-      relativeURL: "../gcp",
+      url: "/getting-started/gcp",
     },
     {
       title: "Deploy a Cluster to VMware",
       description: "Deploy and update a Palette host cluster to VMware vSphere.",
       buttonText: "Learn more",
-      relativeURL: "../vmware",
+      url: "/getting-started/vmware",
     },
   ]}
 />
diff --git a/docs/docs-content/getting-started/vmware/vmware.md b/docs/docs-content/getting-started/vmware/vmware.md
@@ -30,43 +30,43 @@ Once your cluster is deployed, you can update it using cluster profile updates.
       title: "Set up Palette with VMware",
       description: "Set up the prerequisites of using Palette with VMware.",
       buttonText: "Learn more",
-      relativeURL: "./setup",
+      url: "/getting-started/vmware/setup",
     },
     {
       title: "Deploy a PCG",
       description: "Learn to deploy a PCG with Palette CLI.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-pcg",
+      url: "/getting-started/vmware/deploy-pcg",
     },
     {
       title: "Create a Cluster Profile",
       description: "Create a full cluster profile in Palette.",
       buttonText: "Learn more",
-      relativeURL: "./create-cluster-profile",
+      url: "/getting-started/vmware/create-cluster-profile",
     },
     {
       title: "Deploy a Cluster",
       description: "Deploy a Palette host cluster to VMware.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-k8s-cluster",
+      url: "/getting-started/vmware/deploy-k8s-cluster",
     },
     {
       title: "Deploy Cluster Profile Updates",
       description: "Update your deployed clusters using Palette Cluster Profiles.",
       buttonText: "Learn more",
-      relativeURL: "./update-k8s-cluster",
+      url: "/getting-started/vmware/update-k8s-cluster",
     },
     {
       title: "Cluster Management with Terraform",
       description: "Deploy and update a Palette host cluster with Terraform.",
       buttonText: "Learn more",
-      relativeURL: "./deploy-manage-k8s-cluster-tf",
+      url: "/getting-started/vmware/deploy-manage-k8s-cluster-tf",
     },
     {
       title: "Scale, Upgrade, and Secure Clusters",
       description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to VMware.",
       buttonText: "Learn more",
-      relativeURL: "./scale-secure-cluster",
+      url: "/getting-started/vmware/scale-secure-cluster",
     },
   ]}
 />
diff --git a/docs/docs-content/tutorials/tutorials.md b/docs/docs-content/tutorials/tutorials.md
@@ -32,45 +32,47 @@ concepts.
 
 Explore more through the following tutorials.
 
+<!-- vale off -->
+
 <SimpleCardGrid
   hideNumber="true"
   cards={[
     {
       title: "Deploy a Custom Pack",
       description: "Learn how to deploy applications to a Kubernetes cluster using Palette's custom packs.",
       buttonText: "Learn more",
-      relativeURL: "./profiles/deploy-pack/",
+      url: "/tutorials/profiles/deploy-pack/",
     },
     {
       title: "Deploy a Cluster",
       description: "Learn how to deploy a Kubernetes cluster to a public cloud provider with Palette.",
       buttonText: "Learn more",
-      relativeURL: "./cluster-deployment/public-cloud/deploy-k8s-cluster/",
+      url: "/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster/",
     },
     {
       title: "Deploy App Workloads with a PCG",
       description:
         "Learn how to deploy a Private Cloud Gateway (PCG) to connect your data center or private cloud environment to Palette.",
       buttonText: "Learn more",
-      relativeURL: "./cluster-deployment/pcg/deploy-app-pcg/",
+      url: "/tutorials/cluster-deployment/pcg/deploy-app-pcg/",
     },
     {
       title: "Deploy an Application using Palette Dev Engine",
       description: "Learn how to deploy applications to a Kubernetes cluster using Palette’s App Mode.",
       buttonText: "Learn more",
-      relativeURL: "./cluster-deployment/pde/deploy-app/",
+      url: "/tutorials/cluster-deployment/pde/deploy-app/",
     },
     {
       title: "Deploy Cluster Profile Updates",
       description: "Learn how to update your deployed clusters using Palette Cluster Profiles.",
       buttonText: "Learn more",
-      relativeURL: "./cluster-management/update-maintain/update-k8s-cluster/",
+      url: "/tutorials/cluster-management/update-maintain/update-k8s-cluster/",
     },
     {
       title: "Deploy an Edge Cluster on VMware",
       description: "Learn how to deploy an Edge host using VMware as the deployment platform.",
       buttonText: "Learn more",
-      relativeURL: "./edge/deploy-cluster/",
+      url: "/tutorials/edge/deploy-cluster/",
     },
   ]}
 />