Docs updates

This commit is contained in:
Ben Haynes
2020-10-02 13:06:02 -04:00
parent b6544789b5
commit d5fc7b1d2e
5 changed files with 31 additions and 9 deletions

View File

@@ -44,16 +44,16 @@ const sections: Section[] = [
default: 'readme',
children: [
{
name: 'Database Mirroring',
to: '/docs/concepts/database-mirroring',
name: 'Platform Overview',
to: '/docs/concepts/platform-overview',
},
{
name: 'App Overview',
to: '/docs/concepts/app-overview',
},
{
name: 'App Components',
to: '/docs/concepts/app-components',
name: 'App Extensions',
to: '/docs/concepts/app-extensions',
},
{
name: 'Activity & Versions',

View File

@@ -1,10 +1,10 @@
# Database Mirroring
# Platform Overview
> Instead of using a predefined "one-size-fits-all" data model to store your content, Directus "mirrors" your actual SQL database in real-time.
> The Directus platform is primarily comprised of an API and App, working in concert to manage the content of your SQL database.
## Advantages
## Database Mirroring
The principle is akin to a database client (eg: _phpMyAdmin_), but includes far mor advanced tools, and is safe and intutive enough for non-technical users. This approach has many unique advantages:
Instead of using a predefined "one-size-fits-all" data model to store your content, Directus "mirrors" your actual SQL database in real-time. The principle is akin to a database client (eg: _phpMyAdmin_), but includes far mor advanced tools, and is safe and intutive enough for non-technical users. This approach has many unique advantages:
* A custom SQL database schema, tailored to your exact requirements
* Significant performance improvements through optimizations and indexing
@@ -12,6 +12,24 @@ The principle is akin to a database client (eg: _phpMyAdmin_), but includes far
* Direct database access and the full power of raw/complex SQL queries
* Allows importing existing databases, unaltered and without any migrations
## Directus API
The Directus API uses _Database Mirroring_ to dynamically generate REST endpoints and a GraphQL schema based on the connected database's architecture. It is written in [Node.js](#) and uses database abstraction to support most [SQL database vendors](#).
### Relevant Docs
* [API Reference](#)
* [API Extensions](#)
## Directus App
The Directus App is decoupled from, and powered by, the Directus API. It provides a way for both technical admins and non-technical users to view and manage content of the connected database. It is written in [Vue.js](#) v3, is completely modular, and is highly customizable.
### Relevant Docs
* [App Overview](#)
* [App Extensions](#)
## Projects & Environments
A Project is a complete instance of Directus. Each project primarily represents a database, but also includes a configuration file and any related asset storage. This modular approach means you can also create different environments (eg: Dev, Staging, Prod) by simply creating additional project instances.

View File

@@ -1,6 +1,6 @@
# Collections
> TK
> You can manage your collections within the Data Model section of the App's Settings, via the [API Collections Endpoint](#), or directly within the database. If you're unfamiliar with Directus Collections, please start by reading our [Understanding Collections](#) docs.
## Creating a Collection

View File

@@ -26,6 +26,10 @@ Keep in mind that Directus Fields are just a database columns. Therefore you can
2. Click the **More Options** icon for the field you want to delete
3. Click the **Duplicate Field** option
:::warning Relational and Primary Key Fields
It is not currently possible to duplicate relational fields or a collection's primary key.
:::
## Adjusting Field Layout
The layout of the collection's form is determined by the following field options.