Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New landing page to test marketing copy #152

Merged
merged 11 commits into from
Nov 9, 2022
Merged

New landing page to test marketing copy #152

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ccf6db6
Add a basic skeleton of a Sphinx landing page.
ericholscher Aug 18, 2022
79be83a
Lots of content updates from pairing with Manuel!
ericholscher Oct 13, 2022
ee00657
Update logos from our happy users
humitos Nov 7, 2022
15ab468
Anthony feedback addressed
humitos Nov 8, 2022
51a23ed
Fix sphinx post file path
agjohnson Nov 8, 2022
7e107ff
Increase padding on images
agjohnson Nov 8, 2022
3fdc509
Fix tool/sphinx logo card display
agjohnson Nov 8, 2022
6f11e8a
Add section back for testimonials/example users section
agjohnson Nov 8, 2022
4eb40a2
Fix SUI element structure around the config example
agjohnson Nov 8, 2022
c6f19ff
Fix note on page url
agjohnson Nov 8, 2022
42a92a7
Link to the landing page from the footer
ericholscher Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/images/flask-logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/godot-logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/jupyter-logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
294 changes: 294 additions & 0 deletions content/pages/sphinx.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
{#
The goal of this page is to sell users who are already authoring in Sphinx on the benefits of our hosting.
We aren't focusing on generic Sphinx benefits,
but the unique differentiation of our platform.
#}
<html>
<head>
<title>Supercharge your Sphinx docs hosting</title>
<meta name="template" content="page" />
<meta name="slug" content="landing/sphinx" />
agjohnson marked this conversation as resolved.
Show resolved Hide resolved
<meta name="status" content="hidden" />
<meta name="description" content="Learn more about the best Sphinx hosting option in the world 🎉" />
</head>
<body>

{#
View this page at http://localhost:8080/landing/sphinx/index.html
humitos marked this conversation as resolved.
Show resolved Hide resolved
#}

{% import "partials/basic.html" as basic %}
{% import "partials/marketing.html" as marketing %}
{% import "partials/technical.html" as technical %}
{% import "partials/homepage.html" as homepage %}

{% block signup_modal %}
{{ homepage.signup_modal("signup_modal") }}
{% endblock signup_modal %}

<section>
{% call basic.header_image(
header="Supercharge your Sphinx docs and impress your readers",
image="https://cdn.dribbble.com/users/876899/screenshots/2141696/readthedocs-thumb.png",
humitos marked this conversation as resolved.
Show resolved Hide resolved
image_alt="Marketing introduction header",
humitos marked this conversation as resolved.
Show resolved Hide resolved
vertical_align="middle")
%}
{# TODO: Add a GIF of using hoverxref & livesearch #}
humitos marked this conversation as resolved.
Show resolved Hide resolved
<p>
Our powerful Sphinx hosting improves the reading and authoring experience for everyone who interacts with your docs.
humitos marked this conversation as resolved.
Show resolved Hide resolved
</p>

<p class="ui basic padded vertical segment">
<a class="ui large teal stackable button"
data-analytics="signup-modal"
onclick="jQuery('#signup_modal').modal('show');">
<i class="fad fa-play icon"></i>
Create an account
</a>
<a href="https://docs.readthedocs.io/en/stable/tutorial/index.html" class="ui large stackable button">
Start our tutorial
</a>
</p>
{% endcall %}
</section>

<section id="features">
{% call marketing.highlight_list() %}
humitos marked this conversation as resolved.
Show resolved Hide resolved
{% call marketing.highlight_item(
icon="olive fa-people-arrows",
icon_style="--fa-secondary-color: violet; --fa-secondary-opacity: 1;",
header="Collaborate with deploy previews",
color="primary") %}
{% markdown %}
Receive feedback from your team,
and <strong>have confidence in changes</strong> before they go live.
{% endmarkdown %}
{% endcall %}

{% call marketing.highlight_item(
icon="yellow fa-magnifying-glass",
icon_style="--fa-secondary-color: white; --fa-secondary-opacity: 1;",
header="Always find what you need",
color="secondary") %}
{% markdown %}
Search across all your projects with our search-as-you-type interface,
and get results broken out by code objects and paragraph.
<strong>Never lose documentation again</strong>.
humitos marked this conversation as resolved.
Show resolved Hide resolved
{% endmarkdown %}
{% endcall %}

{% call marketing.highlight_item(
icon="fa-eye",
header="Never lose focus with link previews",
humitos marked this conversation as resolved.
Show resolved Hide resolved
color="violet") %}

{# TODO: Add link preview to the `link previews` docs #}
agjohnson marked this conversation as resolved.
Show resolved Hide resolved

{% markdown %}
Get instant context on every internal link in your docs.
With instant link previews,
<strong>skim the content without opening *another* tab</strong>.
humitos marked this conversation as resolved.
Show resolved Hide resolved
{% endmarkdown %}
{% endcall %}
{% endcall %}
</section>

<div class="ui very padded container">

{{ basic.header_icon(
header="Join thousands of happy users",
subheader="",
icon="purple fa-message-lines",
icon_style="--fa-secondary-color: blueviolet;"
) }}
agjohnson marked this conversation as resolved.
Show resolved Hide resolved

{# TODO: Turn these into testomonials. #}

{#
Cards for an articles or case studies view

See https://fomantic-ui.com/views/card.html
#}
agjohnson marked this conversation as resolved.
Show resolved Hide resolved
<div class="ui three link stackable cards">
<a href="https://flask.palletsprojects.com/en/2.2.x/" class="card">
<div class="ui small centered image">
<img src="{{ SITE_URL }}/images/flask-logo.png" alt="Flask logo">
</div>
<div class="content">
<div class="header">Flask</div>
<div class="meta">
Web Framework
</div>
<div class="description">
Flask is a Python web framework built with a small core and easy-to-extend philosophy.
</div>
</div>
</a>

<a href="https://docs.jupyter.org/en/latest/" class="card">
<div class="ui medium centered image">
<img src="{{ SITE_URL }}/images/jupyter-logo.png" alt="Jupyter logo">
</div>
<div class="content">
<div class="header">Jupyter</div>
<div class="meta">
Data Science Environment
</div>
<div class="description">
Jupyter Notebook is a web-based interactive computational environment for creating notebook documents.
</div>
</div>
</a>

<a href="https://docs.godotengine.org/en/stable/index.html" class="card">
<div class="ui small centered image">
<img src="{{ SITE_URL }}/images/godot-logo.png" alt="Godot Engine logo">
</div>
<div class="content">
<div class="header">Godot Engine</div>
<div class="meta">
Game Engine
</div>
<div class="description">
Godot Engine is a free and open source community-driven 2D and 3D game engine.
</div>
</div>
</a>
</div>

<div class="ui very padded basic vertical segment">
<div class="ui horizontal divider">Try it out</div>
</div>

<div class="ui horizontally container">
<div class="ui very padded centered grid">
<div class="middle aligned row">

<h2 class="ui huge header">
Everything you need, and nothing you don't.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This header doesn't match the content below. This header sounds fairly vague and generic, but it's also saying "Read the Docs provides all the services you need to host your documentation in one place". The content doesn't agree with this, and is instead "how to host your Sphinx project on Read the Docs".

No strong preference here, but same energy but more specific benefit:

Suggested change
Everything you need, and nothing you don't.
Upgrade your documentation in minutes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the nesting of elements here is wrong. The heading should be outside the grid, and should be at least inside the div.container, and the grid shouldn't need a div.row class.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed the HTML structure. I edited the header for now so this doesn't get lost, but not sold on the edit copy.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to #152 (comment)

</h2>

<div class="ten wide computer sixteen wide tablet sixteen wide mobile column">
agjohnson marked this conversation as resolved.
Show resolved Hide resolved
<div class="ui large left aligned basic vertical segment">

{# Stylized code blocks #}
{% call technical.code_block(title="<code>.readthedocs.yaml</code>", icon="fa-file") %}
{% markdown %}

```yaml
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "16"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
```

{% endmarkdown %}
{% endcall %}
</div>
</div>

<div class="six wide computer twelve wide tablet sixteen wide mobile column">
<div class="ui padded basic segment">
<div class="ui relaxed list">

{%- set header_1 = "Create an account" %}
{%- set icon_1 = "fa-square-1" -%}
<span class="ui small teal header item">
<i class="fad {{ icon_1 }} secondary big icon"></i>
<span class="content">
{{ header_1 }}
<span class="sub header">Sign up with GitHub or your email.</span>
</span>
</span>

{%- set header_2 = "Import your project" %}
{%- set icon_2 = "fa-square-2" -%}
<span class="ui small header item">
<i class="fad {{ icon_2 }} secondary big icon"></i>
<span class="content">
{{ header_2 }}
<span class="sub header">Select your existing git repositories with a 1-click interface.</span>
humitos marked this conversation as resolved.
Show resolved Hide resolved
</span>
</span>

{%- set header_3 = "Add YAML config" %}
{%- set icon_3 = "fa-square-3" -%}
<span class="ui small header item">
<i class="fad {{ icon_3 }} secondary big icon"></i>
<span class="content">
{{ header_3 }}
<span class="sub header">Copy this one, it probably does what you want :)</span>
humitos marked this conversation as resolved.
Show resolved Hide resolved
</span>
</span>

{%- set header_4 = "Your docs build on every commit" %}
{%- set icon_4 = "fa-square-4" -%}
<span class="ui small header item">
<i class="fad {{ icon_4 }} secondary big icon"></i>
<span class="content">
{{ header_4 }}
<span class="sub header">Like magic.</span>
</span>
</span>
</div>
</div>
</div>

</div>
</div>
</div>
</section>


{% block homepage_bottom_callout %}
humitos marked this conversation as resolved.
Show resolved Hide resolved
<section>
<div class="ui very padded container">
<div class="ui grid center aligned">

<div class="row">
<div class="column twelve wide computer sixteen wide tablet">

{#
TODO replace this block with something more actionable. It's
not saying anything new at this point in the page, and the call
to action is not strong.
#}
<div class="ui basic vertical huge segment">
<p>
<b>Get your docs online in 5 minutes.</b>
humitos marked this conversation as resolved.
Show resolved Hide resolved
</p>

<p>
<a class="ui large teal stackable button"
data-analytics="signup-modal"
onclick="jQuery('#signup_modal').modal('show');">
<i class="fad fa-play icon"></i>
Create an account
</a>
</p>
</div>

</div>
</div>

</div>
</div>
</section>
{% endblock homepage_bottom_callout %}



</body>
</html>