[site,#957,seo][s]: improves descriptions for pages

datopian · Aug 10, 2023 · ea5dade · ea5dade
1 parent 8027026
commit ea5dade
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 29 deletions.
diff --git a/site/content/docs/creating-new-datasets.md b/site/content/docs/creating-new-datasets.md
@@ -1,6 +1,6 @@
 ---
 title: 'Creating new datasets'
-description: 'Learn how to create new datasets on a data portal'
+description: 'Learn how to create new datasets and an index for all datasets on a data portal built with PortalJS'
 ---
 
 So far, the PortalJS app we created only has a single page displaying a dataset. Data catalogs and data portals generally showcase many different datasets.

diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md
@@ -1,6 +1,6 @@
 ---
 title: Deploying your PortalJS app
-description: 'Learn to deploy PortalJS apps'
+description: 'Learn how to deploy PortalJS apps to Vercel and Cloudflare'
 ---
 
 Finally, let's learn how to deploy PortalJS apps to Vercel or Cloudflare Pages.

diff --git a/site/content/docs/index.md b/site/content/docs/index.md
@@ -1,6 +1,6 @@
 ---
 title: Getting Started
-description: 'Getting started guide and tutorial about data portal-building with PortalJS'
+description: 'Getting started guide and tutorial about data portal-building with PortalJS!'
 ---
 
 Welcome to the PortalJS documentation!

diff --git a/site/content/docs/searching-datasets.md b/site/content/docs/searching-datasets.md
@@ -1,6 +1,6 @@
 ---
 title: Searching datasets
-description: "Learn how to create a searchable datasets index"
+description: 'Learn how to create a searchable datasets index with facets on a PortalJs data portal'
 ---
 
 Typing out every link in the index page will get cumbersome eventually, and as the portal grows, finding the datasets you are looking for on the index page will become harder and harder, for that we will need search functionality.

diff --git a/site/content/docs/showing-metadata.md b/site/content/docs/showing-metadata.md
@@ -1,6 +1,6 @@
 ---
 title: Showing metadata 
-description: "Learn how to display metadata on the dataset page of a data portal"
+description: "Learn how to display metadata on the dataset page of a data portal built with PortalJS"
 ---
 
 If you go now to `http://localhost:3000/my-awesome-dataset`, you will see that we now have two titles on the page. That's because `title` is one of the default metadata fields supported by PortalJS.

diff --git a/site/content/howtos/analytics.md b/site/content/howtos/analytics.md
@@ -1,6 +1,6 @@
 ---
 title: How to add Google Analytics?
-description: Learn to implement Google Analytics on PortalJS data portals
+description: Learn how to implement Google Analytics on PortalJS data portals
 ---
 
 >[!todo] Prerequisites

diff --git a/site/content/howtos/blog.md b/site/content/howtos/blog.md
@@ -1,6 +1,6 @@
 ---
 title: How to add a simple blog?
-description: How to add a simple blog on a PortalJS data portal
+description: Learn how to add a simple blog on a PortalJS data portal
 ---
 
 ## Setup
@@ -16,32 +16,32 @@ npm i @portaljs/core
 Add the following code to the Next.js page that is going to be your blog home page, e.g. to `/pages/blog/index.tsx`:
 
 ```tsx
-import { BlogsList, SimpleLayout } from "@portaljs/core";
+import { BlogsList, SimpleLayout } from '@portaljs/core';
 
 // pass a list of blogs, home page title and home page description, e.g. from `getStaticProps`
 export default function BlogIndex({ blogs, title, description }) {
-    return (
-        <SimpleLayout title={title} description={description}>
-            <BlogsList blogs={blogs} />
-        </SimpleLayout>
-    );
+  return (
+    <SimpleLayout title={title} description={description}>
+      <BlogsList blogs={blogs} />
+    </SimpleLayout>
+  );
 }
 ```
 
 `BlogsList` component has the following API:
 
 ```ts
 interface BlogsListProps {
-	blogs: Blog;
+  blogs: Blog;
 }
 
 interface Blog {
-	title: string;
-	date: string;
-	urlPath: string;
-	description?: string;
-	authors?: Array<string>;
-	tags?: Array<string>;	
+  title: string;
+  date: string;
+  urlPath: string;
+  description?: string;
+  authors?: Array<string>;
+  tags?: Array<string>;
 }
 ```
 
@@ -57,22 +57,22 @@ export default BlogPost({ content, title, date, authors }) {
 		<BlogLayout title={title} date={date} authors={authors}
 			{content}
 		</BlogLayout>
-	)	
+	)
 }
 ```
 
 `BlogLayout` component has the following API:
 
 ```ts
 interface BlogLayoutProps {
-	title?: string;
-	date?: string;
-	authors?: Array<Author>;
+  title?: string;
+  date?: string;
+  authors?: Array<Author>;
 }
 
 interface Author {
-	name: string;
-	avatar: string; // avatar image path
-	urlPath?: string; // author page
+  name: string;
+  avatar: string; // avatar image path
+  urlPath?: string; // author page
 }
 ```
diff --git a/site/content/howtos/seo.md b/site/content/howtos/seo.md
@@ -1,6 +1,6 @@
 ---
 title: How to customize page metadata for SEO?
-description: Learn to customize page metadata for SEO on data portals with PortalJS
+description: Learn how to customize page metadata for SEO on data portals built with PortalJS
 ---
 
 >[!info]

diff --git a/site/content/howtos/sitemap.md b/site/content/howtos/sitemap.md
@@ -1,6 +1,6 @@
 ---
 title: How to build a sitemap?
-description: Learn how to build a sitemap for a data portal with PortalJS
+description: Learn how to build a sitemap for a data portal built with PortalJS
 ---
 
 ## Setup