Skip to content

Commit

Permalink
restructure docs TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolasburk committed Nov 14, 2019
1 parent 5904b91 commit 5eb90f4
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 81 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To get started, you can explore a number of ready-to-run [examples](https://gith

![](https://i.imgur.com/FmaRakd.png)

The Prisma Framework (formerly called [Prisma 2](https://www.prisma.io/blog/announcing-prisma-2-zq1s745db8i5/)) is an application data framework that consists of these tools:
The Prisma Framework (formerly called [Prisma 2](https://www.prisma.io/blog/announcing-prisma-2-zq1s745db8i5/)) is a database framework that consists of these tools:

- [**Photon**](https://photonjs.prisma.io/): Type-safe and auto-generated database client ("ORM replacement")
- [**Lift**](https://lift.prisma.io/): Declarative data modeling and migrations
Expand Down Expand Up @@ -43,33 +43,26 @@ The interactive prompt will ask you to provide database credentials for your dat
- [Data sources](./docs/data-sources.md)
- [Data modeling](./docs/data-modeling.md)
- [Relations](./docs/relations.md)
- [Prisma 2 CLI](./docs/prisma2-cli.md)
- [Prisma Framework CLI](./docs/prisma2-cli.md)
- [Development mode](./docs/development-mode.md)
- [Introspection](./docs/introspection.md)
- [Limitations](./docs/limitations.md)
- Core
- Connectors
- [MySQL](./docs/core/connectors/mysql.md)
- [PostgreSQL](./docs/core/connectors/postgresql.md)
- [SQLite](./docs/core/connectors/sqlite.md)
- [MongoDB](./docs/core/connectors/mongo.md)
- Generators
- [Photon.js](./docs/core/generators/photonjs.md)
- [Core](./docs/core)
- Photon
- [API](./docs/photon/api.md)
- [Use only Photon](./docs/photon/use-only-photon.md)
- [Code generation & Node.js setup](./docs/photon/codegen-and-node-setup.md)
- [Deployment](./docs/photon/deployment.md)
- Lift
- [Steps](./docs/lift/steps.md)
- [Migration files](./docs/lift/migration-files.md)
- [Use only Lift](./docs/lift/use-only-lift.md)
- [Lift](./docs/lift)
- [Importing and exporting data](./docs/import-and-export-data)
- [Supported databases](./docs/supported-databases.md)
- [Telemetry](./docs/telemetry.md)
- [How to provide feedback for Prisma 2?](./docs/prisma2-feedback.md)
- [How to provide feedback for the Prisma Framework?](./docs/prisma2-feedback.md)
- [Release process](./docs/releases.md)
- [Upgrading from Prisma 1](./docs/upgrading-from-prisma-1.md)
- [FAQ](./docs/faq.md)
- [Glossary](./docs/glossary.md)

## Contributing
Read more about how to contribute to Prisma Framework [here](https://github.com/prisma/prisma2/blob/master/CONTRIBUTING.md)

Read more about how to contribute to the Prisma Framework [here](https://github.com/prisma/prisma2/blob/master/CONTRIBUTING.md)
11 changes: 11 additions & 0 deletions docs/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Core

This directory contains documentation about the Prisma Framework core components:

- Connectors
- [MySQL](./connectors/mysql.md)
- [PostgreSQL](./connectors/postgresql.md)
- [SQLite](./connectors/sqlite.md)
- [MongoDB](./connectors/mongo.md)
- Generators
- [Photon.js](./generators/photonjs.md)
6 changes: 6 additions & 0 deletions docs/lift/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Lift

This directory contains the documentation for the Lift. Lift is the Prisma Framework's schema migration tool. To learn more about Lift's CLI commands, check out the docs for the [Prisma Framework CLI](../prisma2-cli.md).

- [Migration files](./migration-files.md)
- [Use only Lift](./use-only-lift.md)
13 changes: 11 additions & 2 deletions docs/lift/migration-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ When saving a migration with `prisma lift save`, Lift creates three migration fi

## `README.md`

## `datamodel.prisma`
The README contains information about the migration in human-readable form:

## `steps.json`
- An overview of the SQL statements that will be executed by Lift when you run `prisma2 lift up`
- A diff of the changes in your [Prisma schema](../prisma-schema-file.md)

## `schema.prisma`

The `schema.prisma` file represents the target [Prisma schema](../prisma-schema-file.md) of the migration.

## `steps.json`

The `steps.json` is another representation of the steps that will be performed by Lift when you're executing the migration with `prisma2 lift up`. You can learn more about it in the [spec](https://github.com/prisma/specs/tree/lift/document-migration-steps/lift#step).
54 changes: 0 additions & 54 deletions docs/lift/steps.md

This file was deleted.

21 changes: 12 additions & 9 deletions docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
# Release process

This page explains the release process for Prisma 2.
This page explains the release process for the Prisma Framework.

## Release log

You can find all previous release of Prisma 2 [here](https://github.com/prisma/prisma2/releases).
You can find all previous releases of the Prisma Framework [here](https://github.com/prisma/prisma2/releases). Note that the versioining scheme has been adjusted with the [`2.0.0-preview014`](https://github.com/prisma/prisma2/releases/tag/2.0.0-preview014) release to fully comply to the [semver](https://semver.org/) spec.

## Release channels

There are two main release channels:

- **Preview**: Weekly releases on Thursdays
- **Preview**: Biweekly releases on Thursdays
- **Alpha**: Rolling/continuous releases

Unless you have specific requirements for the alpha channel, it is recommended to always use the latest Preview release.
Unless you have specific requirements for the Alpha channel, it is recommended to always use the latest Preview release.

### Preview

Prisma 2 has a **weekly release cycle** where new Preview releases are typically issued **on Thursdays** (but might be delayed).
The Prisma Frameowrk follows a **biweekly release cycle** where new Preview releases are typically issued **on Thursdays** (but might be delayed).

Preview releases are named `2.0.0-preview-1`, `2.0.0-preview-2`, `2.0.0-preview-3`, ... or you can reference them for short: `preview-1`, `preview-2`, `preview-3` ...
Preview releases are named `2.0.0-preview014`, `2.0.0-preview015`, `2.0.0-preview016`, ... or you can reference them for short: `preview014`, `preview015`, `preview016` ...

You can install the latest Preview release via npm:

```
npm install -g prisma2
```

Note that the Prisma Framework CLI currently requires [Node 8](https://nodejs.org/en/download/releases/) (or higher). It also executes a [`postinstall`](./prisma2-cli.md#the-postinstall-hook) hook.


### Alpha (latest)

The alpha channel contains the latest changes to Prisma 2. Because alpha is based on a development branch, it's more likely that things break or behave unexpectedly in an alpha release.
The Alpha channel contains the latest changes to Prisma 2. Because it's is based on the [`alpha`](https://github.com/prisma/prisma2/tree/alpha) development branch, it's more likely that things break or behave unexpectedly in an Alpha release.

You should only use alpha releases if you have specific requirements that are not met by the latest Preview release.
You should only use Alpha releases if you have specific requirements that are not met by the current Preview release.

You can install the latest alpha release via npm:
You can install the latest Alpha release via npm:

```
npm install -g prisma2@alpha
Expand Down

0 comments on commit 5eb90f4

Please sign in to comment.