apisix-website icon indicating copy to clipboard operation
apisix-website copied to clipboard

feat: add structured data for SEO

Open pottekkat opened this issue 2 years ago • 11 comments

Signed-off-by: Navendu Pottekkat [email protected]

Related to #980

Adds structured data for the homepage. This is an initial setup and in the future we can automatically generate this data on every page in the site.

Screenshot 2023-02-03 at 11 16 30 AM

pottekkat avatar Feb 03 '23 05:02 pottekkat

Deploy Preview for apache-apisix ready!

Name Link
Latest commit 3764341d9297dee91f181a3a5d6267b80b8412e8
Latest deploy log https://app.netlify.com/sites/apache-apisix/deploys/63de42b3283b720008700f61
Deploy Preview https://deploy-preview-1493--apache-apisix.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Feb 03 '23 05:02 netlify[bot]

Also requesting a review from @nfrankel

pottekkat avatar Feb 03 '23 05:02 pottekkat

@SkyeYoung Please let me know if I need to move the schema definition to some place else.

pottekkat avatar Feb 03 '23 05:02 pottekkat

@SkyeYoung Please let me know if I need to move the schema definition to some place else.

No need I think. 🤔 But we need to improve some of the content.

SkyeYoung avatar Feb 03 '23 06:02 SkyeYoung

No need I think. 🤔 But we need to improve some of the content.

Could you share what we can improve?

pottekkat avatar Feb 04 '23 11:02 pottekkat

Could you share what we can improve?

Sorry, I'm late. My thoughts are similar to what keer said, and I think it's good now that it's been revised.

SkyeYoung avatar Feb 06 '23 01:02 SkyeYoung

Just to confirm: this only adds Schema to the homepage?

Yes. It only does that. But AFAIK it will help with our goal to get a knowledge panel. In future, we can generate schema automatically for each page from the metadata. I have to spend more time looking into how I can achieve this or someone else can take it up.

pottekkat avatar Feb 06 '23 06:02 pottekkat

Google Structured Data Testing Tool isn't happy about some missing fields:

Screenshot 2023-02-06 at 09 29 42

nfrankel avatar Feb 06 '23 08:02 nfrankel

I seem to remember Google complaining about missing field why Blog was easier to start with (cf. https://github.com/apache/apisix-website/issues/980#issuecomment-1156033243).

nfrankel avatar Feb 06 '23 10:02 nfrankel

@nfrankel Should we add applicationCategory and operatingSystem? Another alternative is to use https://schema.org/WebSite

Which way should we go?

pottekkat avatar Feb 12 '23 03:02 pottekkat

@navendu-pottekkat As I mentioned, it should be easier to start with Blog

nfrankel avatar Feb 14 '23 08:02 nfrankel