Skip to content

Commit 5ba0d29

Browse files
davidfischeragjohnson
davidfischer
and
agjohnson
authored
Add OpenGraph and meta descriptions to pages (#282)
* Add OpenGraph and meta descriptions to pages * Update content/pages/enterprise.html Co-authored-by: Anthony <[email protected]> * Update content/pages/features.html Co-authored-by: Anthony <[email protected]> * Update content/pages/pricing.html Co-authored-by: Anthony <[email protected]> --------- Co-authored-by: Anthony <[email protected]>
1 parent 0505238 commit 5ba0d29

15 files changed

+30
-22
lines changed

‎content/pages/choosing-a-platform.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Choosing a platform
2-
:description: Learn more about our two different platforms and which one is right for you.
2+
:description: Learn more about the differences between Read the Docs community and Read the Docs for Business and which one is right for you.
33
:template: docutils_page
44

55
.. TODO: Figure out how to reuse substitions

‎content/pages/company.html

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<html>
22
<head>
33
<meta name="title" content="About us" />
4+
<meta name="description" content="Read the Docs is an open source project providing the tools, knowledge, and hosting for some of the world's top documentation teams." />
45
<meta name="template" content="page" />
56
<meta name="slug" content="company" />
67
<meta name="status" content="hidden" />
@@ -19,7 +20,7 @@ <h1 class="ui header massive center aligned">
1920
</h1>
2021
<div class="ui basic vertical huge segment center aligned">
2122
<p>
22-
We are an open source project providing the tools, knowledge and hosting for some of the world's top teams' documentation.
23+
We are an open source project providing the tools, knowledge and hosting for some of the world's top documentation teams.
2324
</p>
2425
</div>
2526
</div>
@@ -54,8 +55,8 @@ <h3 class="ui header big">Growth</h3>
5455
<p>
5556
Read the Docs has grown substantially since its beginning as a weekend project and is closing in on being a top-1000 site on the internet.
5657
</p>
57-
<p>Today, we serve over 55 million pages of documentation a month,
58-
serve over 40 TB of documentation a month,
58+
<p>Today, we serve over 55 million pages of documentation a month,
59+
serve over 40 TB of documentation a month,
5960
host over 80,000 open source projects and support over 100,000 users</p>
6061
</div>
6162
</div>
@@ -89,7 +90,7 @@ <h1 class="ui header massive center aligned">
8990
Who we are
9091
</h1>
9192
</div>
92-
93+
9394
<div class="ui basic segment very padded">
9495
<div class="ui cards five doubling">
9596

@@ -136,7 +137,7 @@ <h1 class="ui header massive center aligned">
136137
<div class="ui segment very padded raised">
137138

138139
<h3 class="ui header"><small><i class="icon heart"></i></small> Contributors</h3>
139-
140+
140141
<div class="ui segment vertical padded">
141142
<div class="ui grid relaxed stackable">
142143
<div class="five wide column">
@@ -201,7 +202,7 @@ <h3 class="ui header">Our docs</h3>
201202
<div class="ui segment basic">
202203
<h3 class="ui header">Subscribe to our newsletter</h3>
203204
<p>
204-
Every time we post a blog post,
205+
Every time we post a blog post,
205206
you can get it in your inbox.
206207
</p>
207208
<p>

‎content/pages/comparisons/cloudflare-pages.html

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<html>
44
<head>
55
<title>Read the Docs vs. Cloudflare Pages comparison</title>
6+
<meta name="description" content="Cloudflare Pages is a great product but if you're aiming to host documentation, Read the Docs is the solution built for that use case." />
67
<meta name="template" content="page" />
78
<meta name="slug" content="comparisons/cloudflare-pages" />
89
<meta name="status" content="hidden" />

‎content/pages/comparisons/gitbook.html

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<html>
44
<head>
55
<title>Read the Docs vs. GitBook comparison</title>
6+
<meta name="description" content="For technical teams looking for an open source alternative to GitBook with more flexibility, Read the Docs is the perfect solution." />
67
<meta name="template" content="page" />
78
<meta name="slug" content="comparisons/gitbook" />
89
<meta name="status" content="hidden" />

‎content/pages/comparisons/github-pages.html

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<html>
44
<head>
55
<title>Read the Docs vs. GitHub Pages comparison</title>
6+
<meta name="description" content="GitHub Pages is an amazing product for hosting sites but if you're aiming to host documentation specifically, Read the Docs has tons of features to make your life easier and the docs experience better." />
67
<meta name="template" content="page" />
78
<meta name="slug" content="comparisons/github-pages" />
89
<meta name="status" content="hidden" />

‎content/pages/docs-as-code.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta name="template" content="page" />
99
<meta name="slug" content="docs-as-code" />
1010
<meta name="status" content="hidden" />
11-
<meta name="description" content="Use docs as code pattern with Read the Docs and supercharge your docs" />
11+
<meta name="description" content="Treat your documentation the same way you treat your code and supercharge your docs. Preview proposed changes from Git, test documentation before it goes live, and automate the publication process." />
1212
</head>
1313
<body>
1414

‎content/pages/enterprise.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta name="slug" content="pricing/enterprise" />
99
<meta name="status" content="hidden" />
1010
<meta name="description"
11-
content="Need more than our self-serve plans? Our Enterprise plans gives you more options." />
11+
content="Need more than our self-serve plans? Our enterprise plans give you more options so we can best support your documentation team." />
1212
</head>
1313

1414
<body>

‎content/pages/features.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<html>
22
<head>
33
<meta name="title" content="Product Features" />
4+
<meta name="description" content="Read the Docs includes docs as code features such as building and hosting documentation, search, previewing changes with pull request previews, and authentication for private documentation." />
45
<meta name="template" content="page" />
56
<meta name="status" content="hidden" />
67
<meta name="slug" content="features" />
@@ -156,7 +157,7 @@ <h1 class="ui huge header">
156157
<div class="ui very padded raised inverted teal large segment">
157158
<h4 class="ui header">
158159
<i class="fad fa-screwdriver-wrench icon"></i>
159-
Bring your own tools
160+
Bring your own tools
160161
</h4>
161162

162163
{% markdown %}

‎content/pages/homepage.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<html>
22
<head>
33
<meta name="title" content="Full featured documentation deployment platform" />
4+
<meta name="description" content="Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more." />
45
<meta name="template" content="page" />
56
<meta name="save_as" content="index.html" />
67
<meta name="slug" content="homepage" />
@@ -157,18 +158,18 @@ <h3 class="ui large monospace header">
157158

158159
{# Try it out code block #}
159160
{% include "includes/try-it-out.html" %}
160-
161+
161162
{# Sphinx user testimonials #}
162163
{% include "includes/users-sphinx.html" %}
163-
164+
164165
{% block homepage_bottom_callout %}
165166
<section>
166167
<div class="ui very padded container">
167168
<div class="ui grid center aligned">
168-
169+
169170
<div class="row">
170171
<div class="column twelve wide computer sixteen wide tablet">
171-
172+
172173
{#
173174
TODO replace this block with something more actionable. It's
174175
not saying anything new at this point in the page, and the call
@@ -178,7 +179,7 @@ <h3 class="ui large monospace header">
178179
<p>
179180
<b>Get your docs online in 5 minutes.</b>
180181
</p>
181-
182+
182183
<p>
183184
<a class="ui large teal stackable button"
184185
data-analytics="signup-modal"
@@ -188,10 +189,10 @@ <h3 class="ui large monospace header">
188189
</a>
189190
</p>
190191
</div>
191-
192+
192193
</div>
193194
</div>
194-
195+
195196
</div>
196197
</div>
197198
</section>

‎content/pages/pricing.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<html>
22
<head>
33
<title>Pricing</title>
4+
<meta name="description" content="Read the Docs is free for publicly hosted open source projects and has plans to meet the needs of businesses who need more features like single sign-on, private documentation, or more build resources." />
45
<meta name="template" content="page" />
56
<meta name="slug" content="pricing" />
67
<meta name="status" content="hidden" />
7-
<meta name="description" content="Pricing for plans on Read the Docs for Business and Read the Docs Community" />
88
</head>
99
<body>
1010

‎content/pages/privacy-policy.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
:title: Privacy Policy
22
:template: docutils_page
3+
:description: Read the Docs believes in protecting the privacy of users, authors and readers. These policies are governed by this policy.
34

45
Privacy Policy
56
==============

‎content/pages/terms-of-service.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
:title: Terms of Service
22
:template: docutils_page
3+
:description: Read the Docs is governed by these terms of service.
34

45
Terms of Service
56
================

‎content/pages/tools/jupyter-book.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<meta name="template" content="page" />
88
<meta name="slug" content="tools/jupyter-book" />
99
<meta name="status" content="hidden" />
10-
<meta name="description" content="Create an HTML version of your book and publish it online." />
10+
<meta name="description" content="Read the Docs works great with Jupyter Book and can create an HTML version of your Jupyter Book and publish it online automatically." />
1111
</head>
1212
<body>
1313

‎content/pages/tools/mkdocs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<meta name="template" content="page" />
1616
<meta name="slug" content="tools/mkdocs" />
1717
<meta name="status" content="hidden" />
18-
<meta name="description" content="The best MkDocs deployments with Read the Docs" />
18+
<meta name="description" content="Read the Docs works great with MkDocs for Markdown based documentation. Read the Docs adds great features such as search-as-you-type, previews from Git, and many more." />
1919
</head>
2020
<body>
2121

‎content/pages/tools/sphinx.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{#
1+
{#
22
The goal of this page is to sell users who are already authoring in Sphinx on the benefits of our hosting.
33
We aren't focusing on generic Sphinx benefits,
44
but the unique differentiation of our platform.
@@ -9,7 +9,7 @@
99
<meta name="template" content="page" />
1010
<meta name="slug" content="tools/sphinx" />
1111
<meta name="status" content="hidden" />
12-
<meta name="description" content="Learn more about the best Sphinx hosting option in the world 🎉" />
12+
<meta name="description" content="Read the Docs was built for Sphinx 🎉. Read the Docs adds great features on top of Sphinx such as search-as-you-type, pull request previews, and many more." />
1313
</head>
1414
<body>
1515

0 commit comments

Comments
 (0)