🐛 Issue #24: Link Description is for Gatsby

adobe · Sep 15, 2020 · 58887f7 · 58887f7
1 parent 05ccedc
commit 58887f7
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 8 deletions.
diff --git a/configs/global.js b/configs/global.js
@@ -10,8 +10,8 @@ module.exports = {
   pathPrefix: `${process.env.GATSBY_SITE_PATH_PREFIX}`,
   siteMetadata: {
     title: `${process.env.GATSBY_SOURCE_TITLE}`,
-    description: `Kick off your next, great Gatsby project with this default starter. This barebones starter ships with the main Gatsby configuration files you might need.`,
-    author: `@gatsbyjs`,
+    description: ``,
+    author: `@adobedevs`,
   },
   plugins: [
     `gatsby-plugin-react-helmet`,

diff --git a/gatsby-node.js b/gatsby-node.js
@@ -89,6 +89,7 @@ const searchTree = (theObject, matchingFilename) => {
 
 const readManifest = async graphql => {
   let pages = []
+  let description = ""
   try {
     let { data } = await graphql(`
       query {
@@ -108,6 +109,7 @@ const readManifest = async graphql => {
         const object = JSON.parse(fs.readFileSync(path, "utf8"))
         if (object.view_type === "mdbook") {
           pages = object.pages
+          description = object.description
         }
       })
     }
@@ -116,7 +118,7 @@ const readManifest = async graphql => {
     console.log("Could not read the manifest")
   }
 
-  return pages
+  return { pages, description }
 }
 
 const gitRepoInfo = () => {
@@ -197,7 +199,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
   const openapiTemplate = path.resolve(`src/templates/openapiTemplate.js`)
   const indexTemplate = path.resolve(`src/templates/indexTemplate.js`)
 
-  const pages = await readManifest(graphql)
+  const { pages, description } = await readManifest(graphql)
   const gitRemote = gitRepoInfo(graphql)
 
   try {
@@ -230,6 +232,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
                 slug: node.fields.slug,
                 id: node.fields.id,
                 seo: seo,
+                description: description,
                 gitRemote: gitRemote,
                 pages: pages,
               },
@@ -242,6 +245,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
                 slug: node.fields.slug,
                 id: node.fields.id,
                 seo: seo,
+                description: description,
                 gitRemote: gitRemote,
                 pages: pages,
               },
@@ -280,6 +284,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
           object,
           filepath,
           seo,
+          description,
           gitRemote,
           pages
         )
@@ -316,6 +321,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
             object,
             filepath,
             seo,
+            description,
             gitRemote,
             pages
           )
@@ -367,6 +373,7 @@ const createOpenApiPage = (
   object,
   filepath,
   seo,
+  description,
   gitRemote,
   pages
 ) => {
@@ -376,7 +383,9 @@ const createOpenApiPage = (
     switch (environment) {
       case "production":
         if (filepath.lastIndexOf("gatsby-source-git/") > -1) {
-          slug = filepath.substring(filepath.lastIndexOf("gatsby-source-git/") + 18)
+          slug = filepath.substring(
+            filepath.lastIndexOf("gatsby-source-git/") + 18
+          )
         }
         break
       case "development":
@@ -435,6 +444,7 @@ const createOpenApiPage = (
       context: {
         spec: object,
         seo: seo,
+        description: description,
         gitRemote: gitRemote,
         pages: pages,
       },

diff --git a/src/templates/markdownTemplate.js b/src/templates/markdownTemplate.js
@@ -38,7 +38,10 @@ const MarkdownTemplate = props => {
 
   return (
     <DocLayout>
-      <SEO title={props.pageContext.seo} />
+      <SEO
+        title={props.pageContext.seo}
+        description={props.pageContext.description}
+      />
       <Grid>
         <GridNav>
           <SiteNav

diff --git a/src/templates/openapiTemplate.js b/src/templates/openapiTemplate.js
@@ -29,7 +29,7 @@ import {
 const OpenApiTemplate = ({ pageContext, location }) => {
   return (
     <DocLayout>
-      <SEO title={pageContext.seo} />
+      <SEO title={pageContext.seo} description={pageContext.description} />
       <OpenApiGrid>
         <OpenApiGridNav>
           <SiteNav

diff --git a/src/templates/recipeTemplate.js b/src/templates/recipeTemplate.js
@@ -37,7 +37,10 @@ const MarkdownTemplate = props => {
 
   return (
     <DocLayout>
-      <SEO title={props.pageContext.seo} />
+      <SEO
+        title={props.pageContext.seo}
+        description={props.pageContext.description}
+      />
       <Grid>
         <GridNav>
           <SiteNav