Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Implement initial SEO strategy for beta site launch #343

Closed
jessicaschilling opened this issue Oct 3, 2019 · 4 comments
Closed

Implement initial SEO strategy for beta site launch #343

jessicaschilling opened this issue Oct 3, 2019 · 4 comments
Assignees
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Oct 3, 2019

Add basic metadata to each content page so friendly links for social media cards work -- see https://vuepress.vuejs.org/guide/frontmatter.html for info on VuePress frontmatter

  • Remember titles get truncated on Twitter at 70 chars
  • Field: description is critical. It's actually the description sub-field inside the meta field. Shorter the better, but no more than circa 150 chars (or 200 if absolutely necessary)
  • Is it possible using frontmatter to include an image for articles? Investigate and if it's not possible within time scale, break out into a separate issue. @ericronne will make a social card image and we can personalize further later for key topic pages

More info about the meta tags used in Twitter/Facebook social cards (including how to specify images) is here.

@ericronne ericronne added OKR 1: Beta Launch topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work labels Oct 3, 2019
@jessicaschilling jessicaschilling added dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week labels Oct 3, 2019
@jessicaschilling jessicaschilling changed the title Evaluate overall SEO for docs beta launch Determine/implement initial SEO strategy for beta site launch Oct 4, 2019
@jessicaschilling jessicaschilling changed the title Determine/implement initial SEO strategy for beta site launch Implement initial SEO strategy for beta site launch Nov 26, 2019
@cwaring
Copy link
Collaborator

cwaring commented Dec 4, 2019

I'll experiment with this plugin to see if it can generate acceptable results.

@jessicaschilling
Copy link
Contributor Author

I’m happy to take a manual first pass so this can free up your time for other efforts, @cwaring. It’s on my list for today.

@jessicaschilling
Copy link
Contributor Author

Combed through https://htmlhead.dev/ and am implementing the following meta tags in ipfs/ipfs-docs#36 as a combination of front matter (for tags that depend on the original page) and head.js (for tags that are consistent sitewide).

GLOBAL:

<meta name=“keywords” content=“some, keywords”>
<meta name="description" content="A description of the page limited to 150 char>
<meta name="subject" content="your document's subject">

FACEBOOK - sharing debugger at https://developers.facebook.com/tools/debug/sharing/

<meta property="og:type" content="website">
<meta property="og:title" content="Content Title">
<meta property="og:image" content="https://example.com/image.jpg">
<meta property="og:image:alt" content="A description of what is in the image (not a caption)">
<meta property="og:description" content="Description Here">
<meta property="og:site_name" content="Site Name">

TWITTER - card validator at https://cards-dev.twitter.com/validator

<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@site_account">
<meta name="twitter:title" content="Content Title">
<meta name="twitter:description" content="Content description less than 200 characters">
<meta name="twitter:image" content="https://example.com/image.jpg">
<meta name="twitter:image:alt" content="A text description of the image conveying the essential nature of an image to users who are visually impaired. Maximum 420 characters.">

QQ/WECHAT:

<meta itemprop="name" content="share title">
<meta itemprop="image" content="http://imgcache.qq.com/qqshow/ac/v4/global/logo.png">

For future reference: Here's the block of front matter to include in new pages.

meta:
  - name: twitter:title
    content: IPFS Docs - page title
  - property: og:title
    content: IPFS Docs - page title
  - itemprop: name
    content: IPFS Docs - page title
  - name: description
    content: description of this page less than 150 char
  - name: twitter:description
    content: description of this page less than 150 char
  - property: og:description
    content: description of this page less than 150 char

@jessicaschilling
Copy link
Contributor Author

Closed via ipfs/ipfs-docs#47 !

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants