Clean up README and env vars (#994)

README.md

@@ -19,47 +19,43 @@ yarn dev
 
 Create and run a production build locally\*\*\*:
 
-\*\*\* Will require `AEM_GRAPHQL_ENDPOINT=https://www.canada.ca/content/_cq_graphql/decd-endc/endpoint.json` and `ADOBE_ANALYTICS_URL=` the second being avariable with no value. These env vars should be in a top-level .env file
+\*\*\* Will require `AEM_GRAPHQL_ENDPOINT=https://www.canada.ca/content/_cq_graphql/decd-endc/endpoint.json`
 
 ```bash
 yarn build
 yarn start
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) with your browser.
 
 ## Configuration
 
-There are two required variables: `AEM_GRAPHQL_ENDPOINT=https://www.canada.ca/content/_cq_graphql/decd-endc/endpoint.json` and `ADOBE_ANALYTICS_URL=`
+There is one required variable: `AEM_GRAPHQL_ENDPOINT=https://www.canada.ca/content/_cq_graphql/decd-endc/endpoint.json`
 
-`AEM_GRAPHQL_ENDPOINT` is used to fetch the data for pages and components across the site.
+`AEM_GRAPHQL_ENDPOINT` is used to fetch the content, and for some pages (articles), the structure of the pages on the site.
 
-## Enabling Report a Problem
+## Enabling Submit Feedback
 
 Required environment variables:
 
 ```code
-REPORT_A_PROBLEM_ENABLED=true
 NOTIFY_BASE_API_URL=https://api.notification.canada.ca
-NOTIFY_REPORT_A_PROBLEM_EMAIL=email which will receive the feedback from the form
 NOTIFY_API_KEY=ask for this
-NOTIFY_REPORT_A_PROBLEM_TEMPLATE_ID=ask for this
+NOTIFY_FEEDBACK_TEMPLATE_ID=ask for this
+SUBMIT_FEEDBACK_EMAIL=ask for this
 ```
 
-1. Ask the dev team for GCNotify API key and template keys
+1. Ask the dev team for GCNotify API key, template keys and feedback email
 
 2. Start the application as usual
 
 ## Environment Variables
 
 Here is a list of all the environment variables used to configure the application along with what they do.
 
-`REPORT_A_PROBLEM_ENABLED`: Feature flag for the report a problem API to enable sending to GC Notify. Leave undefined if
-you do not want to enable this.
+`NOTIFY_FEEDBACK_TEMPLATE_ID`: The Notify template ID for the submit feedback template
 
-`NEXT_PUBLIC_NOTIFY_REPORT_A_PROBLEM_TEMPLATE_ID`: The Notify template ID for the report a problem email template
-
-`NEXT_PUBLIC_NOTIFY_REPORT_A_PROBLEM_EMAIL`: The email to send it to
+`SUBMIT_FEEDBACK_EMAIL`: The email to which feedback will be sent
 
 `NOTIFY_API_KEY`: The [Notify API key](https://documentation.notification.canada.ca/en/start.html#headers)
 
@@ -68,6 +64,8 @@ you do not want to enable this.
 `ADOBE_ANALYTICS_URL`: URL for adobe analytics. It is found in the documentation for Adobe Analytics
 installation.
 
+`ISR_ENABLED`: Whether Incremental Static Regeneration should be enabled on pages that leverage it.
+
 ## Checking Deployed Version
 Run the following bash script to check whether the latest (on `main`) has been deployed to various environments:
 ```bash

lib/notify/postFeedbackToGcNotify.js

@@ -8,7 +8,7 @@ export async function postFeedbackToGcNotify(data) {
         Authorization: `ApiKey-v1 ${process.env.NOTIFY_API_KEY}`,
       },
       body: JSON.stringify({
-        email_address: process.env.THANK_YOU_EMAIL,
+        email_address: process.env.SUBMIT_FEEDBACK_EMAIL,
         template_id: process.env.NOTIFY_FEEDBACK_TEMPLATE_ID,
         personalisation: {
           ...data,

pages/home.js

@@ -422,6 +422,6 @@ export const getStaticProps = async ({ locale }) => {
       experimentsData: experimentsData.sclabsPageV1List.items,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/benefits-navigator/[id].js

@@ -130,6 +130,6 @@ export const getStaticProps = async ({ locale, params }) => {
       adobeAnalyticsUrl: process.env.ADOBE_ANALYTICS_URL ?? null,
       ...(await serverSideTranslations(locale, ["common", "vc"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/benefits-navigator/index.js

@@ -738,6 +738,6 @@ export const getStaticProps = async ({ locale }) => {
       dictionary: dictionary.dictionaryV1List,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/dashboard/index.js

@@ -810,6 +810,6 @@ export const getStaticProps = async ({ locale }) => {
       dictionary: dictionary.dictionaryV1List,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/digital-standards-playbook/[id].js

@@ -133,6 +133,6 @@ export const getStaticProps = async ({ locale, params }) => {
       adobeAnalyticsUrl: process.env.ADOBE_ANALYTICS_URL ?? null,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/digital-standards-playbook/index.js

@@ -478,6 +478,6 @@ export const getStaticProps = async ({ locale }) => {
       dictionary: dictionary.dictionaryV1List,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/making-easier-get-benefits/[id].js

@@ -133,6 +133,6 @@ export const getStaticProps = async ({ locale, params }) => {
       adobeAnalyticsUrl: process.env.ADOBE_ANALYTICS_URL ?? null,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/making-easier-get-benefits/index.js

@@ -373,6 +373,6 @@ export const getStaticProps = async ({ locale }) => {
       dictionary: dictionary.dictionaryV1List,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/oas-benefits-estimator/[id].js

@@ -133,6 +133,6 @@ export const getStaticProps = async ({ locale, params }) => {
       adobeAnalyticsUrl: process.env.ADOBE_ANALYTICS_URL ?? null,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };

pages/projects/oas-benefits-estimator/index.js

@@ -430,6 +430,6 @@ export const getStaticProps = async ({ locale }) => {
       dictionary: dictionary.dictionaryV1List,
       ...(await serverSideTranslations(locale, ["common"])),
     },
-    revalidate: process.env.ENVIRONMENT === "development" ? 10 : false,
+    revalidate: process.env.ISR_ENABLED === "true" ? 10 : false,
   };
 };