Merge pull request #3847 from adamdmharvey/cost-insights-rewording

fix(cost-insights): Update instruction examples to fix links and rewording

.changeset/lucky-fans-wait.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-cost-insights': patch
+---
+
+Fix links in sample instructions

plugins/cost-insights/src/components/LabelDataflowInstructionsPage/LabelDataflowInstructionsPage.tsx

@@ -16,7 +16,7 @@
 
 import React from 'react';
 import { Box, Typography } from '@material-ui/core';
-import { CodeSnippet } from '@backstage/core';
+import { CodeSnippet, Link } from '@backstage/core';
 import { AlertInstructionsLayout } from '../AlertInstructionsLayout';
 
 export const LabelDataflowInstructionsPage = () => {
@@ -31,10 +31,10 @@ export const LabelDataflowInstructionsPage = () => {
       </Typography>
       <Typography paragraph>
         In Cloud Dataflow, labels can be added to a job either programmatically
-        or via the command-line when launching a job. Note that GCP has
-        <a href="https://cloud.google.com/compute/docs/labeling-resources#restrictions">
+        or via the command-line when launching a job. Note that GCP has{' '}
+        <Link to="https://cloud.google.com/compute/docs/labeling-resources#restrictions">
           restrictions
-        </a>{' '}
+        </Link>{' '}
         on the length and characters that can be used in labels.
       </Typography>
       <Typography paragraph>
@@ -46,9 +46,9 @@ export const LabelDataflowInstructionsPage = () => {
         <Typography variant="h3">DataflowPipelineOptions</Typography>
         <Typography paragraph>
           Dataflow jobs using Beam's{' '}
-          <a href="https://beam.apache.org/releases/javadoc/2.3.0/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html">
+          <Link to="https://beam.apache.org/releases/javadoc/2.3.0/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html">
             DataflowPipelineOptions
-          </a>{' '}
+          </Link>{' '}
           directly can use the <b>setLabels</b> function to add one or more
           labels:
           <CodeSnippet
@@ -79,13 +79,13 @@ sc.optionsAs[DataflowPipelineOptions].setLabels(Map("job-id" -> "my-dataflow-job
         </Typography>
         <Typography paragraph>
           For more information on specifying options, see the{' '}
-          <a href="https://cloud.google.com/dataflow/docs/guides/specifying-exec-params">
+          <Link to="https://cloud.google.com/dataflow/docs/guides/specifying-exec-params">
             Dataflow documentation
-          </a>{' '}
+          </Link>{' '}
           or{' '}
-          <a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioContext.html">
+          <Link to="https://spotify.github.io/scio/api/com/spotify/scio/ScioContext.html">
             Scio Scaladoc
-          </a>
+          </Link>
           .
         </Typography>
       </Box>

plugins/cost-insights/src/components/ProjectGrowthInstructionsPage/ProjectGrowthInstructionsPage.tsx

@@ -135,7 +135,7 @@ export const ProjectGrowthInstructionsPage = () => {
         <Typography paragraph>
           Next, evaluate whether the growth is significant. This helps avoid
           premature optimization, where cost in engineering time is more than
-          would be saved from the optimization over a reasonable timeframe.
+          would be saved from the optimization over a reasonable time frame.
         </Typography>
         <Typography paragraph>
           We recommend reframing the cost growth itself in terms of engineering
@@ -205,7 +205,7 @@ export const ProjectGrowthInstructionsPage = () => {
           Is the workload using cloud resources efficiently? For compute
           resources, do the utilization metrics look reasonable? Autoscaling
           infrastructure, such as Kubernetes, can run workloads more efficiently
-          without comprimising reliability.
+          without compromising reliability.
         </Typography>
         <Typography variant="h5">Lifecycle</Typography>
         <Typography paragraph>