Skip to content

Commit

Permalink
fixed svg fonts and position (#5468)
Browse files Browse the repository at this point in the history
* fixed svg fonts and position

* “prettier”

* fixed tutorial markup to be more inline with the rest of the system (#5469)
  • Loading branch information
dominikwilkowski committed Apr 15, 2021
1 parent 0e74d81 commit d8c04b5
Show file tree
Hide file tree
Showing 9 changed files with 84 additions and 164 deletions.
27 changes: 0 additions & 27 deletions docs-next/components/Alert.tsx

This file was deleted.

5 changes: 5 additions & 0 deletions docs-next/pages/_document.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ class MyDocument extends Document {
<meta name="msapplication-config" content="/browserconfig.xml" />
<meta name="theme-color" content="#ffffff" />

<link
href="https://fonts.googleapis.com/css2?family=Source+Code+Pro&display=swap"
rel="stylesheet"
/>

<script async src={`https://www.googletagmanager.com/gtag/js?id=${GA_TRACKING_ID}`} />
<script
dangerouslySetInnerHTML={{
Expand Down
13 changes: 0 additions & 13 deletions docs-next/pages/guides/getting-started.tsx

This file was deleted.

8 changes: 1 addition & 7 deletions docs-next/pages/guides/keystone-5-vs-keystone-next.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
import { Page, components } from '../../components/Page';
import { getHeadings } from '../../lib/getHeadings';
import { InlineCode } from '../../components/Code';
import { Alert } from '../../components/Alert';
import { MDXProvider } from '@mdx-js/react';
import Image from 'next/image';
import Link from 'next/link';

# Keystone 5 vs Next. Which should you use?

<Alert>
Updated March 31st, 2021. See our <Link href="https://next.keystonejs.com/roadmap">roadmap</Link> for the latest improvements.
</Alert>
?> Updated March 31st, 2021. See our [roadmap](https://next.keystonejs.com/roadmap) for the latest improvements.

Keystone 5 is now in **maintenance mode**. We‘re focusing all our efforts on Keystone Next, to be released as Keystone 6 later this year. If you’re wondering which version to start your next project with, this guide is for you.

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
import { Page, components } from '../../../components/Page';
import { getHeadings } from '../../../lib/getHeadings';
import { InlineCode } from '../../../components/Code';
import { Alert } from '../../../components/Alert';
import { MDXProvider } from '@mdx-js/react';
import Image from 'next/image';
import Link from 'next/link';

<img
src={require('./assets/cover.svg')}
alt="A terminal with the output of create-keystone-app"
style={{
margin: '0 -1rem 2rem -1rem',
width: 'calc(100% + 2rem)',
maxWidth: 'none',
}}
/>
import { Markdown } from '../../../components/Page';

![A terminal with the output of create-keystone-app](/assets/tutorials/getting-started/cover.svg)

# Getting started

Expand Down Expand Up @@ -52,9 +38,7 @@ cd your/path/
npm init keystone-app
```

<Alert>
<InlineCode>npm init {"<initializer>"}</InlineCode> is available in npm 6+
</Alert>
?> `npm init "<initializer>"` is available in npm 6+

### npx

Expand All @@ -65,27 +49,18 @@ cd your/path/
npx create-keystone-app
```

<Alert>
<InlineCode>npx</InlineCode> comes with npm 5.2+
</Alert>
?> `npx` comes with npm 5.2+

## Connecting your database

The CLI will ask you to name your new app and for a way to connect to your database.
Make sure you have your connection URL ready for your database, e.g. `postgres://localhost/my-app` or `postgres://username:password@localhost/my-app`.

<Alert>
If you run into trouble with the database, check out this guide on <Link href="https://www.keystonejs.com/quick-start/adapters">Database Setup</Link>
</Alert>
?> If you run into trouble with the database, check out this guide on [Database Setup](https://www.keystonejs.com/quick-start/adapters)

## Opening your shiny new Admin UI

<Image
src={require('./assets/adminui.png')}
alt="The AdminUI of Keystone showing the two lists: User and Posts"
width={1954}
height={764}
/>
![The AdminUI of Keystone showing the two lists: User and Posts](/assets/tutorials/getting-started/adminui.png)

After running `create-keystone-app` you can now `cd` into the folder that was created for you and start Keystone.

Expand All @@ -96,12 +71,7 @@ yarn dev

This will generate the Admin UI pages via [Next.js](https://nextjs.org/) on [http://localhost:3000](http://localhost:3000).

<Image
src={require('./assets/welcome-screen.png')}
alt="The welcome screen giving you the ability the create a new user to log into the AdminUI"
width={1328}
height={1020}
/>
![The welcome screen giving you the ability the create a new user to log into the AdminUI](/assets/tutorials/getting-started/welcome-screen.png)

When you visit the Admin UI for the first time you will be presented with a handy screen that asks you to create a user.
Go ahead and create your first user.
Expand Down Expand Up @@ -148,15 +118,6 @@ Read more about the cli in our [command line guides](/guides/cli).
- Customize Keystone with the [System Configuration API](/apis/config).
- Add fields and relationships using [Schema API](/apis/schema).

export default ({ children }) => {
const headings = getHeadings(children);
return (
<Page
title={'Getting started'}
headings={headings}
isProse
>
<MDXProvider components={components}>{children}</MDXProvider>
</Page>
);
};
export default ({ children }) => <Markdown>{children}</Markdown>

;
67 changes: 67 additions & 0 deletions docs-next/public/assets/tutorials/getting-started/cover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit d8c04b5

@vercel
Copy link

@vercel vercel bot commented on d8c04b5 Apr 15, 2021

Choose a reason for hiding this comment

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

Please sign in to comment.