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.

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

Tightened homepage intro #797

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Tightened homepage intro #797

wants to merge 2 commits into from

Conversation

shorgi
Copy link
Contributor

@shorgi shorgi commented Mar 8, 2024

Replaced docs homepage's intro paragraph with subtitle and edited CTA text. Also disabled TOC right-nav and removed "For architects" heading.

Resolves https://apollographql.atlassian.net/browse/DOC-78

Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for apollo-monodocs ready!

Name Link
🔨 Latest commit 6142b64
🔍 Latest deploy log https://app.netlify.com/sites/apollo-monodocs/deploys/65ef83fcf75aa50008c1bf7f
😎 Deploy Preview https://deploy-preview-797--apollo-monodocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 55 (🔴 down 25 from production)
Accessibility: 85 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (🟢 up 8 from production)
PWA: 50 (🟢 up 10 from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

toc: true
subtitle: ' '
toc: false
subtitle: 'Use Apollo to unify your data with GraphQL'
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if the subtitle is the best place for this unless we can come up with something really short and snappy. (Which feels more like the realm of a marketing website.)

Most documentation landing pages don't appear to have something like this, but if they do (e.g. Stripe) it's more about the documentation, not about the product, e.g. "Explore our guides and examples to integrate Stripe."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The subtitle as-is does need editing. Still, I prefer we condense the gist of our intro paragraph into a subtitle. It'd be more eye-catching and more efficient use of space on the page.

And it being about the documentation feels like a lost opportunity to position docs to our target personas. We could lean into federation with Apollo:

Suggested change
subtitle: 'Use Apollo to unify your data with GraphQL'
subtitle: 'Learn to federate your data with Apollo'

Copy link
Contributor

Choose a reason for hiding this comment

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

Works for me! Maybe we include "services"? (Either replace or add to data):

Suggested change
subtitle: 'Use Apollo to unify your data with GraphQL'
subtitle: 'Learn to federate your data and services with Apollo'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

data sources?

Suggested change
subtitle: 'Use Apollo to unify your data with GraphQL'
subtitle: 'Learn to federate your data sources with Apollo'

Copy link
Contributor

Choose a reason for hiding this comment

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

I think "sources" minimizes things, since we're actually federating whole services. Just "data" works too!

@@ -30,15 +30,10 @@ import {
GradientCard
} from '../../components/HomePage';

Apollo provides the developer platform and tools to unify your data and services into a _supergraph_—a single distributed GraphQL API.
Copy link
Contributor

Choose a reason for hiding this comment

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

I like how you condensed most of this into the GraphOS Gradient card. At the same time, one opening line might make things more cohesive? Something like:

Apollo makes GraphQL work for you at any stage and any scale, whether you're just getting started or migrating your platform onto the supergraph.

Apollo provides the developer platform and tools to unify your data and services into a _supergraph_—a single distributed GraphQL API.
Apollo makes GraphQL work for you at any stage and any scale, whether you're just getting started, building your first API, querying an API, or migrating your platform onto the supergraph.

## For architects
Copy link
Contributor

Choose a reason for hiding this comment

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

If we're keeping the TOC, I'd keep this.

<GradientCard
icon={<GraphOSIcon />}
title="Build a supergraph"
description="Use Apollo GraphOS to define, build, connect, and observe all of your data services together in a supergraph."
description="Use Apollo GraphOS to build a supergraph—all your data services combined into a single distributed GraphQL API."
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can start introducing Federation terminology here, just to warm users up to it.

Suggested change
description="Use Apollo GraphOS to build a supergraph—all your data services combined into a single distributed GraphQL API."
description="Use Apollo GraphOS to build a supergraph—all your data services composed into a single distributed GraphQL API."

<GradientCard
icon={<GraphOSIcon />}
title="Build a supergraph"
description="Use Apollo GraphOS to define, build, connect, and observe all of your data services together in a supergraph."
description="Use Apollo GraphOS to build a supergraph—all your data services combined into a single distributed GraphQL API."
path="/graphos"
cta="Learn about GraphOS"
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be nice to have a stronger CTA, e.g. "Build your supergraph", but until we have a stronger quickstart to link to, it seems like that would be setting false expectations about the page we're currently linking too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants