feat(pie-docs): DSW-1884 remove /overview from designers and engineers (

#1566)

* feat(pie-docs): DSW-1884 remove /overview from url of remaining pages

* feat(pie-docs): DSW-1884 remove /overview from designers and engineers

.changeset/thin-pants-dance.md

@@ -0,0 +1,5 @@
+---
+"pie-docs": minor
+---
+
+[Changed] - Removed /overview urls from designers, engineers sections and use overview content as the index.html of each directory. I.e. /designers/getting-started for the overview page instead of /designers/getting-started/overview.

apps/pie-docs/src/designers/getting-started/getting-started.md

@@ -4,5 +4,6 @@ eleventyNavigation:
     title: Getting started
     parent: designers
     order: 1
-    url: /designers/getting-started/overview/
+    url: /designers/getting-started/
+permalink: false
 ---

apps/pie-docs/src/designers/getting-started/overview.md

@@ -3,6 +3,7 @@ eleventyNavigation:
     key: Overview
     parent: designers-getting-started
     order: 1
+permalink: designers/getting-started/
 ---
 
 ## Introduction
@@ -28,8 +29,8 @@ PIE is split into three parts: **foundations**, **components** and **assets**. E
 You'll need to enable these libraries in Figma if you want to use the PIE design system in your products.
 
 {% contentPageImage {
-src: "../../../assets/img/designers/getting-started/overview/libraries-wheel.svg",
-mobileSrc: "../../../assets/img/designers/getting-started/overview/libraries-wheel_narrow.svg",
+src: "../../../assets/img/designers/getting-started/libraries-wheel.svg",
+mobileSrc: "../../../assets/img/designers/getting-started/libraries-wheel_narrow.svg",
 width: "512px",
 caption: "A map of how PIE libraries are structured in Figma."
 } %}
@@ -73,18 +74,18 @@ If you need more detail on JET's visual and verbal standards, you've come to the
         {
           linkText: "JET Brand Guidelines",
           href: "https://brand-box.marketing.just-eat.com/",
-          src: "../../../assets/img/designers/getting-started/overview/document-placeholder.svg"
+          src: "../../../assets/img/designers/getting-started/document-placeholder.svg"
         },
         {
           linkText: "Global Brand Voice",
           href: "https://docs.google.com/presentation/d/1YXtsfzmIXfc5CAk1TsV9YQ21O9V4G9WK6J4elC3YmEI/edit#slide=id.gb6f3deb72f_0_702",
-          src: "../../../assets/img/designers/getting-started/overview/document-placeholder.svg",
+          src: "../../../assets/img/designers/getting-started/document-placeholder.svg",
           shouldOpenInNewTab: true
         },
         {
           linkText: "2022 UI copy style guide ",
           href: "https://docs.google.com/document/d/1aAyCnyBfNO_ErWORPqKoZ9DVF480ra1VvToQ0YFfm0I/edit",
-          src: "../../../assets/img/designers/getting-started/overview/document-placeholder.svg",
+          src: "../../../assets/img/designers/getting-started/document-placeholder.svg",
           shouldOpenInNewTab: true
         }
     ]

apps/pie-docs/src/engineers/getting-started/getting-started.md

@@ -4,5 +4,6 @@ eleventyNavigation:
     title: Getting started
     parent: engineers
     order: 1
-    url: /engineers/getting-started/overview/
+    url: /engineers/getting-started/
+permalink: false
 ---

apps/pie-docs/src/engineers/getting-started/overview.md

@@ -3,6 +3,7 @@ eleventyNavigation:
     key: Overview
     parent: engineers-getting-started
     order: 1
+permalink: engineers/getting-started/
 ---
 
 ## Introduction
@@ -27,7 +28,7 @@ We also help to maintain a number of other projects that incorporate the PIE Des
 
 If you'd like to contribute to PIE, check out our [contributing guide](/engineers/contributing/).
 
-We also maintain **guides** for global front-end best practices across JET. These can be found in the [engineering guidelines section of our docs](/engineers/guidelines/overview).
+We also maintain **guides** for global front-end best practices across JET. These can be found in the [engineering guidelines section of our docs](/engineers/guidelines/).
 
 
 <!-- N.B. for the future – we should include a components summary section here like this when we want to start advertising our components:

apps/pie-docs/src/engineers/guidelines/guidelines.md

@@ -4,5 +4,6 @@ eleventyNavigation:
     title: Guidelines
     parent: engineers
     order: 1
-    url: /engineers/guidelines/overview/
+    url: /engineers/guidelines/
+permalink: false
 ---

apps/pie-docs/src/engineers/guidelines/overview.md

@@ -4,6 +4,7 @@ eleventyNavigation:
     title: Overview
     parent: engineers-guidelines
     order: 1
+permalink: engineers/guidelines/
 ---
 
 Here is a list of guidelines that the PIE Design Team currently maintain:

apps/pie-docs/src/index.md

@@ -16,7 +16,7 @@ heroCtaHref: /all-about-pie/what-is-pie
           linkText: "Get started",
           icon: "bulb-lightning",
           iconColour: "support-brand-03",
-          href: "/designers/getting-started/overview/",
+          href: "/designers/getting-started/",
           headingLevel: "3",
           isInternalLink: "true"
         },
@@ -26,7 +26,7 @@ heroCtaHref: /all-about-pie/what-is-pie
           linkText: "Get started",
           icon: "engineers",
           iconColour: "support-brand-04",
-          href: "/engineers/getting-started/overview/",
+          href: "/engineers/getting-started/",
           headingLevel: "3",
           isInternalLink: "true"
         },

apps/pie-docs/src/patterns/cookie-banner/cookie-banner.md

@@ -2,7 +2,8 @@
 eleventyNavigation:
     key: 'Cookie Banner'
     parent: Patterns
-    url: /patterns/cookie-banner/overview/
+    url: /patterns/cookie-banner/
     order: 1
 title: 'Cookie Banner'
+permalink: false
 ---

apps/pie-docs/src/patterns/cookie-banner/overview/overview.md

@@ -4,6 +4,7 @@ eleventyNavigation:
     parent: 'Cookie Banner'
     order: 1
 shouldShowContents: true
+permalink: patterns/cookie-banner/
 ---
 
 

apps/pie-docs/src/support/faq.md

@@ -35,7 +35,7 @@ Please check our contributing guidelines for [Designers](/designers/contributing
 
 ## How do I get started with PIE?
 
-We are here to help you get set up! Please check [Designers](/designers/getting-started/overview) and [Engineers](/engineers/getting-started/overview) to get started with PIE, or reach out directly if you just want to start a conversation about how PIE can help you or your team.
+We are here to help you get set up! Please check [Designers](/designers/getting-started/) and [Engineers](/engineers/getting-started/) to get started with PIE, or reach out directly if you just want to start a conversation about how PIE can help you or your team.
 
 ---
 

apps/pie-docs/test/helpers/routes-helper.js

@@ -37,7 +37,7 @@ const readChildren = (childDirectories, result = []) => {
     // This allows us to include urls such as /foundations, /foundations/typography, etc.
     // Some of these pages should display a 404 page but we still want to include them in our routes as they technically exist.
     const hasIndexHtmlChild = childDirectories.children.some((child) => child.name === 'index.html');
-    const directoriesToInclude = ['foundations', 'components'];
+    const directoriesToInclude = ['accessibility', 'all-about-pie', 'foundations', 'components', 'designers', 'engineers', 'patterns', 'support'];
     const shouldInclude = directoriesToInclude.some((dir) => childDirectories.relativePath.includes(dir));
 
     if (hasIndexHtmlChild && shouldInclude) {

apps/pie-docs/test/snapshots/expected-routes.snapshot.json

@@ -1,8 +1,10 @@
 [
     "404.html",
+    "accessibility",
     "accessibility/overview",
     "accessibility/resources",
     "accessibility/testing-for-accessibility",
+    "all-about-pie",
     "all-about-pie/our-vision",
     "all-about-pie/roadmap",
     "all-about-pie/what-is-pie",
@@ -76,16 +78,18 @@
     "components/toast",
     "components/tooltip",
     "components/uploader",
+    "designers",
     "designers/contributing",
+    "designers/getting-started",
     "designers/getting-started/best-practices",
     "designers/getting-started/figma-files",
-    "designers/getting-started/overview",
     "designers/how-we-support-you",
+    "engineers",
     "engineers/contributing",
-    "engineers/getting-started/overview",
+    "engineers/getting-started",
     "engineers/getting-started/structure",
+    "engineers/guidelines",
     "engineers/guidelines/browser-support",
-    "engineers/guidelines/overview",
     "foundations",
     "foundations/colour",
     "foundations/colour/tokens/alias/dark",
@@ -116,8 +120,10 @@
     "foundations/typography/tokens/alias/narrow",
     "foundations/typography/tokens/alias/wide",
     "foundations/typography/tokens/global",
+    "patterns",
+    "patterns/cookie-banner",
     "patterns/cookie-banner/code",
-    "patterns/cookie-banner/overview",
+    "support",
     "support/contact-us",
     "support/faq"
 ]