github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-03 03:00:39 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs updates

Browse Source
This commit is contained in:
Ben Haynes
2020-12-09 19:05:01 -05:00
parent 73a4c756fd
commit c0d1eeed25
12 changed files with 80 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/concepts/api-extensions.md
View File

@@ -1,3 +1,3 @@
# API Extensions
@TODO
> TK

18
docs/concepts/app-extensions.md
View File

@@ -1,4 +1,4 @@
# App Components
# App Extensions
> Directus has been architected as completely modular and extensible. There are four keystone
> component types within the App. Out-of-the-box components are configurable, or altogether new
@@ -109,19 +109,3 @@ options.
### Relevant Guides
- [Creating a Custom Display](/guides/extensions/displays)
## Title Formatter
Directus uses [Database Mirroring](/concepts/platform-overview) to create its underlying data model
based on your custom schema. Therefore the App needs a reliable way of converting any raw table
name, field name, or other technical value into a prettified format that is human-readable. At its
core, the Title Formatter converts any string into title-case with proper whitespace. It also covers
acronyms, initialisms, common proper nouns, so each is output properly. Some example conversion
include:
| Original String | Formatted Title |
| ---------------------------- | --------------------------------- |
| `snowWhiteAndTheSevenDwarfs` | `Snow White and the Seven Dwarfs` |
| `NewcastleUponTyne` | `Newcastle upon Tyne` |
| `brighton_by_the_sea` | `Brighton by the Sea` |
| `new_ipad_ftp_app` | `New iPad FTP App` |

10
docs/concepts/platform-overview.md
View File

@@ -1,7 +1,7 @@
# Platform Overview
> The Directus platform is primarily comprised of an API and App, working in concert to manage the
> content of your SQL database.
> The Directus platform is primarily comprised of an API and App, working in concert to "mirror" the
> schema and content of your SQL database.
## Database Mirroring
@@ -97,14 +97,14 @@ Each field also mirrors other characteristics from the column, including its `ty
`length`, `allow_null`, etc.
<!-- prettier-ignore-start -->
::: tip Usage
::: tip Usage
You might have `title`, `body`, `author`, and `date_published` fields within an
`articles` collection.
:::
<!-- prettier-ignore-end -->
<!-- prettier-ignore-start -->
::: tip Aliases
::: tip Aliases
Not all fields in Directus map directly to an actual database column within their
table. Some relational fields, like One-to-Many (O2M) and Many-to-Many (M2M), represent data that is
stored in different tables. Other fields are only for presentation and don't save data at all, such
@@ -113,7 +113,7 @@ as a divider. These are called "alias" fields.
<!-- prettier-ignore-end -->
<!-- prettier-ignore-start -->
::: tip Relational Fields
::: tip Relational Fields
Fields that reference other items (in the same collection or different)
are called relational fields. Linking or connecting data relationally is an immensely powerful
feature of relational databases and SQL queries.

13
docs/getting-started/installation.md
View File

@@ -1,16 +1,15 @@
# Installation
Directus can be installed in many different ways, on several different stacks. CLI is the
recommended method, but there are many ways to get started with our platform depending on your
needs.
Directus can be installed in many different ways, on several different stacks. While our CLI is the
easiest method, feel free to use whichever option best suits your needs.
- [Command Line Interface (CLI)](/guides/installation/cli)
- [Docker](/guides/installation/docker)
- [Manually](/guides/installation/manual)
<!-- prettier-ignore-start -->
::: tip Development
Environment Developers looking to work on the project's source code should
::: tip Development Environment
To work on the project's source code, please
follow our [Contributing Guide](/getting-started/contributing).
:::
<!-- prettier-ignore-end -->
@@ -20,6 +19,10 @@ follow our [Contributing Guide](/getting-started/contributing).
- [Amazon AWS](/guides/installation/aws)
- [DigitalOcean App Platform](/guides/installation/digitalocean-app-platform)
## One-Click Install Guides
- [Platform.sh](/guides/installation/platformsh-one-click)
<!--
@TODO
- [Google App Engine](/guides/installation/google-app-engine)

8
docs/guides/installation/digitalocean-app-platform.md
View File

@@ -1,20 +1,20 @@
# DigitalOcean App Platform
## 1) Setup a repo on GitHub
## 1. Setup a repo on GitHub
See the doc on [installing Directus manually](/guides/installation/manual) to learn how to configure
this repo
## 2) Create a Managed Database instance
## 2. Create a Managed Database instance
We recommend using Postgres 12. The exact size and need for a replica depends on your usage and
project requirements.
## 3) Create a new App using your previously created repo
## 3. Create a new App using your previously created repo
Make sure to select the database you created in step 2 during the configuration wizard.
## 4) Configure the environment variables
## 4. Configure the environment variables
See [Environment Variables](/reference/environment-variables) for all available environment
variables.

15
docs/guides/installation/digitalocean-one-click.md Normal file
View File

@@ -0,0 +1,15 @@
# DigitalOcean One-Click Install
## 1. Navigate to Directus on the DigitalOcean Marketplace
The [Directus page can be found here](https://marketplace.digitalocean.com/apps/directus), or you can browse for Directus within the [entire marketplace](https://marketplace.digitalocean.com/).
## 2. Click on "Create Directus Droplet"
## 3. Follow the prompts
<!-- prettier-ignore-start -->
::: warning Paid Service
This is a paid service, so while Directus is completely free and open-source, you will likely need to enter a payment method, and may incur charges.
:::
<!-- prettier-ignore-end -->

11
docs/guides/installation/platformsh-one-click.md Normal file
View File

@@ -0,0 +1,11 @@
# Platform.sh One-Click Install
## 1. Click the Install Link
As the name suggests, simply click on this direct link to: [Install Directus on Platform.sh](https://console.platform.sh/projects/create-project?template=https%3A%2F%2Fraw.githubusercontent.com%2Fplatformsh%2Ftemplate-builder%2Fmaster%2Ftemplates%2Fdirectus%2F.platform.template.yaml) ... or manually browse for "Directus" on the [Platform.sh Marketplace](https://platform.sh/marketplace/).
<!-- prettier-ignore-start -->
::: warning Paid Service
This is a paid service, so while Directus is completely free and open-source, you will likely need to enter a payment method, and may incur charges.
:::
<!-- prettier-ignore-end -->

6
docs/guides/items.md
View File

@@ -1,8 +1,8 @@
# Items
@TODO
> TK
Browse:
From Collection Detail pages...
## Creating Items
@@ -26,7 +26,7 @@ Browse:
---
Detail:
From Item Detail pages...
## Creating an Item

12
docs/nav-web.yaml
View File

@@ -84,6 +84,9 @@
- type: page
path: /guides/installation/aws
title: AWS
- type: page
path: /guides/installation/platformsh-one-click
title: Platform.sh One-Click
- type: group
title: Extensions
children:
@@ -132,6 +135,9 @@
- type: page
path: /reference/item-objects
title: Item Objects
- type: page
path: /reference/internal-helpers
title: Internal Helpers
- type: page
path: /reference/sdk-js
title: JavaScript SDK
@@ -141,15 +147,15 @@
- type: page
path: /reference/api/introduction
title: Introduction
- type: page
path: /reference/api/items
title: Items
- type: group
title: Query Parameters
children:
- type: page
path: /reference/api/query/fields
title: Fields
- type: page
path: /reference/api/items
title: Items
- type: page
path: /reference/api/activity
title: Activity

4
docs/reference/command-line-interface.md
View File

@@ -1,4 +1,6 @@
# Command Line Interface (CLI)
# Command Line Interface
> TK
### Examples

2
docs/reference/error-codes.md
View File

@@ -1,6 +1,6 @@
# Error Codes
@TODO
> TK
| Error Code | Description |
| --------------------- | ---------------------------------------------- |

19
docs/reference/internal-helpers.md Normal file
View File

@@ -0,0 +1,19 @@
# Internal Helpers
> Below are some functions you may find helpful when working with data and values within Directus.
## Title Formatter
Directus uses [Database Mirroring](/concepts/platform-overview) to create its underlying data model
based on your custom schema. Therefore the App needs a reliable way of converting any raw table
name, field name, or other technical value into a prettified format that is human-readable. At its
core, the Title Formatter converts any string into title-case with proper whitespace. It also covers
acronyms, initialisms, common proper nouns, so each is output properly. Some example conversion
include:
| Original String | Formatted Title |
| ---------------------------- | --------------------------------- |
| `snowWhiteAndTheSevenDwarfs` | `Snow White and the Seven Dwarfs` |
| `NewcastleUponTyne` | `Newcastle upon Tyne` |
| `brighton_by_the_sea` | `Brighton by the Sea` |
| `new_ipad_ftp_app` | `New iPad FTP App` |