Add SEO data #12

Cantido · 2016-09-05T05:00:39Z

Adds Twitter, Opengraph, JSON-LD, and whatever other data we need in order to be relevant on the internet. This will fix #6.

Planned:

Description meta tag on main page
Keywords meta tag on main page
Opengraph meta tags on main page
Twitter meta tags on main page
Validate robots.txt
~~Create a sitemap.xml~~ Postponed to Generate a Sitemap #39

drusepth · 2016-09-05T05:09:42Z

app/views/layouts/_seo.html.erb

@@ -0,0 +1,50 @@
+<%# This belongs inside the <head> tag %>
+
+<link rel="publisher" href="https://plus.google.com/u/0/+IndentLabs" />


I think we want to drop the /u/0 here -- it's an identifier for which Google account you are logged into, rather than actually part of the URL.

I thought so, thanks for clearing that up. I'll use the link that you put on the main page.

drusepth · 2016-09-05T05:10:06Z

@Cantido A couple quick comments, but otherwise this looks rockin'. Thanks!

drusepth · 2016-09-05T15:51:28Z

Looks great. @Cantido Merge at will!

Cantido · 2016-09-05T16:06:34Z

I'm going to refine this a little bit so that the content pages have metadata as well, so hold off on merging.

Also I don't seem to have authorization to merge this pull request. Seems to be a result of the protected master branch. I'm totally fine with only you having merge access, it's up to you. Just wait for me to say I'm all done lol.

Cantido · 2016-09-05T16:13:43Z

There's no sitemap for the site either, is there? If not, I'll add this gem as well:

https://github.com/kjvarga/sitemap_generator

drusepth · 2016-09-05T16:16:38Z

Works for me! I don't believe there's a sitemap, I wasn't aware those were
actually still used. If they are though, go for it!

I'll merge whenever you're ready then :)

On Sep 5, 2016 11:13 AM, "Robert Richter" notifications@github.com wrote:

There's no sitemap for the site either, is there? If not, I'll add this gem
as well:

https://github.com/kjvarga/sitemap_generator

—
You are receiving this because you commented.

Reply to this email directly, view it on GitHub
#12 (comment),
or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAg2e5IEcwFyzJFwNw1Zkf0Icm6v_3VZks5qnD-3gaJpZM4J0vgD
.

Since the SEO partial will be in every page, we must keep either data that is the same for all pages, or pointers to the data that will be set dynamically in other pages.

Cantido · 2016-09-05T21:55:50Z

app/views/main/index.html.erb

@@ -1,3 +1,6 @@
+<%# Recommended keywords tag length: up to 255 characters, 20 words. %>
+<% set_meta_tags keywords: %w[writing author nanowrimo novel character fiction fantasy universe creative dnd roleplay larp game design] %>


@drusepth These are the keywords I came up with off the top of my head, but I'm sure there are better ones. Feel free to modify this as you wish.

These are good for now. We can always add to them later. 👍

Cantido · 2016-09-05T22:21:15Z

Heroku does not allow us to modify the app's filesystem after deployment, so we can't generate a sitemap in the same directory. What people usually do is upload their sitemap to an S3 bucket instead. Here's the exact process we would have to follow:

http://jademind.com/blog/posts/updating-sitemap-file-on-heroku/

Use some simple hand-written JSON-LD for now

Cantido · 2016-09-20T02:33:14Z

We're at a decision point. I've done the following so far:

Description meta tag on main page
Keywords meta tag on main page
Opengraph meta tags on main page
Twitter meta tags on main page
Validate robots.txt

We have only the "Create a sitemap.xml" task remaining. Since it seems like that would require getting S3 set up, we can postpone that task so I can get to working on something else. @drusepth, what do you say?

drusepth · 2016-09-20T02:44:45Z

@Cantido I say lets leave it for later and move forward. There's lots more fun stuff to do than set up S3. 👍

Cantido

All set to merge. I closed all my script tags!

Cantido · 2016-09-20T23:36:38Z

That should get Twitter cards properly displayed for all content. I realized that using the set_meta_tags method after you've called display_meta_tags does absolutely nothing. I thought the entire meta tag data structure would be assembled first, before the actual HTML was written.

drusepth · 2016-09-21T00:05:03Z

app/models/user.rb

@@ -16,6 +16,26 @@ class User < ActiveRecord::Base
  has_many :magics
  has_many :universes

+  # as_json would try to print the password digest, which requires authentication
+  def as_json(options={})
+    excludes = [:password_digest, :old_password]


Would we also want to exclude encrypted_password and reset_password_token? And maybe email, so we're not exposing user emails to anyone? What do you think?

drusepth · 2016-09-21T00:06:38Z

app/models/user.rb

+    super(options)
+  end
+
+  def to_json(options={})


What's the difference between to_json and as_json?

as_json creates a hash structure, which you then pass to ActiveSupport::json.encode to actually encode the object as a JSON string. to_json converts it straight to an escaped JSON string.

drusepth · 2016-09-21T00:07:09Z

app/models/user.rb

+  end
+
+  def to_json(options={})
+    options[:except] ||= [:password_digest, :old_password]


We probably want to define this list on the model somewhere so we can reuse it and modify it in a single place, instead of hard-coding it in these handful of places.

I agree, and I'll look for a way to whitelist what we want, instead of blacklisting like this.

drusepth · 2016-09-21T00:13:37Z

app/views/main/index.html.erb

        <span class="card-title">Your digital notebook is here.</span>
      </div>
      <div class="card-content">
        <h4>
-          Notebook is a set of tools for writers, game designers, and roleplayers to create magnificent universes &ndash; and everything within them.
+          <%= description 'Notebook is a set of tools for writers, game designers, and roleplayers to create magnificent universes &ndash; and everything within them.' %>


Where's the description method defined? I've never seen this before!

That's provided by the meta-tags gem. It sets the page's description, and then lets the string pass through.

Cantido

Okay I am much more satisfied with that set of changes. It looks ready to merge.

drusepth

Looks good to merge to me. Great work! 👍

drusepth · 2016-09-21T23:59:39Z

app/models/user.rb

+
+  # Attributes that are non-public, and should be blacklisted from any public
+  # export (ex. in the JSON api, or SEO meta info about the user)
+  def blacklisted_attributes


We should probably revisit whitelisting these (or at least verify it's not exposing anything it shouldn't), but this is fine for now. 👍

drusepth · 2016-09-22T00:00:34Z

app/views/content/_show.html.erb

-<% title @content.name %>
+<% if @content.present? && @content.respond_to?(:as_jsonld) %>
+<script type="application/ld+json">
+		<%= @content.as_jsonld.to_json.html_safe %>


TOO MUCH WHITESPACE HERE LITERALLY UNMERGEABLE

Start work on SEO info in header

528f037

Cantido self-assigned this Sep 5, 2016

drusepth reviewed Sep 5, 2016
View reviewed changes

Cantido added 2 commits September 5, 2016 00:19

Use ID-based G+ link for publisher

c629bcf

Add twitter:url, and split out display_meta_tags

92a2691

Add a message explaining now values can be changed

7d90638

Cantido mentioned this pull request Sep 5, 2016

Users have no profile page #14

Closed

Keep only default data in SEO partial

df20108

Since the SEO partial will be in every page, we must keep either data that is the same for all pages, or pointers to the data that will be set dynamically in other pages.

Cantido added this to the NaNoWriMo 2016 milestone Sep 5, 2016

Add keywords to main page

9c1f9fd

Cantido reviewed Sep 5, 2016
View reviewed changes

Cantido added the Work in Progress label Sep 5, 2016

Cantido mentioned this pull request Sep 6, 2016

Author profiles #16

Merged

Cantido added 9 commits September 6, 2016 09:20

Add sitemap gem

1e5658c

Merge branch 'master' into issue-6-seo

d1b0c5b

Add user profiles to sitemap

2d65d86

Add JSON LD blocks to User pages

ccc2aee

Add JSON-LD to Universes

b817cdf

Remove practmatic_context gem

3b11cea

Use some simple hand-written JSON-LD for now

Remove pragmatic_context from User

472bb61

Add ID and Name JSON LD to all content show pages

a90dda4

Remove pragmatic_context from Universes

b17f3fb

drusepth removed this from the NaNoWriMo 2016 milestone Sep 15, 2016

Cantido added 2 commits September 19, 2016 21:16

Bundle update

15b6f0d

Close a tag I missed

6fec224

Merge branch 'master' into issue-6-seo

cfc34ec

Cantido added 2 commits September 19, 2016 21:58

Close another tag I missed

cd82020

Remove sitemap stuff, for now

aa83c3a

Cantido commented Sep 20, 2016

View reviewed changes

Cantido mentioned this pull request Sep 20, 2016

Generate a Sitemap #39

Open

Cantido added 2 commits September 20, 2016 18:31

Write a universes integration test

f184042

Restructure meta tags for content

e8dc289

drusepth reviewed Sep 21, 2016

View reviewed changes

Cantido added 7 commits September 21, 2016 11:13

Restructured meta tags

a7441a3

Add newline to end of file

961dc90

Add meta info to privacy policy

37a5898

Move description and keywords into layout

67a3cfa

Extract blacklisted User attributes into a method

0487cc0

Add user-specific meta tags to User profile

b8449a1

Update website domain name in analytics

911f1f2

Cantido commented Sep 21, 2016

View reviewed changes

drusepth approved these changes Sep 22, 2016

View reviewed changes

drusepth merged commit 3b4208f into master Sep 22, 2016

drusepth deleted the issue-6-seo branch September 22, 2016 00:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SEO data #12

Add SEO data #12

Cantido commented Sep 5, 2016 •

edited

drusepth Sep 5, 2016

Cantido Sep 5, 2016

drusepth commented Sep 5, 2016

drusepth commented Sep 5, 2016

Cantido commented Sep 5, 2016

Cantido commented Sep 5, 2016

drusepth commented Sep 5, 2016

Cantido Sep 5, 2016

drusepth Sep 21, 2016

Cantido commented Sep 5, 2016

Cantido commented Sep 20, 2016

drusepth commented Sep 20, 2016

Cantido left a comment

Cantido commented Sep 20, 2016

drusepth Sep 21, 2016 •

edited

drusepth Sep 21, 2016

Cantido Sep 21, 2016

drusepth Sep 21, 2016

Cantido Sep 21, 2016

drusepth Sep 21, 2016

Cantido Sep 21, 2016

Cantido left a comment

drusepth left a comment

drusepth Sep 21, 2016

drusepth Sep 22, 2016

		@@ -0,0 +1,50 @@
		<%# This belongs inside the <head> tag %>

		<link rel="publisher" href="https://plus.google.com/u/0/+IndentLabs" />

		@@ -1,3 +1,6 @@
		<%# Recommended keywords tag length: up to 255 characters, 20 words. %>
		<% set_meta_tags keywords: %w[writing author nanowrimo novel character fiction fantasy universe creative dnd roleplay larp game design] %>

Add SEO data #12

Add SEO data #12

Conversation

Cantido commented Sep 5, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drusepth commented Sep 5, 2016

drusepth commented Sep 5, 2016

Cantido commented Sep 5, 2016

Cantido commented Sep 5, 2016

drusepth commented Sep 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cantido commented Sep 5, 2016

Cantido commented Sep 20, 2016

drusepth commented Sep 20, 2016

Cantido left a comment

Choose a reason for hiding this comment

Cantido commented Sep 20, 2016

drusepth Sep 21, 2016 • edited

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cantido left a comment

Choose a reason for hiding this comment

drusepth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cantido commented Sep 5, 2016 •

edited

drusepth Sep 21, 2016 •

edited