docs: create cloud-centric Getting Started DOC-1068 #2389

addetz · 2024-03-11T14:12:21Z

Describe the Change

This PR reorganizes the content under Getting Started into a cloud-centric information flow.
It makes the following changes:

Adds images for each specific cloud
Breaks up the Setup pages to document prerequisites in dedicated pages
Updates tutorial text to reference specific clouds
Updates tutorials with the cluster profile diff workflow
Moves the Palette Dashboard page to the introduction section instead of Getting Started

Changed Pages

All the pages in these sections have been changed

💻 Deploy a Cluster to Amazon Web Services (AWS)
💻 Deploy a Cluster to Microsoft Azure
💻 Deploy a Cluster to Google Cloud Platform (GCP)

Jira Tickets

🎫 DOC-1068

Backports

Can this PR be backported?

Yes. Remember to add the relevant backport labels to your PR.
No. Please leave a short comment below about why this PR cannot be backported.
We are merging this to a dedicated feature branch first.

netlify · 2024-03-11T14:12:38Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/6620275e365e332318cbb639
😎 Deploy Preview	https://deploy-preview-2389--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

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

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

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

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

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

docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

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

docs/docs-content/getting-started/aws/create-cluster-profile.md

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

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

docs/docs-content/getting-started/azure/deploy-k8s-cluster.md

docs/docs-content/getting-started/aws/deploy-k8s-cluster-tf.md

docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md

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

vault-token-factory-spectrocloud · 2024-04-17T18:19:34Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 67.8%, saving 9.06 MB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster_create_cluster.webp`	47.55 KB	46.33 KB	-2.6%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster_event_log.webp`	767.47 KB	247.55 KB	-67.7%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_create_cluster.webp`	263.95 KB	47.28 KB	-82.1%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_event_log.webp`	329.23 KB	325.39 KB	-1.2%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	102.46 KB	99.18 KB	-3.2%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_add-service-tag.webp`	63.15 KB	61.53 KB	-2.6%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_apply-frontend-filter.webp`	371.46 KB	69.75 KB	-81.2%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_available-updates-dialog.webp`	460.27 KB	96.13 KB	-79.1%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_completed-cluster-updates.webp`	562.92 KB	118.10 KB	-79.0%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_deployed-clusters-start-setup.webp`	53.65 KB	51.85 KB	-3.4%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_new-version-overview.webp`	77.28 KB	74.92 KB	-3.0%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_pending-update-clusters-view.webp`	143.76 KB	29.91 KB	-79.2%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_profile-version-selection.webp`	73.11 KB	71.47 KB	-2.2%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_profile-with-cluster.webp`	565.94 KB	78.55 KB	-86.1%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	592.13 KB	146.46 KB	-75.3%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_create-cluster-profile_manifest_blue_btn.webp`	563.07 KB	102.03 KB	-81.9%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_create-cluster-profile_manifest.webp`	137.49 KB	131.11 KB	-4.6%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_delete-cluster-button.webp`	213.00 KB	57.67 KB	-72.9%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_event_log.webp`	877.23 KB	291.72 KB	-66.7%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_service_url.webp`	578.53 KB	144.16 KB	-75.1%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	105.03 KB	101.59 KB	-3.3%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_update-k8s-cluster_available-updates-dialog.webp`	448.12 KB	96.91 KB	-78.4%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	585.28 KB	145.54 KB	-75.1%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_create-cluster-profile_manifest_blue_btn.webp`	561.92 KB	100.25 KB	-82.2%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_create-cluster-profile_manifest.webp`	137.46 KB	131.10 KB	-4.6%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_delete-cluster-button.webp`	203.15 KB	52.95 KB	-73.9%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_event_log.webp`	800.90 KB	264.30 KB	-67.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_new_cluster.webp`	47.46 KB	45.56 KB	-4.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_service_url.webp`	550.00 KB	138.08 KB	-74.9%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	104.46 KB	100.91 KB	-3.4%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_add-service-tag.webp`	64.71 KB	63.23 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_apply-frontend-filter.webp`	374.79 KB	71.59 KB	-80.9%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_available-updates-dialog.webp`	457.90 KB	98.92 KB	-78.4%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_completed-cluster-updates.webp`	567.52 KB	118.99 KB	-79.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_deployed-clusters-start-setup.webp`	51.86 KB	49.93 KB	-3.7%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_new-version-overview.webp`	80.69 KB	78.37 KB	-2.9%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_pending-update-clusters-view.webp`	145.97 KB	31.54 KB	-78.4%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_profile-version-selection.webp`	72.97 KB	70.70 KB	-3.1%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_profile-with-cluster.webp`	559.85 KB	74.26 KB	-86.7%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	582.91 KB	149.18 KB	-74.4%	View diff
`static/assets/docs/images/getting-started/getting-started_update-k8s-cluster_profile-version-changes.webp`	337.13 KB	132.57 KB	-60.7%	View diff

672 images did not require optimisation.

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

docs/docs-content/getting-started/gcp/update-k8s-cluster.md

docs/docs-content/getting-started/gcp/deploy-k8s-cluster-tf.md

vault-token-factory-spectrocloud · 2024-04-17T18:24:24Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 2%, saving 67.20 KB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster_event_log.webp`	247.55 KB	241.74 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_create_cluster.webp`	47.28 KB	46.41 KB	-1.8%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	99.18 KB	97.53 KB	-1.7%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_apply-frontend-filter.webp`	69.75 KB	69.00 KB	-1.1%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_available-updates-dialog.webp`	96.13 KB	93.86 KB	-2.4%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_completed-cluster-updates.webp`	118.10 KB	115.37 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_pending-update-clusters-view.webp`	29.91 KB	29.47 KB	-1.5%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_profile-with-cluster.webp`	78.55 KB	77.02 KB	-1.9%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	146.46 KB	143.46 KB	-2.1%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_create-cluster-profile_manifest_blue_btn.webp`	102.03 KB	99.77 KB	-2.2%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_create-cluster-profile_manifest.webp`	131.11 KB	128.49 KB	-2.0%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_delete-cluster-button.webp`	57.67 KB	56.36 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_event_log.webp`	291.72 KB	287.19 KB	-1.6%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_service_url.webp`	144.16 KB	141.15 KB	-2.1%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	101.59 KB	100.19 KB	-1.4%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_update-k8s-cluster_available-updates-dialog.webp`	96.91 KB	94.58 KB	-2.4%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	145.54 KB	142.68 KB	-2.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_create-cluster-profile_manifest_blue_btn.webp`	100.25 KB	98.29 KB	-2.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_create-cluster-profile_manifest.webp`	131.10 KB	128.23 KB	-2.2%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_delete-cluster-button.webp`	52.95 KB	52.26 KB	-1.3%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_event_log.webp`	264.30 KB	258.15 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_service_url.webp`	138.08 KB	135.33 KB	-2.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	100.91 KB	99.86 KB	-1.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_apply-frontend-filter.webp`	71.59 KB	70.71 KB	-1.2%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_available-updates-dialog.webp`	98.92 KB	96.64 KB	-2.3%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_deployed-clusters-start-setup.webp`	49.93 KB	49.34 KB	-1.2%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_pending-update-clusters-view.webp`	31.54 KB	30.95 KB	-1.9%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_profile-with-cluster.webp`	74.26 KB	72.35 KB	-2.6%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp`	149.18 KB	146.43 KB	-1.8%	View diff
`static/assets/docs/images/getting-started/getting-started_update-k8s-cluster_profile-version-changes.webp`	132.57 KB	129.20 KB	-2.5%	View diff

683 images did not require optimisation.

vault-token-factory-spectrocloud · 2024-04-17T18:29:02Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 1.3%, saving 18.73 KB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster_event_log.webp`	241.74 KB	238.40 KB	-1.4%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_create_cluster.webp`	46.41 KB	45.77 KB	-1.4%	View diff
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	97.53 KB	96.51 KB	-1.0%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_create-cluster-profile_manifest.webp`	128.49 KB	127.07 KB	-1.1%	View diff
`static/assets/docs/images/getting-started/azure/getting-started_deploy-k8s-cluster_event_log.webp`	287.19 KB	283.22 KB	-1.4%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_create-cluster-profile_manifest.webp`	128.23 KB	126.94 KB	-1.0%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_delete-cluster-button.webp`	52.26 KB	51.57 KB	-1.3%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_event_log.webp`	258.15 KB	255.02 KB	-1.2%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster_service_url.webp`	135.33 KB	133.78 KB	-1.1%	View diff
`static/assets/docs/images/getting-started/gcp/getting-started_deploy-k8s-cluster-tf_profile_review.webp`	99.86 KB	98.19 KB	-1.7%	View diff

703 images did not require optimisation.

vault-token-factory-spectrocloud · 2024-04-17T18:33:41Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 1.1%, saving 2.57 KB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/getting-started/aws/getting-started_deploy-k8s-cluster_event_log.webp`	238.40 KB	235.84 KB	-1.1%	View diff

712 images did not require optimisation.

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

caroldelwing

I left one small question 🚀

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

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

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

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

karl-cardenas-coding · 2024-04-18T20:41:16Z

docs/docs-content/getting-started/aws/create-cluster-profile.md

+The review section gives an overview of the cluster profile configuration you selected. Click on **Finish
+Configuration** to create the cluster profile.
+
+## Add a Manifest


We're gonna use the pack Carolina created for the tutorial, right?

docs/docs-content/getting-started/aws/deploy-k8s-cluster.md

Co-authored-by: Karl Cardenas <[email protected]>

docs/docs-content/_partials/_aws-static-credentials-setup.mdx

docs/docs-content/_partials/_gcp-cloud-account-setup.mdx

docs/docs-content/_partials/_create-upload-ssh-key.mdx

docs/docs-content/_partials/_azure-cloud-account-setup.mdx

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

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

addetz self-assigned this Mar 11, 2024

addetz requested a review from a team as a code owner March 11, 2024 14:12

addetz requested review from karl-cardenas-coding, yuliiiah and caroldelwing March 11, 2024 14:12

github-actions bot reviewed Mar 11, 2024

View reviewed changes

addetz force-pushed the cloud-centric-getting-started-doc-1068 branch from f10d863 to 6ffec60 Compare March 19, 2024 13:45

github-actions bot reviewed Mar 19, 2024

View reviewed changes

addetz and others added 14 commits April 8, 2024 16:34

docs: add navigation card components

954da2b

chore: Add a few more grid styles

7cdd1c7

docs: add Jest test and adjust Getting Started landing page

dc4f0eb

docs: fix formatting

d24bc3c

docs: fix lint errors in SimpleCard

83053e3

docs: refactor grid test DOC-1067

1af60ad

docs: reduce duplication in SimpleCard test

6ce8fcf

docs: reduce duplication in SimpleCard test

24c8b8e

docs: fix formatting DOC-1067

a9b98f2

docs: update SimpleCardGrid naming DOC-1067

0eb2f11

docs: create cloud-centric Getting Started prototype DOC-1068

8e49594

docs: fix formatting

15aa52f

docs: adjust nav cards and rebase

63d1235

docs: update prototype DOC-1068

9462b60

addetz removed the backport-version-4-2 Backport change to version 4.2 label Apr 15, 2024

addetz changed the base branch from master to getting-started-phase-2 April 15, 2024 13:34

addetz added 6 commits April 15, 2024 16:30

docs: move dashboard to introduction DOC-1068

e60c14e

docs: update AWS section DOC-1068

3b5b4c4

docs: update Azure section DOC-1068

4c53eba

docs: update GCP section DOC-1068

5518f5a

docs: add tags to getting started DOC-1068

709e84e

docs: update formatting DOC-1068

9b91c87

github-actions bot reviewed Apr 17, 2024

View reviewed changes

Optimised images with calibre/image-actions

dd69965

github-actions bot reviewed Apr 17, 2024

View reviewed changes

Optimised images with calibre/image-actions

bcec3f2

Optimised images with calibre/image-actions

f2def58

vault-token-factory-spectrocloud bot and others added 2 commits April 17, 2024 18:33

Optimised images with calibre/image-actions

b4c2215

docs: update GCP landing page DOC-1068

fce6b29

github-actions bot reviewed Apr 17, 2024

View reviewed changes

docs/docs-content/getting-started/gcp/gcp.md Show resolved Hide resolved

addetz changed the title ~~docs: create cloud-centric Getting Started prototype DOC-1068~~ docs: create cloud-centric Getting Started DOC-1068 Apr 17, 2024

addetz removed the do-not-merge/work-in-progress Work in-progress. DO NOT MERGE label Apr 18, 2024

caroldelwing approved these changes Apr 18, 2024

View reviewed changes

docs/docs-content/getting-started/aws/setup.md Outdated Show resolved Hide resolved

karl-cardenas-coding approved these changes Apr 18, 2024

View reviewed changes

addetz and others added 5 commits April 22, 2024 16:04

Apply suggestions from code review

71538d7

Co-authored-by: Karl Cardenas <[email protected]>

docs: adjust setup fro getting started DOC-1068

e0558de

docs: remove video from deploy cluster DOC-1068

3f9f7d4

docs: update imports in AWS DOC-1068

2e4c38e

docs: fix formatting DOC-1068

831cfae

github-actions bot reviewed Apr 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: create cloud-centric Getting Started DOC-1068 #2389

docs: create cloud-centric Getting Started DOC-1068 #2389

addetz commented Mar 11, 2024 •

edited

netlify bot commented Mar 11, 2024 •

edited

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

caroldelwing left a comment

karl-cardenas-coding Apr 18, 2024

docs: create cloud-centric Getting Started DOC-1068 #2389

Are you sure you want to change the base?

docs: create cloud-centric Getting Started DOC-1068 #2389

Conversation

addetz commented Mar 11, 2024 • edited

Describe the Change

Changed Pages

Jira Tickets

Backports

netlify bot commented Mar 11, 2024 • edited

✅ Deploy Preview for docs-spectrocloud ready!

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

vault-token-factory-spectrocloud bot commented Apr 17, 2024

caroldelwing left a comment

Choose a reason for hiding this comment

karl-cardenas-coding Apr 18, 2024

Choose a reason for hiding this comment

addetz commented Mar 11, 2024 •

edited

netlify bot commented Mar 11, 2024 •

edited