Merge pull request github#126 from github/kytrinyx-seo-h1

Update titles for improved SEO
Anzil-Aufait · Sep 10, 2016 · 7162588 · 7162588
2 parents 0ae3ec2 + b83a75f
commit 7162588
Show file tree

Hide file tree

Showing 25 changed files with 51 additions and 20 deletions.
diff --git a/_data/fields.yml b/_data/fields.yml
@@ -8,3 +8,9 @@ contents:
 
 next:
   type: String
+
+nav:
+  type: String
+
+seo_title:
+  type: String
diff --git a/_includes/contents.html b/_includes/contents.html
@@ -9,7 +9,7 @@
   {% assign subpage = site.pages | where: "path", path | first %}
   <li{% if page.url contains subpage.url %} class="selected"{% endif %}>
     <a class="d-block {% if page.url == subpage.url %} current{% endif %}"
-      href="{{ subpage.url | prepend: site.baseurl }}">{{ subpage.title }}</a>
+      href="{{ subpage.url | prepend: site.baseurl }}">{% if subpage.nav == nil %}{{ subpage.title }}{% else %}{{ subpage.nav }}{% endif %}</a>
     {% if subpage.contents %}
       {% include contents.html item=subpage %}
     {% endif %}

diff --git a/_includes/head.html b/_includes/head.html
@@ -4,6 +4,9 @@
   <link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i" rel="stylesheet">
   <link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
   <link rel="icon" type="image/png" href="{{ "/img/favicon-128.png" | prepend: site.baseurl }}" sizes="128x128" />
+  <title>
+  {% if page.seo_title == nil %}{{ page.title }}{% else %}{{ page.seo_title }}{% endif %}
+  </title>
   <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
   <script src="{{ "/js/script.js" | prepend: site.baseurl }}"></script>
   <script>

diff --git a/disclaimer.md b/disclaimer.md
@@ -1,4 +1,5 @@
 ---
+seo_title: Legal Disclaimer—Open Source Handbook
 title: Legal Disclaimer
 ---
 

diff --git a/getting-started/branding.md b/getting-started/branding.md
@@ -1,5 +1,6 @@
 ---
-title: Branding
+title: Branding your open source project
+nav: Branding
 next: getting-started/preparing.md
 ---
 

diff --git a/getting-started/defining.md b/getting-started/defining.md
@@ -1,5 +1,6 @@
 ---
-title: What it means to open source
+title: What is an open source project?
+nav: What it means to open source
 next: getting-started/setting-expectations.md
 ---
 

diff --git a/getting-started/index.md b/getting-started/index.md
@@ -1,5 +1,6 @@
 ---
-title: Getting started
+title: How to start an open source project
+nav: Getting started
 next: getting-started/defining.md
 contents:
   - getting-started/defining.md

diff --git a/getting-started/legal.md b/getting-started/legal.md
@@ -1,5 +1,6 @@
 ---
 title: The legal side of open source
+nav: The legal side of open source
 ---
 
 Sharing your creative work with the world can be an exciting and rewarding experience. It can also mean a bunch of legal things you didn't know you had to worry about.

diff --git a/getting-started/preparing.md b/getting-started/preparing.md
@@ -1,5 +1,6 @@
 ---
-title: Preparing for launch
+title: Launching your open source project
+nav: Preparing for launch
 next: marketing/index.md
 ---
 

diff --git a/getting-started/setting-expectations.md b/getting-started/setting-expectations.md
@@ -1,5 +1,6 @@
 ---
 title: Setting expectations for your open source project
+nav: Setting expectations
 next: getting-started/branding.md
 ---
 

diff --git a/index.html b/index.html
@@ -1,5 +1,6 @@
 ---
-title: Welcome
+seo_title: Open Source Handbook—from GitHub
+title: Welcome to the Open Source Handbook!
 layout: landing
 contents:
 ---

diff --git a/marketing/building-community.md b/marketing/building-community.md
@@ -1,5 +1,6 @@
 ---
-title: Building a community
+title: Building an open source community
+nav: Building a community
 next: marketing/measuring.md
 ---
 

diff --git a/marketing/index.md b/marketing/index.md
@@ -1,5 +1,6 @@
 ---
-title: Marketing your project
+title: Marketing your open source project
+nav: Marketing your project
 next: marketing/spreading-word.md
 contents:
 - marketing/spreading-word.md

diff --git a/marketing/measuring.md b/marketing/measuring.md
@@ -1,5 +1,6 @@
 ---
-title: Measuring success
+title: Measuring the success of your open source project
+nav: Measuring success
 next: sustaining/index.md
 ---
 

diff --git a/marketing/spreading-word.md b/marketing/spreading-word.md
@@ -1,5 +1,6 @@
 ---
-title: Spreading the word
+title: Promoting your open source project
+nav: Spreading the word
 next: marketing/building-community.md
 ---
 

diff --git a/sustaining/best-practices.md b/sustaining/best-practices.md
@@ -1,5 +1,6 @@
 ---
-title: Best practices for maintainers
+title: Best practices for open source project maintenance
+nav: Best practices for maintainers
 next: sustaining/healthy-communities.md
 ---
 

diff --git a/sustaining/healthy-communities.md b/sustaining/healthy-communities.md
@@ -1,5 +1,6 @@
 ---
-title: Sustaining healthy communities
+title: Sustaining healthy open source communities
+nav: Sustaining healthy communities
 next: sustaining/leadership.md
 ---
 

diff --git a/sustaining/index.md b/sustaining/index.md
@@ -1,5 +1,6 @@
 ---
-title: Sustaining Growth
+title: Sustaining growth of your open source project
+nav: Sustaining growth
 next: sustaining/best-practices.md
 contents:
 - sustaining/best-practices.md

diff --git a/sustaining/leadership.md b/sustaining/leadership.md
@@ -1,5 +1,6 @@
 ---
-title: Leadership & governance
+title: Open source project leadership & governance
+nav: Leadership & governance
 next: troubleshooting/index.md
 ---
 

diff --git a/troubleshooting/burnout.md b/troubleshooting/burnout.md
@@ -1,5 +1,6 @@
 ---
-title: Feeling guilty or burned out
+title: Open source project burnout
+nav: Feeling guilty or burned out
 ---
 
 Open source work once brought you joy. Maybe now it's starting to make you feel avoidant or guilty. Perhaps you're feeling overwhelmed or a growing sense of dread when you think about your projects. And meanwhile, the issues and pull requests pile up.

diff --git a/troubleshooting/conduct.md b/troubleshooting/conduct.md
@@ -1,5 +1,6 @@
 ---
-title: Enforcing your code of conduct
+title: Enforcing your open source project code of conduct
+nav: Enforcing your code of conduct
 ---
 
 Your code of conduct helps create a healthy and constructive social atmosphere for your project's community. Sometimes, despite your best efforts, somebody will do something that violates this code. In this section, we'll talk about how to address negative or harmful behavior in your project's community.

diff --git a/troubleshooting/contributions.md b/troubleshooting/contributions.md
@@ -1,5 +1,6 @@
 ---
-title: Handling contributions you don't want to accept
+title: Handling open source contributions you don't want to accept
+nav: Handling contributions you don't want to accept
 ---
 
 As a maintainer of an open source project, you'll inevitably receive contributions that you don't want to accept. Maybe the contribution changes your project's scope or doesn't match your vision. Maybe the idea is good, but the implementation is poor.

diff --git a/troubleshooting/finding-consensus.md b/troubleshooting/finding-consensus.md
@@ -1,5 +1,6 @@
 ---
-title: Finding community consensus
+title: Finding open source community consensus
+nav: Finding community consensus
 ---
 
 In the early stages of your project, making major decisions is easy. When you want to do something, you just do it.

diff --git a/troubleshooting/getting-paid.md b/troubleshooting/getting-paid.md
@@ -1,5 +1,6 @@
 ---
-title: Getting paid for open source work
+title: Getting paid for open source project work
+nav: Getting paid for open source work
 ---
 
 If you make regular, substantial contributions to open source, or you're just considering your first contribution, you may start to wonder whether anybody gets paid to work on open source.

diff --git a/troubleshooting/index.md b/troubleshooting/index.md
@@ -1,5 +1,6 @@
 ---
-title: Troubleshooting
+title: Open source project troubleshooting & maintenance
+nav: Troubleshooting
 contents:
 - troubleshooting/conduct.md
 - troubleshooting/burnout.md