Skip to content

Commit

Permalink
Docs: tweaks and polish (#3668)
Browse files Browse the repository at this point in the history
  • Loading branch information
Vultraz authored Sep 15, 2020
1 parent e4cb609 commit c94cd64
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/blog/field-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To give an example, the `Text` field creates a `TEXT` column in a Postgres datab

For a complete technical breakdown on the anatomy of field types and how they are built, see the [custom field type guide](/docs/guides/custom-field-types.md).

Because they sit at this intersection of concerns, it can be difficult to decide what customisations should become new field types. How many concerns need to differ before creating a new field vs adding config options or project specific customsation such as hooks?
Because they sit at this intersection of concerns, it can be difficult to decide what customisations should become new field types. How many concerns need to differ before creating a new field vs adding config options or project specific customisation such as hooks?

This post provides insight into how we think about field types. Broadly speaking, field types can be grouped into one of two categories. Core field types and Non-Core field types.

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title: Keystone apps

# Keystone apps

A Keystone instance can be summarised as a function of your schema which
creates a GraphQL API for querying, and an AdminUI for managing your data:
A Keystone instance acts as a function of your schema which
creates a GraphQL API for querying and an Admin UI for managing your data:

```javascript allowCopy=false showLanguage=false
schema => ({ GraphQL, AdminUI });
Expand Down
4 changes: 2 additions & 2 deletions website/src/components/homepage/SectionCode.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ type User {
const SectionCode = () => (
<HomepageSection
variant="dark"
description="A KeystoneJS instance can be summarised as a function of your schema which creates a GraphQL API for querying, and an AdminUI for managing your data"
description="A KeystoneJS instance acts as a function of your schema which creates a GraphQL API for querying and an Admin UI for managing your data."
heading="schema => ({ GraphQL, AdminUI })"
ctaTo="guides/schema"
ctaText="Learn more creating lists and fields"
ctaText="Learn more about lists and fields"
>
<Grid>
{CARDS.map((card, i) => (
Expand Down
8 changes: 4 additions & 4 deletions website/src/components/homepage/SectionFeatures.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ const CARDS = [
},
{
heading: `Highly extensible`,
content: `KeystoneJS provides an extensible Admin Interface and a powerful GraphQL API. These tools, and the building blocks Keystone provides, will allow you to create any type of application.`,
content: `KeystoneJS provides an extensible admin interface and a powerful GraphQL API. These tools, and the building blocks Keystone provides, will allow you to create any type of application.`,
to: '/guides/graphql-philosophy',
},
{
heading: `Own your data`,
content: `Provide your own PostgreSQL or MongoDB database for Keystone to connect to, and deploy your application anywhere. Have complete freedom of choice when hosting your data, admin application, API and front-end applications.`,
content: `Provide your own PostgreSQL or MongoDB database for Keystone to connect to, and deploy your application anywhere. Have complete freedom of choice when hosting your data, API, and front-end and admin applications.`,
to: '/guides/deployment',
},
{
heading: `Get started in minutes`,
content: `Our quick start guide will get you up and running in just a few minutes. Let's build a simple todo app with a fresh install of KeystoneJS`,
content: `Our quick start guide will get you up and running in just a few minutes. Let's build a simple todo app with a fresh install of Keystone!`,
to: '/quick-start',
},
];

const SectionFeatures = () => (
<HomepageSection
heading="Why KeystoneJS"
description="We believe it’s the ideal back-end for React, Vue or Angular applications, Gatsby and Next.js websites, static sites, mobile applications and more"
description="We believe it’s the ideal back-end for React, Vue or Angular applications, Gatsby and Next.js websites, static sites, mobile applications and more."
>
<Grid>
{CARDS.map((card, i) => (
Expand Down
6 changes: 3 additions & 3 deletions website/src/components/homepage/SectionTechnology.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { HomepageSection } from './HomepageSection';
const CARDS = [
{
heading: `Static Files`,
content: `Serve HTML, CSS, JS, images and any other static resources using an express static server. This can be quick and easy way to deploy a simple front-end with a KeystoneJS application.`,
content: `Serve HTML, CSS, JS, images and any other static resources using an Express static server. This can be quick and easy way to deploy a simple front-end with a KeystoneJS application.`,
to: `/keystonejs/app-static/`,
},

Expand All @@ -23,15 +23,15 @@ const CARDS = [
},
{
heading: `Headless`,
content: `The primary focus of KeystoneJS is the GraphQL API and Admin UI. Because of this KeystoneJS works with all major front-end framework and is headless by default.`,
content: `The primary focus of KeystoneJS is the GraphQL API and Admin UI. Because of this KeystoneJS works with all major front-end frameworks and is headless by default.`,
to: `/keystonejs/app-graphql/`,
},
];

const SectionTechnology = () => (
<HomepageSection
variant="dark"
description="KeystoneJS integrates seamlessly with any front-end framework, but can also be run as a headless GraphQL API and optional Admin UI"
description="KeystoneJS integrates seamlessly with any front-end framework, but can also be run as a headless GraphQL API with optional Admin UI."
heading="Use with the technology of your choice"
>
<Grid>
Expand Down
10 changes: 5 additions & 5 deletions website/src/pages/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ const DocsPage = () => {
Keystone Documentation
</h1>
<p>
Welcome to the keystone documentation! If you're new, we recommend checking out
Welcome to the Keystone documentation! If you're new, we recommend checking out
our <Link to="/quick-start/">getting started guide</Link>.
</p>
<p>Otherwise, we have divided our documentation into three key sections:</p>
<HeadingLink to="/tutorials">Tutorials</HeadingLink>
<p>
Each of these tutorials will walk you through doing a particular task with
keystone. They are desgined to allow you to follow along, but don't delve into all
the options.
Keystone. They are designed to allow you to follow along, but don't delve into all
available options.
</p>
<HeadingLink to="/guides">Guides</HeadingLink>
<p>
Expand All @@ -65,8 +65,8 @@ const DocsPage = () => {
</p>
<HeadingLink to="/blog">Blog</HeadingLink>
<p>
To keep up with what's coming out in keystone, and what we are working on, you can
follow our blog (as well as our changelogs)
To keep up with what's coming out in Keystone, and what we are working on, you can
follow our blog (as well as our changelogs).
</p>
<p>Happy coding!</p>
<HomepageFooter />
Expand Down

0 comments on commit c94cd64

Please sign in to comment.