Merge branch 'master' into cookie-tracking-fix

.github/workflows/release.yaml

@@ -57,10 +57,13 @@ jobs:
           node-version: "20"
           cache: "npm"
 
-      - run: npm ci
-
+      - run: |
+          echo "CURRENT_STEP=npm ci" >> $GITHUB_ENV
+          npm ci
+
       - name: Build
         run: |
+          echo "CURRENT_STEP=Build" >> $GITHUB_ENV
           touch .env
           make versions-ci
           make build-ci
@@ -73,10 +76,24 @@ jobs:
 
       - name: Upload to AWS
         run: |
+          echo "CURRENT_STEP=Upload to AWS" >> $GITHUB_ENV
           aws s3 sync --cache-control 'public, max-age=604800' --exclude '*.html' --exclude '*.xml' --exclude build/scripts/ build/ s3://docs.spectrocloud.com --delete
           aws s3 sync --cache-control 'public, max-age=0, s-maxage=604800' build/ s3://docs.spectrocloud.com --delete
           aws cloudfront create-invalidation --distribution-id ${{ secrets.DISTRIBUTION_ID }} --paths "/*"
 
+      - name: Slack Notification on Failure
+        if: ${{ failure() }}
+        uses: rtCamp/[email protected]
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_PRIVATE_TEAM_WEBHOOK }}
+          SLACK_USERNAME: "spectromate"
+          SLACK_ICON_EMOJI: ":robot_panic:"
+          SLACK_COLOR: "danger"
+          SLACKIFY_MARKDOWN: true
+          ENABLE_ESCAPES: true
+          SLACK_MESSAGE: "The self-hosted runner release job for `${{ github.workflow }}` in `${{ github.repository }}` failed at step: `${{ env.CURRENT_STEP }}`. [View details](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})."
+
+
 #  Use this workflow if you want to use the GitHub-hosted large runner. Useful for scenarios when you need a change to deploy faster than the self-hosted runner can build it.
   build-large-runner:
     if: ${{ github.event.inputs.useGitHubHostedLargeRunner == 'true' && github.event_name != 'schedule' }}
@@ -98,13 +115,14 @@ jobs:
           node-version: "20"
           cache: "npm"
 
-      - run: npm ci
+      - run: |
+          echo "CURRENT_STEP=npm ci" >> $GITHUB_ENV
+          npm ci
 
-      - name: Versions
-        run: |
       
       - name: Build
         run: |
+          echo "CURRENT_STEP=Build" >> $GITHUB_ENV
           touch .env
           make versions-ci
           make build-ci
@@ -117,10 +135,22 @@ jobs:
 
       - name: Upload to AWS
         run: |
+          echo "CURRENT_STEP=Upload to AWS" >> $GITHUB_ENV
           aws s3 sync --cache-control 'public, max-age=604800' --exclude '*.html' --exclude '*.xml' --exclude build/scripts/ build/ s3://docs.spectrocloud.com --delete
           aws s3 sync --cache-control 'public, max-age=0, s-maxage=604800' build/ s3://docs.spectrocloud.com --delete
           aws cloudfront create-invalidation --distribution-id ${{ secrets.DISTRIBUTION_ID }} --paths "/*"
 
+      - name: Slack Notification on Failure
+        if: ${{ failure() }}
+        uses: rtCamp/[email protected]
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_PRIVATE_TEAM_WEBHOOK }}
+          SLACK_USERNAME: "spectromate"
+          SLACK_ICON_EMOJI: ":robot_panic:"
+          SLACK_COLOR: "danger"
+          SLACKIFY_MARKDOWN: true
+          ENABLE_ESCAPES: true
+          SLACK_MESSAGE: "The large runner release job for `${{ github.workflow }}` in `${{ github.repository }}` failed at step: `${{ env.CURRENT_STEP }}`. [View details](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})."
 
   release:
     name: "Release"
@@ -152,9 +182,25 @@ jobs:
           cache: "npm"
 
       - name: Install dependencies
-        run: npm ci
+        run: |
+          echo "CURRENT_STEP=Install dependencies" >> $GITHUB_ENV
+          npm ci
 
       - name: "release"
         env:
           GITHUB_TOKEN: ${{ steps.import-secrets.outputs.VAULT_GITHUB_TOKEN }}
-        run: npx semantic-release
+        run: |
+          echo "CURRENT_STEP=release" >> $GITHUB_ENV
+          npx semantic-release
+
+      - name: Slack Notification on Failure
+        if: ${{ failure() }}
+        uses: rtCamp/[email protected]
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_PRIVATE_TEAM_WEBHOOK }}
+          SLACK_USERNAME: "spectromate"
+          SLACK_ICON_EMOJI: ":robot_panic:"
+          SLACK_COLOR: "danger"
+          SLACKIFY_MARKDOWN: true
+          ENABLE_ESCAPES: true
+          SLACK_MESSAGE: "The release job for `${{ github.workflow }}` in `${{ github.repository }}` failed at step: `${{ env.CURRENT_STEP }}`. [View details](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})."

Makefile

@@ -15,7 +15,12 @@ ALOGLIA_CONFIG=$(shell cat docsearch.dev.config.json | jq -r tostring)
 # Find all *.md files in docs, cut the prefix ./ 
 # Remove all security-bulletins and cve-reports.md because they are rate limited by nvd.nist.gov
 # Remove oss-licenses.md because they are rate limited by npmjs.com
-VERIFY_URL_PATHS=$(shell find ./docs -name "*.md" | cut -c 3- | sed '/security-bulletins/d' | sed '/cve-reports/d' | sed '/oss-licenses/d')
+# Remove all /deprecated paths because we don't want to maintain their links
+VERIFY_URL_PATHS=$(shell find ./docs -name "*.md" | cut -c 3- | \
+	sed '/security-bulletins/d' | \
+	sed '/cve-reports/d' | \
+	sed '/oss-licenses/d' | \
+	sed '/deprecated/d' )
 
 RATE_LIMITED_FILES_LIST:="docs/docs-content/security-bulletins/**/*.md" \
 	"docs/docs-content/security-bulletins/*.md" \

README.md

@@ -565,7 +565,9 @@ component will automatically display the badge in the correct color based on the
 ### 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
@@ -574,19 +576,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",
     },
   ]}
 />

_partials/getting-started/_cluster_observability.mdx

@@ -3,7 +3,7 @@ partial_category: getting-started
 partial_name: cluster-observability
 ---
 
-As we have seen throughout this tutorial, Palette exposes a set of workload metrics out-of-the-box to help cluster
+As we have seen throughout this tutorial, Palette exposes a set of workload metrics out of the box to help cluster
 administrators better understand the resource utilization of the cluster. The <VersionedLink text="workload metrics" url="/clusters/cluster-management/workloads/" /> in Palette are a snapshot in
 time and do not provide alerting capabilities.
 

_partials/getting-started/_getting-started_create-cluster-profile_spacetastic-end.mdx

@@ -6,7 +6,7 @@ partial_name: spacetastic-create-cluster-profile-end
 Wren and Kai have created their first Palette cluster profile by following the steps described in this guide. They are
 in good spirits, as the process has gone smoothly.
 
-> "The visual representation of cluster profiles in Palette is much clearer than our whiteboard." says Kai, glancing
+> "The visual representation of cluster profiles in Palette is much clearer than our whiteboard," says Kai, glancing
 > back at the list they have created. "I can keep track of which versions we are using in production just by reviewing
 > the profile. What are your thoughts, Wren? Have you remained a Palette skeptic?"
 >

_partials/getting-started/_getting-started_create-cluster-profile_spacetastic-intro.mdx

@@ -10,7 +10,7 @@ begin to map out all the dependencies of their systems and infrastructure.
 > making a lot of design decisions myself, as I was Spacetastic's Founding Engineer. It's really interesting to look
 > back on how much we've built and grown since those days!"
 >
-> Kai smiles and nods. "It's definitely been an out of this world ride!" they say. "I have a similar feeling when I
+> Kai smiles and nods. "It's definitely been an out-of-this-world ride!" they say. "I have a similar feeling when I
 > think about the infrastructure that I built in the early days as Platform Engineer. I will add our infrastructure
 > layers to your list. This process has the added bonus of giving us a chance to review which dependencies need to be
 > updated, so Meera, our security expert, will be happy too."

_partials/getting-started/_getting-started_deploy-cluster-tf_spacetastic-end.mdx

@@ -4,11 +4,11 @@ partial_name: spacetastic-deploy-cluster-tf-end
 ---
 
 Wren and Kai have followed this tutorial and have learned how Palette supports IaC through Terraform. They found the
-essentials covered to be a great introduction to IaC and gives them the confidence to kick off this initiative at
+essentials covered to be a great introduction to IaC, and it gives them the confidence to kick off this initiative at
 Spacetastic.
 
-> "I'd say that deploying Palette clusters with Terraform is even more convenient than through the UI." says Kai. "The
+> "I'd say that deploying Palette clusters with Terraform is even more convenient than through the UI," says Kai. "The
 > Palette Terraform provider includes a lot of the same functionality that the UI provides."
 >
-> "Yes! I definitely agree. I'm a Terraform novice and I could follow along with this tutorial." says Wren. "This has
+> "Yes! I definitely agree. I'm a Terraform novice and I could follow along with this tutorial," says Wren. "This has
 > definitely inspired me to make our IaC adoption a priority in the medium term future."

_partials/getting-started/_getting-started_deploy-cluster-tf_spacetastic-intro.mdx

@@ -4,15 +4,15 @@ partial_name: spacetastic-deploy-cluster-tf-intro
 ---
 
 After following the tutorials in the Getting Started section, the Spacetastic team have been have been impressed with
-its capabilities. Wren, Founding Engineer, and Kai, Platform Engineer, have been discussing adopting IaC workflows and
+Palette's capabilities. Wren, Founding Engineer, and Kai, Platform Engineer, have been discussing adopting IaC workflows and
 have been upskilling with Terraform throughout the past year. They are interested in learning if Palette can support IaC
 workflows too.
 
 > "While we're on the topic of platform improvements, it would be great to kick off our adoption of Infrastructure as
-> Code at Spacetastic." says Wren. "I've been wanting to roll this out for a while, but we don't have that much in-house
+> Code at Spacetastic," says Wren. "I've been wanting to roll this out for a while, but we don't have that much in-house
 > expertise."
 >
-> "Yes, this would definitely be a big improvement to our processes." says Kai, Platform Engineer. "Some people might
+> "Yes, this would definitely be a big improvement to our processes," says Kai, Platform Engineer. "Some people might
 > think that it slows down the development and release processes, due to the extra code reviews. However, the ability to
 > revert in the case of an outage more than makes up for this small drop in velocity."
 >

_partials/getting-started/_getting-started_deploy-cluster_spacetastic-end.mdx

@@ -6,17 +6,17 @@ partial_name: spacetastic-deploy-cluster-end
 Wren and Kai have deployed their first cluster profile by following the steps described in this tutorial. They were
 impressed by how streamlined the process was and how the cluster profiles provided them with a deployment blueprint.
 
-> "Deploying our first cluster with Palette was intuitive." says Wren. "It's ideal to find an external partner that can
+> "Deploying our first cluster with Palette was intuitive," says Wren. "It's ideal to find an external partner that can
 > take care of our Kubernetes infrastructure and free us up to deliver more educational features. I definitely think
 > that Palette has the capabilities to take care of all the Kubernetes heavy lifting for us."
 >
-> "I agree with you and I'm glad to hear you're not as skeptical anymore." says Kai, nodding and laughing. "From a
+> "I agree with you, and I'm glad to hear you're not as skeptical anymore," says Kai, nodding and laughing. "From a
 > platform engineering perspective, I can say that cluster profiles will provide us with reliable deployments across
 > environments and even clouds, so I'm much more confident about our testing and deployment strategy."
 >
-> Meera, Head of Cybersecurity, walks in holding a file. "I've done our security due diligence and I'm happy to report
+> Meera, Head of Cybersecurity, walks in holding a file. "I've done our security due diligence, and I'm happy to report
 > that Spectro Cloud adheres to the highest security standards. I'm happy to approve Palette for use in our
 > organization."
 >
 > "It seems like we've found a great platform that can support us. Let's explore the rest of the Getting Started section
-> to understand what else Palette has to offer." says Kai turning back to their monitor.
+> to understand what else Palette has to offer," says Kai, turning back to their monitor.

_partials/getting-started/_getting-started_deploy-cluster_spacetastic-intro.mdx

@@ -4,12 +4,12 @@ partial_name: spacetastic-deploy-cluster-intro
 ---
 
 After successfully creating their first cluster profile and mapping out their entire technology stack, Wren, Founding
-Engineer and Kai, Platform Engineer, continue their Palette onboarding process. They are evaluating Palette as a
-potential platform orchestration tool for all the production workloads at Spacetastic, who provide an astronomy
+Engineer, and Kai, Platform Engineer, continue their Palette onboarding process. They are evaluating Palette as a
+potential platform orchestration tool for all the production workloads at Spacetastic, which provides an astronomy
 education platform deployed on Kubernetes.
 
 > "The Getting Started section is a great way to learn about Palette. The hands-on approach is just what we need to get
-> our first cluster deployed." says Kai, scrolling through the Spectro Cloud Docs. "Wren, do you have time to continue
+> our first cluster deployed," says Kai, scrolling through the Spectro Cloud Docs. "Wren, do you have time to continue
 > our onboarding and get our first cluster deployed?"
 >
 > Wren sits down next to Kai and sips on a cup of coffee. "Now, we'll get a hands-on feel of the Palette developer

_partials/getting-started/_getting-started_landing-page_spacetastic-intro.mdx

@@ -4,19 +4,19 @@ partial_name: spacetastic-landing-intro
 ---
 
 Spacetastic Ltd., our fictional example company, is on a mission to teach its users about space. They have assembled a
-team of bright minds who are passionate about astronomy and the universe. They are a startup that is gaining popularity,
+team of bright minds who are passionate about astronomy and the universe. They are a startup that is gaining popularity
 as they expand their dashboards and grow their subscribers. Their small team has been in charge of developing new
 features alongside scaling and maintaining their infrastructure, but they are dedicated to providing the best astronomy
 education platform on Planet Earth.
 
 > "I'm the resident space expert around here!" says Anya, Lead Astrophycist, with a beaming smile. "My mission is to
 > make astrophysics, the science of space, accessible to everyone."
 >
-> "I'm here to support you and your mission. I build all the dashboards, pages and features that bring your vast space
+> "I'm here to support you and your mission. I build all the dashboards, pages, and features that bring your vast space
 > knowledge to our users in a beautiful visual format!" says Wren, Founding Engineer.
 >
 > Kai smiles and nods. "I work closely with both Wren and Anya. As Platform Engineer, I ensure that our platform is
-> reliable and scalable for everyone around the world, and beyond!"
+> reliable and scalable for everyone around the world and beyond!"
 >
 > Meera, Head of Cybersecurity, is the final member of the Spacetastic team. "Let's not forget about the security of our
 > platform. I make sure that our systems are designed and implemented with security in mind, the true SecDevOps way."
@@ -29,7 +29,7 @@ reliability SLA of at least 99% uptime. The following diagram presents an overvi
 
 ![Spacetastic system diagram](/getting-started/getting-started_landing_spacetastic-systems.webp)
 
-While the system architecture they have chosen was a great place to start, the team soon face common challenges that
+While the system architecture they have chosen was a great place to start, the team soon faced common challenges that
 many growing organizations encounter with Kubernetes.
 
 > Wren hurriedly walks into the office, looking at their phone with a worried expression. "Users are reporting on social
@@ -39,6 +39,6 @@ many growing organizations encounter with Kubernetes.
 > our services without further downtime, as soon as you are able to stabilize our platform."
 >
 > "Team, we need to rethink our platform engineering tools. We need a solution that can help us scale and deploy with
-> confidence, ultimately supporting the growth of our company." says Kai with a determined look.
+> confidence, ultimately supporting the growth of our company," says Kai with a determined look.
 
 ![Kubernetes challenges](/getting-started/getting-started_landing_kubernetes-challenges.webp)

_partials/getting-started/_getting-started_scale-secure-cluster_spacetastic-end.mdx

@@ -8,16 +8,16 @@ After going through the steps in the tutorial, Kai is confident in Palette's upg
 > "What have you found out, Kai?" says Meera walking over to Kai's desk. "Can I rely on Palette when a zero-day
 > vulnerability comes in?"
 >
-> "Yes, I know how stressful it is when those are reported." says Kai with a sympathetic nod. "I found out that Palette
+> "Yes, I know how stressful it is when those are reported," says Kai with a sympathetic nod. "I found out that Palette
 > has our security covered through their pack updates and scanning capabilities. Relying on this kind of tooling is
-> invaluable to security conscious engineers like us."
+> invaluable to security-conscious engineers like us."
 >
-> "Excellent! These capabilities will be a great addition to our existing systems at Spacetastic." says Meera with a big
+> "Excellent! These capabilities will be a great addition to our existing systems at Spacetastic," says Meera with a big
 > grin.
 >
 > "I'm so glad that we found a platform that can support everyone!" says Kai. "There is so much more to explore though.
 > I will keep reading through the Getting Started section and find out what additional capabilities Palette provides."
 >
-> "Good thinking, Kai." says Meera, nodding. "We should maximize all of Palette's features now that we have implemented
+> "Good thinking, Kai," says Meera, nodding. "We should maximize all of Palette's features now that we have implemented
 > it in production. We've got big ideas and goals on our company roadmap, so let's find out how Palette can help us
 > deliver them."