Improved seo docs page #297

NeroxTGC · 2024-10-20T10:04:41Z

Description

Added Other Pages Meta Tags & Structured data and Schema markup.

Contributor Checklist

Make sure to do the following steps if they are applicable to your PR:

Update e2e tests: If you changed the /template/app, then make sure to do any neccessary updates to /template/e2e-tests also.
Update demo app: If you changed the /template/app, then make sure to do any neccessary updates to /opensaas-sh/app_diff also. Check /opensaas-sh/README.md for details.
Update docs: If needed, update the /opensaas-sh/blog/src/content/docs.

Added Other Pages Meta Tags & Structured data and Schema markup

Update seo.md

Martinsos

Awesome work @NeroxTGC , thanks for this!
I think this generaly makes sense and looks good -> I left some comments, but nothing major I believe, let's take care of those and we can merge!

Martinsos · 2024-10-22T18:31:01Z

opensaas-sh/blog/src/content/docs/guides/seo.md

+:::note[Important]
+By default, all pages will acquire the main Landing Page meta tags. You can set custom meta tags for each page using `react-helmet-async`.
+:::


I think we can probably just take this out of :::note, make it normal text. I understand it was meant to emphasize it as the most important thing here, which it is, but it actually fits well into the normal flow of the reading while :::notes break it a bit.

@NeroxTGC what happened to this part, you removed it? I thought it was a quite good intro and explanation, seems shame to not have it! What I was suggesting was just to not have it as a "note", but as a normal parapgrah.

opensaas-sh/blog/src/content/docs/guides/seo.md

Martinsos · 2024-10-22T18:59:32Z

opensaas-sh/blog/src/content/docs/guides/seo.md

+## Structured data and Schema markup
+
+:::note[Tip]
+Crawlers do all the work of analyzing and understanding the content of your pages, and they will thank you if you include structured data to help them understand what your content is about!🤗.
+:::
+
+You can add structured data for each page.
+
+```jsx {14-22}
+//...
+import { Helmet, HelmetProvider } from 'react-helmet-async';
+
+export function MyCustomPage() {
+  return (
+    <div>
+      <Helmet>
+        <title>My Custom Page Title</title>
+        <meta
+          name='description'
+          content='This is the meta description of my page.'/>
+        <link rel='canonical' href='https://example.com/my-custom-page' />
+        //...
+
+        <script type='application/ld+json'>{`
+  {
+    "@context": "https://schema.org",
+    "@type": "SoftwareApplication",
+    "name": "title",
+    "url": "https://yoururl.com",
+    "description": "Description",
+    }
+  }
+`}  </script>
+
+      </Helmet>
+      //...
+```
+
+
+These resources provide the information needed to get the most out of structured data:
+- [Introduction to structured data markup](https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data)
+- [General structured data guidelines](https://developers.google.com/search/docs/appearance/structured-data/sd-policies)
+
+After you have a small notion about them, you can go deeper by adding custom functions depending on your app (FAQs, Rating, Review, Software Application...):
+- [ALL structured data functions](https://developers.google.com/search/docs/appearance/structured-data/search-gallery)
+
+To ensure that they are valid:
+- [Google rich results test](https://search.google.com/test/rich-results)
+- [Schema validator](https://validator.schema.org/)


This dive intro structured data might and schema markup might be a bit beyond the scope of this docs. That said, we can provide a sentence or two about it + a single link, or max two, where they can read about them. Meaning we can significantly shorten this part and throw out the code example!

@NeroxTGC ping on this - what do you think?

NeroxTGC · 2024-11-22T11:59:15Z

@Martinsos I finished updating the document with your suggested changes. If you like, check it one last time.

I've also created a robots.tsx default for the template and fixed the missing alts on the images to make the Landing Page 100% Seo Score.

opensaas-sh/blog/src/content/docs/guides/seo.md

Martinsos · 2024-11-28T16:18:50Z

opensaas-sh/blog/src/content/docs/guides/seo.md

+export default function App() {
+    return (
+    <HelmetProvider>
+      <>


@NeroxTGC what about this one?

opensaas-sh/blog/src/content/docs/guides/seo.md

Martinsos · 2024-11-28T16:22:09Z

opensaas-sh/blog/src/content/docs/guides/seo.md

+
+```jsx {14-22}
+//...
+import { Helmet, HelmetProvider } from 'react-helmet-async';


redundant import of helmet provider

Martinsos · 2024-11-28T16:24:01Z

opensaas-sh/blog/src/content/docs/guides/seo.md

+## Structured data and Schema markup
+
+:::note[Tip]
+Crawlers do all the work of analyzing and understanding the content of your pages, and they will thank you if you include structured data to help them understand what your content is about!🤗.
+:::
+
+You can add structured data for each page.
+
+```jsx {14-22}
+//...
+import { Helmet, HelmetProvider } from 'react-helmet-async';
+
+export function MyCustomPage() {
+  return (
+    <div>
+      <Helmet>
+        <title>My Custom Page Title</title>
+        <meta
+          name='description'
+          content='This is the meta description of my page.'/>
+        <link rel='canonical' href='https://example.com/my-custom-page' />
+        //...
+
+        <script type='application/ld+json'>{`
+  {
+    "@context": "https://schema.org",
+    "@type": "SoftwareApplication",
+    "name": "title",
+    "url": "https://yoururl.com",
+    "description": "Description",
+    }
+  }
+`}  </script>
+
+      </Helmet>
+      //...
+```
+
+
+These resources provide the information needed to get the most out of structured data:
+- [Introduction to structured data markup](https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data)
+- [General structured data guidelines](https://developers.google.com/search/docs/appearance/structured-data/sd-policies)
+
+After you have a small notion about them, you can go deeper by adding custom functions depending on your app (FAQs, Rating, Review, Software Application...):
+- [ALL structured data functions](https://developers.google.com/search/docs/appearance/structured-data/search-gallery)
+
+To ensure that they are valid:
+- [Google rich results test](https://search.google.com/test/rich-results)
+- [Schema validator](https://validator.schema.org/)


@NeroxTGC ping on this - what do you think?

Martinsos

@NeroxTGC nice, there is still some stuff to fix though, I commented!

Martinsos · 2024-11-28T16:28:52Z

template/app/public/robots.txt

+Disallow: /api/
+Disallow: /auth/


hm so api and auth here - do we need that? because those are parts of the server, and server is not hosted at the same url as client, at least not usually.

updated, you are right.

Co-authored-by: Martin Šošić <[email protected]>

NeroxTGC · 2024-12-13T12:37:07Z

Seo Guide

Removed the extra <>.
Removed redundant HelmetProvider.
Shortened the section on structured data.

OpenSaaS template

Removed /api/ & /auth/ from robots.txt

@Martinsos I don't think I've missed anything now, right?

NeroxTGC added 4 commits October 20, 2024 11:59

Update seo.md

5d22ee7

Added Other Pages Meta Tags & Structured data and Schema markup

Update seo.md

3c0883b

Update seo.md

2505189

Added Other Pages Meta Tags & Structured data and Schema markup

Merge pull request #1 from NeroxTGC/NeroxTGC-patch-1

5a801b4

Update seo.md

NeroxTGC mentioned this pull request Oct 20, 2024

Add "SEO" section in our docs wasp-lang/wasp#1910

Open

Martinsos reviewed Oct 22, 2024

View reviewed changes

NeroxTGC added 3 commits November 22, 2024 12:36

Added Robots.txt & missing Alt attributes

28227e1

Update seo.md

e16eeee

Merge branch '100-Seo-Landing-Page'

56ec506

Martinsos reviewed Nov 28, 2024

View reviewed changes

Martinsos requested changes Nov 28, 2024

View reviewed changes

NeroxTGC and others added 3 commits November 28, 2024 18:46

Update opensaas-sh/blog/src/content/docs/guides/seo.md

27cba84

Co-authored-by: Martin Šošić <[email protected]>

Update opensaas-sh/blog/src/content/docs/guides/seo.md

c984a06

Co-authored-by: Martin Šošić <[email protected]>

updated Seo guide

4ed41ac

Yherealtita approved these changes Dec 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved seo docs page #297

Improved seo docs page #297

NeroxTGC commented Oct 20, 2024 •

edited

Loading

Martinsos left a comment

Martinsos Oct 22, 2024

Martinsos Nov 28, 2024

Martinsos Oct 22, 2024

Martinsos Nov 28, 2024

NeroxTGC commented Nov 22, 2024

Martinsos Nov 28, 2024

Martinsos Nov 28, 2024

Martinsos Nov 28, 2024

Martinsos left a comment

Martinsos Nov 28, 2024

NeroxTGC Dec 13, 2024

NeroxTGC commented Dec 13, 2024

		Disallow: /api/
		Disallow: /auth/

Improved seo docs page #297

Are you sure you want to change the base?

Improved seo docs page #297

Conversation

NeroxTGC commented Oct 20, 2024 • edited Loading

Description

Contributor Checklist

Martinsos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NeroxTGC commented Nov 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martinsos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NeroxTGC commented Dec 13, 2024

Seo Guide

OpenSaaS template

NeroxTGC commented Oct 20, 2024 •

edited

Loading