Skip to content

Commit 7de8c2d

Browse files
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)
1 parent ed9b3b0 commit 7de8c2d

File tree

16 files changed

+132
-73
lines changed

16 files changed

+132
-73
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,9 @@ component will automatically display the badge in the correct color based on the
565565
### Simple Card Grid
566566
567567
This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
568-
scheme. The rows of cards are dynamically created according to the list of specified cards.
568+
scheme. The rows of cards are dynamically created according to the list of specified cards. This component uses the
569+
`VersionedLink` under the covers. URLs should be specified as discussed in the [Internal Links](#internal-links)
570+
section.
569571
570572
```js
571573
<SimpleCardGrid
@@ -574,19 +576,19 @@ scheme. The rows of cards are dynamically created according to the list of speci
574576
title: "Lorem Ipsum",
575577
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
576578
buttonText: "Learn more",
577-
relativeURL: "./link",
579+
url: "/path/to/link",
578580
},
579581
{
580582
title: "Lorem Ipsum",
581583
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
582584
buttonText: "Learn more",
583-
relativeURL: "./link",
585+
url: "/path/to/link",
584586
},
585587
{
586588
title: "Lorem Ipsum",
587589
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
588590
buttonText: "Learn more",
589-
relativeURL: "./link",
591+
url: "/path/to/link",
590592
},
591593
]}
592594
/>

docs/docs-content/getting-started/additional-capabilities/additional-capabilities.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,26 +55,28 @@ Started section to learn how they can grow with Palette and have a long-term rel
5555
In this section, you get an overview of other parts of Palette not yet covered by your Getting Started journey so far.
5656
Explore more through the following pages.
5757

58+
<!-- vale off -->
59+
5860
<SimpleCardGrid
5961
hideNumber="true"
6062
cards={[
6163
{
6264
title: "Palette Edge",
6365
description: "Explore Palette's Edge Capabilities.",
6466
buttonText: "Learn more",
65-
relativeURL: "./edge",
67+
url: "/getting-started/additional-capabilities/edge",
6668
},
6769
{
6870
title: "VerteX and Self-Hosted Palette",
6971
description: "Read about our dedicated Palette offerings, VerteX and Self-Hosted Palette.",
7072
buttonText: "Learn more",
71-
relativeURL: "./self-hosted",
73+
url: "/getting-started/additional-capabilities/self-hosted",
7274
},
7375
{
7476
title: "Virtual Machine Orchestrator",
7577
description: "Learn about Palette's Virtual Machine Orchestrator (VMO) and its management capabilities.",
7678
buttonText: "Learn more",
77-
relativeURL: "./vmo",
79+
url: "/getting-started/additional-capabilities/vmo",
7880
},
7981
]}
8082
/>

docs/docs-content/getting-started/aws/aws.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
3030
title: "Set up Palette with AWS",
3131
description: "Set up the prerequisites of using Palette with AWS.",
3232
buttonText: "Learn more",
33-
relativeURL: "./setup",
33+
url: "/getting-started/aws/setup",
3434
},
3535
{
3636
title: "Create a Cluster Profile",
3737
description: "Create a full cluster profile in Palette.",
3838
buttonText: "Learn more",
39-
relativeURL: "./create-cluster-profile",
39+
url: "/getting-started/aws/create-cluster-profile",
4040
},
4141
{
4242
title: "Deploy a Cluster",
4343
description: "Deploy a Palette host cluster to AWS.",
4444
buttonText: "Learn more",
45-
relativeURL: "./deploy-k8s-cluster",
45+
url: "/getting-started/aws/deploy-k8s-cluster",
4646
},
4747
{
4848
title: "Deploy Cluster Profile Updates",
4949
description: "Update your deployed clusters using Palette Cluster Profiles.",
5050
buttonText: "Learn more",
51-
relativeURL: "./update-k8s-cluster",
51+
url: "/getting-started/aws/update-k8s-cluster",
5252
},
5353
{
5454
title: "Cluster Management with Terraform",
5555
description: "Deploy and update a Palette host cluster with Terraform.",
5656
buttonText: "Learn more",
57-
relativeURL: "./deploy-manage-k8s-cluster-tf",
57+
url: "/getting-started/aws/deploy-manage-k8s-cluster-tf",
5858
},
5959
{
6060
title: "Scale, Upgrade, and Secure Clusters",
6161
description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to AWS.",
6262
buttonText: "Learn more",
63-
relativeURL: "./scale-secure-cluster",
63+
url: "/getting-started/aws/scale-secure-cluster",
6464
},
6565
]}
6666
/>

docs/docs-content/getting-started/azure/azure.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
3030
title: "Set up Palette with Azure",
3131
description: "Set up the prerequisites of using Palette with Azure.",
3232
buttonText: "Learn more",
33-
relativeURL: "./setup",
33+
url: "/getting-started/azure/setup",
3434
},
3535
{
3636
title: "Create a Cluster Profile",
3737
description: "Create a full cluster profile in Palette.",
3838
buttonText: "Learn more",
39-
relativeURL: "./create-cluster-profile",
39+
url: "/getting-started/azure/create-cluster-profile",
4040
},
4141
{
4242
title: "Deploy a Cluster",
4343
description: "Deploy a Palette host cluster to Azure.",
4444
buttonText: "Learn more",
45-
relativeURL: "./deploy-k8s-cluster",
45+
url: "/getting-started/azure/deploy-k8s-cluster",
4646
},
4747
{
4848
title: "Deploy Cluster Profile Updates",
4949
description: "Update your deployed clusters using Palette Cluster Profiles.",
5050
buttonText: "Learn more",
51-
relativeURL: "./update-k8s-cluster",
51+
url: "/getting-started/azure/update-k8s-cluster",
5252
},
5353
{
5454
title: "Cluster Management with Terraform",
5555
description: "Deploy and update a Palette host cluster with Terraform.",
5656
buttonText: "Learn more",
57-
relativeURL: "./deploy-manage-k8s-cluster-tf",
57+
url: "/getting-started/azure/deploy-manage-k8s-cluster-tf",
5858
},
5959
{
6060
title: "Scale, Upgrade, and Secure Clusters",
6161
description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to Azure.",
6262
buttonText: "Learn more",
63-
relativeURL: "./scale-secure-cluster",
63+
url: "/getting-started/azure/scale-secure-cluster",
6464
},
6565
]}
6666
/>

docs/docs-content/getting-started/gcp/gcp.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,37 +30,37 @@ your cluster is deployed, you can update it using cluster profile updates.
3030
title: "Set up Palette with GCP",
3131
description: "Set up the prerequisites of using Palette with GCP.",
3232
buttonText: "Learn more",
33-
relativeURL: "./setup",
33+
url: "/getting-started/gcp/setup",
3434
},
3535
{
3636
title: "Create a Cluster Profile",
3737
description: "Create a full cluster profile in Palette.",
3838
buttonText: "Learn more",
39-
relativeURL: "./create-cluster-profile",
39+
url: "/getting-started/gcp/create-cluster-profile",
4040
},
4141
{
4242
title: "Deploy a Cluster",
4343
description: "Deploy a Palette host cluster to GCP.",
4444
buttonText: "Learn more",
45-
relativeURL: "./deploy-k8s-cluster",
45+
url: "/getting-started/gcp/deploy-k8s-cluster",
4646
},
4747
{
4848
title: "Deploy Cluster Profile Updates",
4949
description: "Update your deployed clusters using Palette Cluster Profiles.",
5050
buttonText: "Learn more",
51-
relativeURL: "./update-k8s-cluster",
51+
url: "/getting-started/gcp/update-k8s-cluster",
5252
},
5353
{
5454
title: "Cluster Management with Terraform",
5555
description: "Deploy and update a Palette host cluster with Terraform.",
5656
buttonText: "Learn more",
57-
relativeURL: "./deploy-manage-k8s-cluster-tf",
57+
url: "/getting-started/gcp/deploy-manage-k8s-cluster-tf",
5858
},
5959
{
6060
title: "Scale, Upgrade, and Secure Clusters",
6161
description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to GCP.",
6262
buttonText: "Learn more",
63-
relativeURL: "./scale-secure-cluster",
63+
url: "/getting-started/gcp/scale-secure-cluster",
6464
},
6565
]}
6666
/>

docs/docs-content/getting-started/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,37 +57,37 @@ Explore more through the following pages.
5757
title: "Introduction to Palette",
5858
description: "Learn about what makes Palette different.",
5959
buttonText: "Learn more",
60-
relativeURL: "./introduction",
60+
url: "/getting-started/introduction",
6161
},
6262
{
6363
title: "Deploy a Cluster to Amazon Web Services (AWS)",
6464
description: "Deploy and update a Palette host cluster to AWS.",
6565
buttonText: "Learn more",
66-
relativeURL: "./aws",
66+
url: "/getting-started/aws",
6767
},
6868
{
6969
title: "Deploy a Cluster to Microsoft Azure",
7070
description: "Deploy and update a Palette host cluster to Azure.",
7171
buttonText: "Learn more",
72-
relativeURL: "./azure",
72+
url: "/getting-started/azure",
7373
},
7474
{
7575
title: "Deploy a Cluster to Google Cloud Platform (GCP)",
7676
description: "Deploy and update a Palette host cluster to Google Cloud.",
7777
buttonText: "Learn more",
78-
relativeURL: "./gcp",
78+
url: "/getting-started/gcp",
7979
},
8080
{
8181
title: "Deploy a Cluster to VMware",
8282
description: "Deploy and update a Palette host cluster to VMware vSphere.",
8383
buttonText: "Learn more",
84-
relativeURL: "./vmware",
84+
url: "/getting-started/vmware",
8585
},
8686
{
8787
title: "Additional Capabilities",
8888
description: "Learn about Palette's additional capabilities.",
8989
buttonText: "Learn more",
90-
relativeURL: "./additional-capabilities",
90+
url: "/getting-started/additional-capabilities",
9191
},
9292
]}
9393
/>

docs/docs-content/getting-started/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,25 @@ Select your infrastructure provider to start exploring Palette.
8989
title: "Deploy a Cluster to Amazon Web Services (AWS)",
9090
description: "Deploy and update a Palette host cluster to AWS.",
9191
buttonText: "Learn more",
92-
relativeURL: "../aws",
92+
url: "/getting-started/aws",
9393
},
9494
{
9595
title: "Deploy a Cluster to Microsoft Azure",
9696
description: "Deploy and update a Palette host cluster to Azure.",
9797
buttonText: "Learn more",
98-
relativeURL: "../azure",
98+
url: "/getting-started/azure",
9999
},
100100
{
101101
title: "Deploy a Cluster to Google Cloud Platform (GCP)",
102102
description: "Deploy and update a Palette host cluster to Google Cloud.",
103103
buttonText: "Learn more",
104-
relativeURL: "../gcp",
104+
url: "/getting-started/gcp",
105105
},
106106
{
107107
title: "Deploy a Cluster to VMware",
108108
description: "Deploy and update a Palette host cluster to VMware vSphere.",
109109
buttonText: "Learn more",
110-
relativeURL: "../vmware",
110+
url: "/getting-started/vmware",
111111
},
112112
]}
113113
/>

docs/docs-content/getting-started/vmware/vmware.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,43 +30,43 @@ Once your cluster is deployed, you can update it using cluster profile updates.
3030
title: "Set up Palette with VMware",
3131
description: "Set up the prerequisites of using Palette with VMware.",
3232
buttonText: "Learn more",
33-
relativeURL: "./setup",
33+
url: "/getting-started/vmware/setup",
3434
},
3535
{
3636
title: "Deploy a PCG",
3737
description: "Learn to deploy a PCG with Palette CLI.",
3838
buttonText: "Learn more",
39-
relativeURL: "./deploy-pcg",
39+
url: "/getting-started/vmware/deploy-pcg",
4040
},
4141
{
4242
title: "Create a Cluster Profile",
4343
description: "Create a full cluster profile in Palette.",
4444
buttonText: "Learn more",
45-
relativeURL: "./create-cluster-profile",
45+
url: "/getting-started/vmware/create-cluster-profile",
4646
},
4747
{
4848
title: "Deploy a Cluster",
4949
description: "Deploy a Palette host cluster to VMware.",
5050
buttonText: "Learn more",
51-
relativeURL: "./deploy-k8s-cluster",
51+
url: "/getting-started/vmware/deploy-k8s-cluster",
5252
},
5353
{
5454
title: "Deploy Cluster Profile Updates",
5555
description: "Update your deployed clusters using Palette Cluster Profiles.",
5656
buttonText: "Learn more",
57-
relativeURL: "./update-k8s-cluster",
57+
url: "/getting-started/vmware/update-k8s-cluster",
5858
},
5959
{
6060
title: "Cluster Management with Terraform",
6161
description: "Deploy and update a Palette host cluster with Terraform.",
6262
buttonText: "Learn more",
63-
relativeURL: "./deploy-manage-k8s-cluster-tf",
63+
url: "/getting-started/vmware/deploy-manage-k8s-cluster-tf",
6464
},
6565
{
6666
title: "Scale, Upgrade, and Secure Clusters",
6767
description: "Learn how to scale, upgrade, and secure Palette host clusters deployed to VMware.",
6868
buttonText: "Learn more",
69-
relativeURL: "./scale-secure-cluster",
69+
url: "/getting-started/vmware/scale-secure-cluster",
7070
},
7171
]}
7272
/>

docs/docs-content/tutorials/tutorials.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,45 +32,47 @@ concepts.
3232

3333
Explore more through the following tutorials.
3434

35+
<!-- vale off -->
36+
3537
<SimpleCardGrid
3638
hideNumber="true"
3739
cards={[
3840
{
3941
title: "Deploy a Custom Pack",
4042
description: "Learn how to deploy applications to a Kubernetes cluster using Palette's custom packs.",
4143
buttonText: "Learn more",
42-
relativeURL: "./profiles/deploy-pack/",
44+
url: "/tutorials/profiles/deploy-pack/",
4345
},
4446
{
4547
title: "Deploy a Cluster",
4648
description: "Learn how to deploy a Kubernetes cluster to a public cloud provider with Palette.",
4749
buttonText: "Learn more",
48-
relativeURL: "./cluster-deployment/public-cloud/deploy-k8s-cluster/",
50+
url: "/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster/",
4951
},
5052
{
5153
title: "Deploy App Workloads with a PCG",
5254
description:
5355
"Learn how to deploy a Private Cloud Gateway (PCG) to connect your data center or private cloud environment to Palette.",
5456
buttonText: "Learn more",
55-
relativeURL: "./cluster-deployment/pcg/deploy-app-pcg/",
57+
url: "/tutorials/cluster-deployment/pcg/deploy-app-pcg/",
5658
},
5759
{
5860
title: "Deploy an Application using Palette Dev Engine",
5961
description: "Learn how to deploy applications to a Kubernetes cluster using Palette’s App Mode.",
6062
buttonText: "Learn more",
61-
relativeURL: "./cluster-deployment/pde/deploy-app/",
63+
url: "/tutorials/cluster-deployment/pde/deploy-app/",
6264
},
6365
{
6466
title: "Deploy Cluster Profile Updates",
6567
description: "Learn how to update your deployed clusters using Palette Cluster Profiles.",
6668
buttonText: "Learn more",
67-
relativeURL: "./cluster-management/update-maintain/update-k8s-cluster/",
69+
url: "/tutorials/cluster-management/update-maintain/update-k8s-cluster/",
6870
},
6971
{
7072
title: "Deploy an Edge Cluster on VMware",
7173
description: "Learn how to deploy an Edge host using VMware as the deployment platform.",
7274
buttonText: "Learn more",
73-
relativeURL: "./edge/deploy-cluster/",
75+
url: "/tutorials/edge/deploy-cluster/",
7476
},
7577
]}
7678
/>

0 commit comments

Comments
 (0)