github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-15 02:38:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

Split existing docs pages into Developer Docs and User Guide (#18951)

Browse Source 
* docs: add getting started

* docs: add data model

* docs: add content module

* docs: add user management

* docs: add file library

* docs: add insights

* docs: add general settings

* docs: update user guide sidebar

* docs: update sidebar

* docs: add data studio app to dev docs sidebar

* docs: update content module

* docs: update directus cloud

* docs: update settings and content module

* docs: removed unused files in app

* chore: update links

* chore: update redirects

* docs: update redirects

* chore: update redirects

* chore: update urls

* docs: add active match

* Remove unused import

---------

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
This commit is contained in:
Esther Agbaje
2023-06-26 23:03:33 +04:00
committed by GitHub
parent 94bfecf72e
commit d8727ba4f1
37 changed files with 1458 additions and 314 deletions
Download Patch File Download Diff File Expand all files Collapse all files

283
docs/.vitepress/config.js
View File

@@ -129,6 +129,11 @@ gtag('config', 'UA-24637628-7');
},
nav: [
{ text: 'Docs', link: '/' },
{
text: 'User Guide',
link: '/user-guide/overview/data-studio-app',
activeMatch: '/user-guide',
},
// { text: 'Cookbook', link: '/cookbook/add-a-recipe', activeMatch: '/cookbook/' },
{ text: 'Website', link: 'https://directus.io/' },
{ text: 'Cloud', link: 'https://directus.cloud/' },
@@ -142,6 +147,7 @@ gtag('config', 'UA-24637628-7');
sidebar: {
// '/cookbook/': sidebarCookbooks(),
'/': sidebar(),
'/user-guide/': sidebarUserGuide(),
'/packages/': sidebarTypedocs(),
},
editLink: {
@@ -219,10 +225,6 @@ function sidebar() {
text: 'Resources',
link: '/getting-started/resources',
},
{
text: 'Glossary',
link: '/getting-started/glossary',
},
],
},
{
@@ -230,66 +232,6 @@ function sidebar() {
collapsible: true,
collapsed: true,
items: [
{
link: '/app/overview',
text: 'Overview',
},
{
link: '/app/content',
text: 'Content',
type: 'page',
items: [
{
link: '/app/content/collections',
text: 'Collection Page',
type: 'page',
},
{
link: '/app/content/items',
text: 'Item Page',
},
{
link: '/app/content/shares',
text: 'Shares',
},
],
},
{
link: '/app/user-directory',
text: 'User Directory',
},
{
link: '/app/file-library',
text: 'File Library',
},
{
link: '/app/insights',
text: 'Insights',
},
{
link: '/app/settings',
text: 'Settings',
},
{
link: '/app/display-templates',
text: 'Display Templates',
},
{
link: '/app/filters',
text: 'Filters',
},
{
link: '/app/layouts',
text: 'Layouts',
},
{
link: '/app/import-export',
text: 'Import / Export',
},
{
link: '/app/project-settings',
text: 'Project Settings',
},
{
link: '/app/data-model',
text: 'Data Model',
@@ -336,32 +278,6 @@ function sidebar() {
},
],
},
{
link: '/app/users-roles-permissions',
text: 'Users, Roles & Permissions',
items: [
{
link: '/app/users-roles-permissions/users',
text: 'Users',
},
{
link: '/app/users-roles-permissions/roles',
text: 'Roles',
},
{
link: '/app/users-roles-permissions/permissions',
text: 'Permissions',
},
],
},
{
link: '/app/presets-bookmarks',
text: 'Presets & Bookmarks',
},
{
link: '/app/translation-strings',
text: 'Translation Strings',
},
{
link: '/app/webhooks',
text: 'Webhooks',
@@ -381,10 +297,6 @@ function sidebar() {
},
],
},
{
link: '/app/activity-log',
text: 'Activity Log',
},
],
},
{
@@ -724,3 +636,186 @@ function sidebar() {
},
];
}
function sidebarUserGuide() {
return [
{
text: 'Overview',
items: [
{
text: 'Data Studio App',
link: '/user-guide/overview/data-studio-app',
},
{
text: 'Quickstart Guide',
link: '/user-guide/overview/quickstart',
},
{
text: 'Glossary',
link: '/user-guide/overview/glossary',
},
],
},
{
text: 'Content Module',
collapsible: true,
collapsed: true,
items: [
{
link: '/user-guide/content-module/content',
text: 'Managing Content',
type: 'page',
items: [
{
link: '/user-guide/content-module/content/collections',
text: 'Collection Page',
type: 'page',
},
{
link: '/user-guide/content-module/content/items',
text: 'Item Page',
},
{
link: '/user-guide/content-module/content/shares',
text: 'Shares',
},
],
},
{
text: 'Layouts',
link: '/user-guide/content-module/layouts',
},
{
text: 'Import/Export',
link: '/user-guide/content-module/import-export',
},
{
text: 'Filters',
link: '/user-guide/content-module/filters',
},
{
text: 'Translation Strings',
link: '/user-guide/content-module/translation-strings',
},
{
text: 'Display Templates',
link: '/user-guide/content-module/display-templates',
},
],
},
{
text: 'User Management',
collapsible: true,
collapsed: true,
items: [
{
link: '/user-guide/user-management/users-roles-permissions',
text: 'Users, Roles & Permissions',
type: 'page',
items: [
{
text: 'Users',
link: '/user-guide/user-management/users',
},
{
text: 'Roles',
link: '/user-guide/user-management/roles',
},
{
text: 'Permissions',
link: '/user-guide/user-management/permissions',
},
],
},
{
text: 'User Directory',
link: '/user-guide/user-management/user-directory',
},
],
},
{
text: 'File Library',
collapsible: true,
collapsed: true,
items: [
{
text: 'Files',
link: '/user-guide/file-library/files',
},
{
text: 'Folders',
link: '/user-guide/file-library/folders',
},
],
},
{
text: 'Insights',
collapsible: true,
collapsed: true,
items: [
{
text: 'Dashboards',
link: '/user-guide/insights/dashboards',
},
{
text: 'Panels',
link: '/user-guide/insights/panels',
},
{
text: 'Charts',
link: '/user-guide/insights/charts',
},
],
},
{
text: 'Directus Cloud',
collapsible: true,
collapsed: true,
items: [
{
text: 'Overview',
link: '/user-guide/cloud/overview',
},
{
text: 'Projects',
link: '/user-guide/cloud/projects',
},
{
text: 'Teams',
link: '/user-guide/cloud/teams',
},
{
text: 'Accounts',
link: '/user-guide/cloud/accounts',
},
{
text: 'Project Settings',
link: '/user-guide/cloud/project-settings',
},
{
text: 'Glossary',
link: '/user-guide/cloud/glossary',
},
],
},
{
text: 'General Settings',
collapsible: true,
collapsed: true,
items: [
{
text: 'Settings',
link: '/user-guide/settings/settings',
},
{
text: 'Preset and Bookmarks',
link: '/user-guide/settings/presets-bookmarks',
},
{
text: 'Activity Log',
link: '/user-guide/settings/activity-log',
},
],
},
];
}

6
docs/.vitepress/theme/DocLayout.vue
View File

@@ -1,7 +1,7 @@
<script setup>
import { computed } from 'vue';
import DefaultTheme from 'vitepress/theme';
import { useData, useRoute } from 'vitepress';
import DefaultTheme from 'vitepress/theme';
import { computed } from 'vue';
import ArticleFeedback from '../components/ArticleFeedback.vue';
const { Layout } = DefaultTheme;
@@ -25,4 +25,4 @@ const path = computed(() => route.path);
#contributors {
margin-bottom: 2em;
}
</style>
</style>

50
docs/app/data-model/collections.md
View File

@@ -42,26 +42,26 @@ each system collection is responsible for, as well as where to find relevant App
| System Collection | Purpose | APP | API |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------ |
| Activity | Tracks and stores all events within Directus, giving full accountability over everything. | [Activity Log](/app/activity-log) | [Activity](/reference/system/activity) |
| Activity | Tracks and stores all events within Directus, giving full accountability over everything. | [Activity Log](/user-guide/settings/activity-log) | [Activity](/reference/system/activity) |
| Collections | Stores data table & configuration details each and every Collection. | [Collections](/app/data-model/collections) | [Collections](/reference/system/collections) |
| Dashboards | Stores dashboard configuration details and all relationally linked panels. | [Insights](/app/insights) | **N/A** |
| Dashboards | Stores dashboard configuration details and all relationally linked panels. | [Insights](/user-guide/insights/dashboards) | **N/A** |
| Fields | Stores configuration details for each field. | [Fields](/app/data-model/fields) | [Fields](/reference/system/fields) |
| Files | This stores file location from asset storage as well as any data associated with that file. | [File Library](/app/file-library) | [Files](/reference/files) |
| Files | This stores file location from asset storage as well as any data associated with that file. | [File Library](/user-guide/file-library/files) | [Files](/reference/files) |
| Flows | Stores basic logic required for Flows, which enable event-triggered task automation. | [Flows](/app/flows) | [Flows](/reference/system/flows) |
| Folders | Stores information required for Folders, which provide virtual file asset management. | [Folders](/app/file-library#folders) | [Folders](/reference/system/folders) |
| Folders | Stores information required for Folders, which provide virtual file asset management. | [Folders](/user-guide/file-library/folders) | [Folders](/reference/system/folders) |
| Migrations | Used by our install/upgrade process to track when migration scripts for a specific release have been run. | It has no relevant app functionality. | **N/A** |
| Notifications | Stores details about in-app notifications. | [Module Bar](/app/overview#_1-module-bar) and [Sidebar](/app/overview#_4-sidebar) | [Notifications](/reference/system/notifications) |
| Operations | Stores information required for Operations, which are a part of [Flows](#flows). | [Operations](/app/flows) | [Operations](/reference/system/operations) |
| Panels | This stores information about individual analytics panels, which are displayed on [Dashboards](#dashboards). | [Insights](/app/insights) | **N/A** |
| Permissions | This stores the access permissions configured for roles. | [Users, Roles & Permissions](/app/users-roles-permissions) | [Permissions](/reference/system/permissions) |
| Operations | Stores information required for Operations, which are a part of [Flows](#flows). | [Operations](/app/flows/operations) | [Operations](/reference/system/operations) |
| Panels | This stores information about individual analytics panels, which are displayed on [Dashboards](#dashboards). | [Insights](/user-guide/insights/panels) | **N/A** |
| Permissions | This stores the access permissions configured for roles. | [Users, Roles & Permissions](/user-guide/user-management/users-roles-permissions) | [Permissions](/reference/system/permissions) |
| Presets | This stores details for presets and bookmarks. | [Presents & Bookmarks](/app/presets-bookmarks) | [Presets](/reference/system/presets) |
| Relations | This stores information about relationships between collections. | [Relationships](/app/data-model/relationships) | [Relations](/reference/system/relations) |
| Revisions | Revisions are changes/edits made to Items. Directus keeps track of edits made, so you're able to revert to a previous state at will. | [Revert an Item](/app/content/items#revert-an-item) | [Revisions](/reference/system/revisions) |
| Revisions | Revisions are changes/edits made to Items. Directus keeps track of edits made, so you're able to revert to a previous state at will. | [Revert an Item](/user-guide/content-module/content/items#revert-an-item) | [Revisions](/reference/system/revisions) |
| Roles | Stores information about each role created. | [Users, Roles, and Permissions](/app/users-roles-permissions) | [Roles](/reference/system/roles) |
| Sessions | Stores information about each user session, for system purposes. | **N/A** | **N/A** |
| Settings | Stores all configurations made within **Settings > Project Settings**. | [Project Settings](/app/project-settings) | [settings](/reference/system/settings) |
| Shares | Stores all information regarding data shares. | [Data Sharing](/app/content/shares) | |
| Users | Stores information about each user within the platform. | [User Directory](/app/user-directory) | [Users](/reference/system/relations) |
| Settings | Stores all configurations made within **Settings > Project Settings**. | [Project Settings](/user-guide/cloud/project-settings) | [settings](/reference/system/settings) |
| Shares | Stores all information regarding data shares. | [Data Sharing](/user-guide/content-module/content/shares) | |
| Users | Stores information about each user within the platform. | [User Directory](/user-guide/user-management/user-directory) | [Users](/reference/system/relations) |
| Webhooks | Stores all information about configured webhooks. | [Webhooks](/app/webhooks) | [Webhooks](/reference/system/relations) |
## Create a Collection
@@ -132,7 +132,7 @@ To toggle whether a collection is hidden by default in the Content Module, follo
:::tip
Assuming a user has [access permissions](/app/users-roles-permissions), hidden collections can still be viewed. They
Assuming a user has [access permissions](/user-guide/user-management/users-roles-permissions), hidden collections can still be viewed. They
must right-click on the Navigation Bar and choose <span mi icon>visibility</span> **Show Hidden Collections**.
:::
@@ -205,7 +205,7 @@ To configure a collection, follow these steps.
</video>
This section allows you to create and configure fields, as well as configure how fields are displayed on the
[Item Details Page](/app/content/items). To learn more, please see the documentation on
[Item Details Page](/user-guide/content-module/content/items). To learn more, please see the documentation on
[fields](/app/data-model/fields).
### Collection Setup
@@ -221,20 +221,20 @@ These controls allow you to modify how the collection is displayed within the Co
- **Note** — Set a helpful note that explains the collection's purpose.
- **Icon** — Set an icon used throughout the app when referencing this collection.
- **Color** — Set a color for the icon, shown in the Navigation Bar and its page header.
- **Display Template** — Create a [Display Template](/app/display-templates) for the collection.
- **Display Template** — Create a [Display Template](/user-guide/content-module/display-templates) for the collection.
- **Hidden** — Toggle whether the collection should be globally hidden in the other app modules, even for admin users.
You cannot hide collections for admins via permissions like other roles, so this comes in handy to tidy up the Content
Module.
- **Singleton** — Toggle to bypass the [Collection Page](/app/content/collections) and take users to the
[Item Details Page](/app/content/items).
- **Singleton** — Toggle to bypass the [Collection Page](/user-guide/content-module/content/collections) and take users to the
[Item Details Page](/user-guide/content-module/content/items).
- **Collection Naming Translations** — Translate the collection name across multiple languages. When the default
language is changed in [Project Settings](/app/project-settings#general) or
[User Details Page](/app/user-directory#user-details-page), the relevant translation, if any exists, will be used
language is changed in [Project Settings](/user-guide/cloud/project-settings#general) or
[User Details Page]( /user-guide/user-management/user-directoryy#user-details-page), the relevant translation, if any exists, will be used
throughout the app.
:::tip Collection Naming Translations
By default, Directus uses the [Title Formatter](/getting-started/glossary#title-formatter) to display collection keys as
By default, Directus uses the [Title Formatter](/user-guide/overview/glossary#title-formatter) to display collection keys as
human readable names, but you can also use translations to explicitly rename more technical table keys.
:::
@@ -257,11 +257,11 @@ archive field, set the following four input fields as desired.
- **Archive Field** — Selects the archive field from a dropdown menu.
- **Archive App Filter** — Toggles whether app users can
[filter for archived items](/app/content/collections#view-archived-items).
[filter for archived items](/user-guide/content-module/content/collections#view-archived-items).
- **Archive Value** — A value that is assigned to the field when an item is
[archived](/app/content/items#archive-an-item).
[archived](/user-guide/content-module/content/items#archive-an-item).
- **Unarchive Value** — A value that is assigned to the field when an item is
[unarchived](/app/content/items#archive-an-item).
[unarchived](/user-guide/content-module/content/items#archive-an-item).
:::tip Automatic Setup
@@ -289,9 +289,9 @@ filtered out. This gives you the flexibility to manage archived items however yo
<source src="https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/manually-sort-items-20220415A.mp4" type="video/mp4" />
</video>
The sort feature enables users to [manually sort Items](/app/content/collections#manually-sort-items) within the Data
The sort feature enables users to [manually sort Items](/user-guide/content-module/content/collections#manually-sort-items) within the Data
Studio. This is typically shown on the **Content Module > Collection Page**. It can also be used for sorting items
within [Junction Collections](/getting-started/glossary#junction-collections). A standard field, configured with an
within [Junction Collections](/user-guide/overview/glossary#junction-collections). A standard field, configured with an
`INTEGER` data type, is required. As shown in the video, fields which cannot serve as sort fields will be grayed out and
unselectable in the Sort Field dropdown.
@@ -304,7 +304,7 @@ To configure a sort field, follow these steps.
3. Click <span mi btn>check</span> to confirm.
Once you sort field is configured, you may want to learn how to
[manually sort Items](/app/content/collections#manually-sort-items).
[manually sort Items](/user-guide/content-module/content/collections#manually-sort-items).
::: tip Automatic Setup

10
docs/getting-started/quickstart.md
View File

@@ -53,7 +53,7 @@ will end up in another folder like "Social" or "Promotions".
## 3. Create a Collection
Once logged in, you're greeted with the option to create your first [Collection](/getting-started/glossary#collections).
Once logged in, you're greeted with the option to create your first [Collection](/user-guide/overview/glossary#collections).
1. Navigate into the Content Module.
2. Click **"Create Collection"** and a side menu will appear.
@@ -66,7 +66,7 @@ Once logged in, you're greeted with the option to create your first [Collection]
:::tip Learn More About Collections
- [The Content Module](/app/content)
- [The Content Module](/user-guide/content-module/content)
- [Create and Manage a Collection](/app/data-model/collections)
- [Build Relationships Between Collections](/app/data-model/relationships)
@@ -74,7 +74,7 @@ Once logged in, you're greeted with the option to create your first [Collection]
## 4. Create a Field
With your first Collection created, it's time to start adding some [Fields](/getting-started/glossary#fields).
With your first Collection created, it's time to start adding some [Fields](/user-guide/overview/glossary#fields).
1. Navigate to **Settings Module > Data Model > `Collection-Name`**.
2. Click the **"Create Field"** button and select the **"Input"** Field type.
@@ -90,7 +90,7 @@ With your first Collection created, it's time to start adding some [Fields](/get
## 5. Create an Item
Now that we have a Collection with a Field configured, it's time to add an [Item](/getting-started/glossary#).
Now that we have a Collection with a Field configured, it's time to add an [Item](/user-guide/overview/glossary#).
1. Navigate to the Content Module.
2. Click <span mi btn>add</span> in the page header to open the Item Page.
@@ -124,7 +124,7 @@ of creating a new Role.
::: tip Learn More About Roles & Permissions
- [Users, Roles and Permissions](/app/users-roles-permissions).
- [Users, Roles and Permissions](/user-guide/user-management/users-roles-permissions).
:::

58
docs/netlify.toml
View File

@@ -11,11 +11,6 @@
autoLaunch = false
framework = "#custom"
[[redirects]]
from = "/"
to = "/getting-started/introduction"
status = 301
force = true
[[redirects]]
from = "/api/*"
@@ -63,11 +58,56 @@
status = 301
[[redirects]]
from = "/cloud/*"
to = "/"
from = "/getting-started/backing-directus"
to = "/contributing/sponsor"
status = 301
[[redirects]]
from = "/getting-started/backing-directus"
to = "/contributing/sponsor"
from = "/app/content/*"
to = "/user-guide/content-module/content/:splat"
status = 301
[[redirects]]
from = "/app/users-roles-permissions.html"
to = "/user-guide/user-management/users-roles-permissions.html"
status = 301
[[redirects]]
from = "/getting-started/glossary.html"
to = "/user-guide/overview/glossary.html"
status = 301
[[redirects]]
from = "/app/activity-log.html"
to = "/user-guide/settings/activity-log.html"
status = 301
[[redirects]]
from = "/app/insights.html"
to = "/user-guide/insights/dashboards.html"
status = 301
[[redirects]]
from = "/app/file-library.html"
to = "/user-guide/file-library/files.html"
status = 301
[[redirects]]
from = "/app/project-settings.html"
to = "/user-guide/cloud/project-settings.html"
status = 301
[[redirects]]
from = "/app/content/shares.html"
to = "/user-guide/content-module/content/shares.html"
status = 301
[[redirects]]
from = "/app/user-directory.html"
to = "/user-guide/user-management/user-directory.html"
status = 301
[[redirects]]
from = "/cloud/*"
to = "/user-guide/cloud/:splat"
status = 301

69
docs/user-guide/cloud/accounts.md Normal file
View File

@@ -0,0 +1,69 @@
---
description:
Creating an Account is easy and free. Your Account gives you SuperAdmin access to your Teams and Projects on Directus
Cloud, enabling you to create and manage Teams, Team Members, Projects, and Project Billing.
readTime: 3 min read
---
# Managing Cloud Accounts
> An Account is your portal to Directus Cloud. You can use it to manage your Teams, Team Members, Projects and billing.
> To avoid confusion, "User" is the term for user profiles in a Directus Project, while the terms "Account" and "Team
> Member" are used in the context of Directus Cloud. _Accounts on Directus Cloud_ and _Users in a Directus Project_ are
> two separate systems.
## Create Account and Login
![Create Account and Login](https://cdn.directus.io/docs/v9/cloud/accounts/accounts-20220322A/login-page-20220225A.webp)
Creating an Account is easy and free. As we talked about in the [Overview](/user-guide/cloud/overview), we've made life easy for
you by giving you the option to create and log in to your free Cloud Account automatically with GitHub. If you don't
have a GitHub account or prefer not to use this login method, email-and-password login is available, as well. In either
case, simply go to the [Login Page](https://directus.cloud/login) and follow the prompts.
## Manage Account
![Manage Account](https://cdn.directus.io/docs/v9/cloud/accounts/accounts-20220322A/managing-your-account-20220225A.webp)
To update your name or email:
1. Click <span mi icon>account_circle</span> in the Dashboard Header to enter your Account page.
2. Toggle <span mi icon prmry>edit</span> to allow edits.
3. Change your name and email as desired.
4. Click the **"Save"** button.
## Reset Password
![User Account](https://cdn.directus.io/docs/v9/cloud/accounts/accounts-20220322A/reset-password-20220322A.webp)
To reset your password:
1. Click <span mi icon>account_circle</span> in the Dashboard Header to enter your Account page.
2. Click **"Send Reset Link"**. An email will be sent to reset password.
3. Log in to the email associated with your Account.
4. Open the email and click **"Reset Password"**. You will be directed to the Password Reset page.
5. Reset the password as desired and click **"Reset Password"**.
## Destroy Account
![Destroy Account](https://cdn.directus.io/docs/v9/cloud/accounts/accounts-20220322A/destroying-your-account-20220225A.webp)
To destroy your Directus Cloud Account:
1. Click <span mi icon>account_circle</span> in the Dashboard Header to enter your Account page.
2. Toggle <span mi icon dngr>local_fire_department</span> and an input box will appear.
3. Type in your password, then click the **"Destroy Account"** button.
::: danger
Destroying your Account completely removes your Account and data from Directus Cloud. This action is permanent and
irreversible. Proceed with caution!
:::
::: tip Must leave all Teams before deleting
You cannot destroy your Account if you are a Member of one or more Teams. Leave all associated Teams before destroying
your Account.
:::

274
docs/user-guide/cloud/glossary.md Normal file
View File

@@ -0,0 +1,274 @@
---
description: A glossary of terms specific to Directus Cloud.
readTime: 10 min read
---
# Glossary
## Asset Storage
Directus Core allows asset storage for any type of file. This applies to all Cloud Projects. However, on Directus Cloud,
certain hard technical limits apply to file uploads, such as limits on size per asset and total asset storage per
Project. For more details, see [Cloud Policies](https://directus.io/cloud-policies#).
## Automatic Updates
Software updates on any app can be a time-consuming chore, taking developer energy and focus away from core business
logic. Cloud Projects are updated every two weeks in rolling releases _(i.e. done with no downtime)_. These updates keep
your Project on the latest version and fully up to date with all [Cloud Exclusives](#cloud-exclusives), dependencies and
security patches.
:::tip Version-locking
Version-locking is available on Enterprise Projects.
:::
## Backups
By default, file assets and databases are backed up once per day on all Standard and Enterprise Projects. Additionally,
Enterprise customers can work with our team for more tailored backup solutions. In the event of an emergency, such as
your project crashing, don't worry! Your data will be safe. If you need access to your backed-up data,
[contact us](https://directus.io/contact).
## Caching
Caching is enabled on Cloud Projects. Public data is cached in the CDN for a short period of time. All Directus Cloud
Projects are running behind a [Global CDN](#global-cdn), but Enterprise Projects offer advanced caching strategies, as
well.
## Data Portability
Directus Core is totally detached from the database. Data can be cleanly imported and exported on Projects with the API
via the schema endpoints.
:::tip Enterprise Clients
The Directus Team will help you work through this process on all [Enterprise Projects](https://directus.io/contact).
:::
## Datacenter Regions
The location you choose to host your Project in can have a measurable impact. To help optimize your Project and meet any
local data compliance laws such as GDPR, Standard and Enterprise offer multiple Datacenter regions to host from. There
are 19 regions available for Enterprise Projects, and 3 for Standard Projects:
<table>
<tr>
<th>Region</th>
<th>Enterprise</th>
<th>Standard</th>
</tr>
<tr>
<td>United States, East</td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>Europe, Frankfurt</td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>Asia Pacific, Singapore</td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>United States, West</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Africa, Cape Town</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Hong Kong</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Jakarta</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Mumbai</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Osaka</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Seoul</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Sydney</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Asia Pacific, Tokyo</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Canada, Central</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Europe, Ireland</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Europe, London</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Europe, Paris</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Europe, Stockholm</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>Middle East, Bahrain</td>
<td>✅</td>
<td></td>
</tr>
<tr>
<td>South America, São Paulo</td>
<td>✅</td>
<td></td>
</tr>
</table>
## Encryption and Security
[Asset Storage](#asset-storage), data storage and in-transit encryption are included on all Cloud Projects. All data at
rest remains encrypted, and HTTPS/TLS protocols are enabled on all in-transit data. Cloud Projects are created with
secure and safe [tenancy architectures](#multi-tenancy).
:::tip Directus Core Security Features
Directus core comes with even more security features out-of-the-box, including IP address whitelabeling, MFA enabling,
SSO options, customization for Password Rule requirements and the flexibility to use any access token paradigm desired.
:::
## Extensions
The term _Extension_ refers to any feature or component that adds to the functionality of Directus Core. Directus has
been architected to be [completely modular and extensible](/extensions/introduction) to ensure you will never hit a hard
feature ceiling within the platform.
All Cloud Projects have access to the [Cloud Exclusive Extensions](/cloud/exclusives), which are developed and
maintained by the Core Team. Enterprise Projects get all Cloud Exclusives, but also have the option to implement their
own custom Extensions as needed.
## Global CDN
A Global CDN is provided for all Cloud Projects, out-of-the-box, with over 300 cache locations. This means assets and
data will be delivered with the lowest possible latency.
## Infrastructure
In the context of these docs, Infrastructure refers to the hardware running your Project, including the
[database](#multi-tenancy), [asset storage](#asset-storage) and [global CDN](#global-cdn). Infrastructure differs by
Project tier. Please refer to [Projects](/cloud/projects) as well as the Infrastructure section on the
[Pricing page](https://directus.io/pricing) for side-by-side comparisons.
## Rate Limiting
Rate limiting refers to technical limitations within Directus Cloud as well as Cloud Projects. You will encounter the
following API request limits:
| Tier | Limit |
| ---------- | ------------------------------ |
| Standard | 50 requests per second per IP |
| Enterprise | 100 requests per second per IP |
:::tip Learn More
For details on other limitations, please see [Cloud Policies](https://directus.io/cloud-policies/#).
:::
## Support Options
There are three types of support for Directus:
### Community Support
Because Directus is an open-source Project, you're encouraged to reach out to the Community for help on Projects, _and
of course help others as well_. Find us on [GitHub](https://github.com/directus/directus/discussions) and
[Discord](https://directus.chat) to join the thousands of other developers all discussing and guiding the future of the
Directus platform. Most common questions have already been asked and answered and can be easily searched.
:::warning No Guaranteed Response Time
While the Directus Core Team plays an active and engaged role in community discussions and aims to answer questions
within a few days, there is no guaranteed response time for Community Support.
:::
### Basic and Premium Support
Basic and Premium Support offer direct communication with the Directus Core Team. Basic support is included on all
Enterprise Projects, and Premium Support adds 24/7 response times for critical software issues only.
:::tip Add-on Support
Looking for Basic or Premium Support on a self-hosted Project? [Contact Sales](https://directus.io/contact).
:::
## System Status
<video alt="System Status" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/cloud/glossary/glossary-20220322A/system-status-20220329A.mp4" type="video/mp4">
</video>
Click <span mi icon>check</span> in the Dashboard Header to navigate to the System Status page. This page is where to
_find out what happened_ in the super rare event that the network slows down or goes offline. Here you can view the
current connectivity status of Directus Cloud, the status on individual Projects by URL and a daily Incidents log. For
more information, see [Cloud Policies](https://directus.io/cloud-policies#).
## Multi-tenancy
Tenancy refers to how client data is stored within a database. In single-tenancy architecture, a database stores data
from only one tenant. In multi-tenancy architecture, a database stores data from multiple tenants, with mechanisms in
place to protect data privacy. In the context of Directus Cloud, each Project represents a tenant.
**Standard**\
Standard Projects are created using a multi-tenant architecture. However, if your neighbor's Project gets busy, it will not
impact your Project, because each Standard Project is scoped to one container per Project with dedicated minimum resources.
Projects also have the ability to scale beyond this minimum allocation based on currently available resources within the
multitenant pool. However, these additional resources are not guaranteed and are offered on a dynamic first-come, first-serve
basis. For end-to-end, single-tenant infrastructure with fully dedicated resources, [contact us about our Enterprise Tier](https://directus.io/contact)
**Enterprise**\
Databases on Enterprise Projects are single-tenant, 100% dedicated to your Project - no neighbors! Ready to upgrade to Enterprise?
[Contact us](https://directus.io/contact)
:::tip
This section refers to how your Cloud Project is stored alongside other Cloud Projects and has nothing to do with how
you design your Project's data model. You can implement single or multi-tenant architecture within any Directus Cloud
Project.
:::

70
docs/user-guide/cloud/overview.md Normal file
View File

@@ -0,0 +1,70 @@
---
description:
Whether you're a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running
with Directus quickly.
readTime: 3 min read
---
# Overview
> Whether you're a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running
> with Directus quickly. We do all the heavy lifting of managing your infrastructure and software updates - and you also
> benefit from fair and predictable usage-based pricing.
![Hero Image](https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/hero-image-20220402A.webp)
[Directus Cloud](https://directus.cloud) is a hosting platform for [Directus Projects](/user-guide/cloud/glossary#projects) which
handles data storage, hosting, updates and scalability so you can focus on building your digital apps and experiences.
There are two [tiers of Cloud Projects](/user-guide/cloud/glossary#projects): Standard and Enterprise. Both tiers come with all the
great features of Directus Core.
The Cloud Dashboard is constructed to manage three key components: [Accounts](/user-guide/cloud/glossary#accounts),
[Teams](/user-guide/cloud/glossary#teams) and [Projects](/user-guide/cloud/glossary#projects). First, create an Account. Once logged in,
create or join a Team, and your Account will become a Member of that Team. Once that's complete, you can create Projects
within a Team.
Accounts can be Members on multiple Teams. All Team Members have SuperAdmin privileges to manage the Team's Projects,
Project [billing](/user-guide/cloud/teams#manage-billing), other Team Members and the Team itself. Teams can have multiple Team
Members and multiple Projects. Projects can only be managed by one Team and cannot be transferred to new Teams.
## Getting Started
To make life easy, you have the option to
[create and login to your free Cloud Account](/cloud/accounts#create-account-and-login) automatically with GitHub. If
you don't have a GitHub account or prefer not to use this login method, email-and-password login is available, as well.
Once logged in, create a new Team or select an existing Team. Then you can access and manage the Team's associated
Projects, billing details, Team Members, Activity and Settings.
<video alt="Cloud Dashboard Overview" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/cloud-dashboard-overview-20220329A.mp4" type="video/mp4">
</video>
Remember: The Dashboard layout itself is designed to manage [Accounts](/user-guide/cloud/glossary#accounts),
[Teams](/user-guide/cloud/glossary#teams) and [Projects](/user-guide/cloud/glossary#projects). Here's how the Dashboard layout relates to each
of these components:
## Accounts
### Cloud Dashboard Header
- <span mi icon>check</span> — View Directus Cloud [system status](/user-guide/cloud/glossary#system-status).
- <span mi icon>notifications</span> — Notifications such as version upgrades, platform upgrades, etc.
- <span mi icon>help_outline</span> — Documentation, Community Support and Request for Premium Support.
- <span mi icon>expand_more</span> — [Create new Teams](/user-guide/cloud/teams#create-a-team) and navigate between Teams you are
on.
- <span mi icon>account_circle</span> — [Access, edit or destroy Account](/cloud/accounts).
## Teams
- [Team Members](/user-guide/cloud/teams) — View, invite and remove other Team Members or leave a Team.
- [Team Activity](/user-guide/cloud/teams#view-team-activity) — View Team activity such as Project creation and deletion, billing
information changes, Member invitations and removals, etc.
- [Team Settings](/user-guide/cloud/teams#update-team-settings) — Edit the Team Name and Team Slug, as well as
[destroy a Team](/user-guide/cloud/teams#destroy-a-team).
## Projects
- [Team Projects](/user-guide/cloud/projects) — View and access all Projects managed within a Team. Click a Project to enter the
Product Details Page and access, monitor, edit or delete a Project.
- [Team Billing](/user-guide/cloud/teams#manage-billing) — View and manage billing details such as credit card information, usage,
subscriptions and receipts.

0
docs/app/project-settings.md → docs/user-guide/cloud/project-settings.md
View File

157
docs/user-guide/cloud/projects.md Normal file
View File

@@ -0,0 +1,157 @@
---
description: Cloud Projects are individual instances of Directus, managed within a Team.
readTime: 8 min read
---
# Cloud Projects
> Cloud Projects are individual instances of Directus, managed within a Team. Standard and Enterprise tier Projects are
> available, with each offering different options for infrastructure, configuration and professional services. A Cloud
> Project is a Directus Instance, the [Infrastructure](/user-guide/cloud/glossary#infrastructure) it runs on, and all of its
> [data and file assets](/user-guide/cloud/glossary#asset-storage). All Cloud Projects include all
> [Cloud Exclusives](/user-guide/cloud/glossary#cloud-exclusives). See [Support Options](/user-guide/cloud/glossary#support-options) to find
> out how to get help on your Project.
There are two different Project tiers on Directus Cloud: [Standard](#create-a-standard-project) and
[Enterprise](#create-an-enterprise-project). A side-by-side comparison of what's included in each tier can be found on
the [Pricing page](https://directus.io/pricing).
See the [Overview](/user-guide/cloud/overview) to learn how Accounts, Teams and Projects interrelate.
## View a Team's Projects
All of a Team's Projects are listed on the Projects Page. For each Project, the following information and shortcuts are
provided. On Project creation, the provisioning progress will be displayed until fully complete. The icon on the far
left indicates whether it's online or [offline](/user-guide/cloud/glossary#system-status). Next to that icon are the Project Name
and Project Slug. On the right, you'll see the Project tier, followed by shortcuts, which allow you to
<span mi icon>edit</span> update and <span mi icon>launch</span> access the Project. To view a Team's Projects:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Projects"**.
## Create a Standard Project
The Standard tier is perfect for most production-ready use cases. Standard tier Projects come with custom URLs, daily
[backups](/user-guide/cloud/glossary#backups) and the recommended infrastructure for most projects. as needed.
Standard Projects come with the following configuration options:
- **Project Name** — Custom. This can be changed at any time.
- **Project URL** — Custom URL: `your-custom-url.directus.app`. _This cannot be changed_.
- [Datacenter Region](/user-guide/cloud/glossary#datacenter-regions) — `United States, East`, `Europe, Frankfurt` or
`Asia Pacific, Singapore`.
To create a Standard Project:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Projects"**.
3. Click the Team you wish to create a Project under.
4. Click **"Create Project"**.
5. Set the Project Name as desired.
6. Select the Standard tier.
7. Set the configuration options as desired.
8. Click **"Proceed to Checkout"**. You will be taken to a checkout page.
9. Enter payment information and hit **"Subscribe"**.
:::tip Enterprise Tier
Need even more power, scale, customization and support?\
Upgrade to an [Enterprise Project](#create-an-enterprise-project).
:::
## Create an Enterprise Project
Enterprise tier offers power and scale to meet any Project's needs and offers 19
[Datacenter regions](/user-guide/cloud/glossary#datacenter-regions), upgraded [support options](/user-guide/cloud/glossary#support-options),
and much more.
:::tip Ready to go Enterprise?
[Contact Sales](https://directus.io/contact)
:::
## Access a Project
At some point, you will want to log in and access the actual managed Project. You can go the Project's URL directly, or
you can access it from within the Cloud Dashboard two different ways. To access a Project from the Cloud Dashboard:
1. Open the Team Menu in the Dashboard Header and click the desired Team.
2. Click **"Projects"** to enter the Projects page.\
From here, there are two ways to access a Project:
#### From the Projects Page
3. Click <span mi icon>launch</span> on the desired Project. Your Project login page will open in a new tab.
#### From Project Monitor Page
3. Click a Project to enter its Project Monitor page.
4. Click **"Open Project"**. Your Project login page will open in a new tab.
## Monitor a Project
<video alt="Project Monitor Page" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/cloud/glossary/glossary-20220322A/monitor-a-project-20220322A.mp4" type="video/mp4">
</video>
Graphs on the Project Monitor page display daily Project information over the last month.
- **Combined Node Usage**\
Total load placed on all Nodes. If CPU or memory are overloaded, the Nodes could crash! High usage is a sign that it's
time to scale up.
- **API Requests**\
Number of API requests. This provides basic insight into traffic cycles, including overall volatility.
- **API Bandwidth**\
The read/write bandwidth of all requests.
To access the Project Monitor Page:
1. Open the Team Menu in the Dashboard Header and click the desired Team.
2. Click **"Projects"** to enter the Projects page.
3. Click the Project to enter the Project Monitor page.
## Manage a Standard Project
On Standard Projects, it's possible to change the Project Name.
1. Open the Team Menu in the Dashboard Header and click the desired Team.
2. Click **"Projects"** to enter the Projects page.
3. Click the Project to enter the Project Monitor page.
4. Click **"Edit"** to enter the Project Details page.
5. Make changes as desired.
6. Click **"Update Project"**.
## Manage an Enterprise Project
Each Enterprise Project is customized, so it can't be managed from the Cloud Dashboard. The Project will be managed in
tandem with the Directus Core Team.
:::tip Ready to go Enterprise?
[Contact Sales](https://directus.io/contact)
:::
## Destroy a Project
Destroying a Directus Cloud Project completely removes all its data, assets, settings and users from the platform. To
destroy a Directus Cloud Project, follow these steps:
1. Open the Team Menu in the Dashboard Header and click the desired Team.
2. Click **"Projects"** to enter the Projects page.
3. Click the Project you wish to delete.
4. Click **"Edit"** to enter the Project Details page.
5. Scroll to the bottom of the page and toggle <span mi icon dngr>local_fire_department</span>.
6. Type in the Project Name.
7. Click **"Destroy Project"**.
:::tip
This action will break any external apps connecting to the Project's API or linking to Project files, and is permanent
and irreversible. **Directus Cloud is not responsible for data or files lost due to this action!**
:::

123
docs/user-guide/cloud/teams.md Normal file
View File

@@ -0,0 +1,123 @@
---
description:
A Team is an organizational system that groups Accounts together as Team Members and provides consolidated billing on
its nested Projects.
readTime: 10 min read
---
# Cloud Teams
> A Team is an organizational system that groups Accounts together as Team Members and provides consolidated billing on
> its nested Projects. Teams within the Cloud Dashboard allow individuals to separate or consolidate Projects and
> payment methods, as well as manage Projects independently or with other Team Members.
For example, a company can use Teams to organize Projects by department, each with consolidated billing and scoped
access. Similarly, agencies or freelancers with multiple customers can create a Team per client to limit their access
and isolate billing. Teams are free, so create as many as you need to appropriately organize Team Members, Projects and
payment methods.
## Create a Team
![Create Team](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/create-a-team-20220329A.webp)
To create a Team:
1. Open the Team Menu in the Dashboard Header and click **"Create a Team <span mi icon prmry>add</span>"**.\
The Create Team page will open.
2. Enter a Team Name and Team Slug, then click **"Save"**.
:::tip Team Name and Team Slug
The Team Name is a text name assigned to a Team, used in the Cloud Dashboard. The Team slug lies within the full URL
`https://directus.cloud/TEAM-SLUG/projects`. These are purely organizational, allowing you to easily remember the Team
and link to specific Cloud Dashboards. They do not impact Cloud Projects or billing and can be
[updated at any time](#update-team-settings).
:::
## Update Team Settings
![Managing a Team](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/managing-a-team-20220225A.webp)
To update Team Settings:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Settings"** to enter the Team Settings page.
3. Toggle <span mi icon prmry>edit</span> to allow edits.
4. Edit Team Name and Team Slug as desired.
5. Click the **"Save"** button.
## View Team Activity
![View Team Activity](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/view-team-activity-20220322A.webp)
The Team Activity Page displays billing information changes, created and destroyed Projects, Team Members added or
removed, Team Name and Team Slug changes, and any other major Team-oriented activities. To view Team Activity:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Activity"**.
## Invite Team Members
![Inviting a Team Member](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/inviting-a-team-member-20220225A.webp)
All Team Members can invite new Members via email. Each invitee will be emailed a link to accept the invitation and join
the Team. To invite Team Members:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Members"** to enter the Members Page.
3. Scroll down to the Invite New Members section.
4. Enter one or more email(s), comma separated.
5. Click **"Send Invites."**
:::tip
Clicking the emailed invitation link does not automatically create an Account for you. Invitees will need to
[create an Account](/user-guide/cloud/accounts#create-account-and-login) before accepting an invitation to join a Team.
:::
## Manage Team Members
![Removing a Team member](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/leaving-a-team-20220225A.webp)
All Team Members have the ability to remove other Members or invites from a Team. To remove Members or leave a Team
yourself:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Members"** to enter the Members Page.
3. Click the <span mi icon>exit_to_app</span> or <span mi icon>close</span> button on the desired Member.
4. Click **"Confirm"**.
:::warning
If an Account leaves or is removed from a Team, it will be fully "locked out" of the Team until re-invited by another
Member.
:::
## Destroy a Team
![Destroying a Team](https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/destroy-a-team-20220225A.webp)
To destroy a Team:
1. Open the Team Menu in the Dashboard Header and select the desired Team.
2. Click **"Settings"** to enter the Team Settings Page.
3. Scroll down to the "Destroy this Team" section.
4. Toggle <span mi icon dngr>local_fire_department</span> and an input box will appear.
5. Type the Team Name into the input box.
6. Click **"Destroy Team"**.
:::danger
Destroying a Team completely removes all its data from Directus Cloud. This action is permanent and irreversible.
Proceed with caution!
:::
:::tip Teams with Active Projects
To delete a Team, you must first delete any active Projects within it.
:::

0
docs/app/content.md → docs/user-guide/content-module/content.md
View File

0
docs/app/content/collections.md → docs/user-guide/content-module/content/collections.md
View File

0
docs/app/content/items.md → docs/user-guide/content-module/content/items.md
View File

0
docs/app/content/shares.md → docs/user-guide/content-module/content/shares.md
View File

0
docs/app/display-templates.md → docs/user-guide/content-module/display-templates.md
View File

0
docs/app/filters.md → docs/user-guide/content-module/filters.md
View File

0
docs/app/import-export.md → docs/user-guide/content-module/import-export.md
View File

0
docs/app/layouts.md → docs/user-guide/content-module/layouts.md
View File

0
docs/app/translation-strings.md → docs/user-guide/content-module/translation-strings.md
View File

62
docs/app/file-library.md → docs/user-guide/file-library/files.md
View File

@@ -149,65 +149,3 @@ When a file is replaced, its existing info and all relationships are kept.
- Click the popup area to manually select a file from your device.
- Click <span mi icon>more_vert</span> in the popover and choose **"Import from URL"**.
## Folders
Folders provide the organization system for Files.
![Folders](https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp)
They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from
the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables
all other features and functionalities from the [Collections Page](/app/content/collections) such as batch editing,
batch deleting, sorting, filtering, searching, etc. Folders can also be managed
[programmatically via the API](/reference/system/folders).
## Create a Folder
<video alt="Create a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4" type="video/mp4">
</video>
1. From the **File Library**, click on the <span mi btn sec>create_new_folder</span> button located in the Header.
2. Fill in a Folder name as desired.
3. Click **"Save"**.
## Rename a Folder
<video alt="Renaming a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the Folder you wish to rename and select "Rename Folder".
2. Update the Folder name as desired.
3. Click **"Save"**.
## Move a Folder
<video alt="Moving a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the folder you wish to move and select **"Move to Folder"**. A popup will
appear.
2. Select a Folder to serve as the new Parent Folder.
3. Click **"Save"**.
## Delete a Folder
<video alt="Deleting a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the Folder you wish to delete and select **"Delete Folder"**.
2. Click **"Delete"**.
::: tip
When you delete a Folder, any nested Files and Folders will be moved one level up.
:::
## More Help
Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing
[Community on Discord](https://discord.com/invite/directus)

67
docs/user-guide/file-library/folders.md Normal file
View File

@@ -0,0 +1,67 @@
---
description: Folders provide the organization system for Files.
readTime: 1 min read
---
# Folders
> Folders provide the organization system for Files.
![Folders](https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp)
They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from
the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables
all other features and functionalities from the [Collections Page](/app/content/collections) such as batch editing,
batch deleting, sorting, filtering, searching, etc. Folders can also be managed
[programmatically via the API](/reference/system/folders).
## Create a Folder
<video alt="Create a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4" type="video/mp4">
</video>
1. From the **File Library**, click on the <span mi btn sec>create_new_folder</span> button located in the Header.
2. Fill in a Folder name as desired.
3. Click **"Save"**.
## Rename a Folder
<video alt="Renaming a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the Folder you wish to rename and select "Rename Folder".
2. Update the Folder name as desired.
3. Click **"Save"**.
## Move a Folder
<video alt="Moving a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the folder you wish to move and select **"Move to Folder"**. A popup will
appear.
2. Select a Folder to serve as the new Parent Folder.
3. Click **"Save"**.
## Delete a Folder
<video alt="Deleting a Folder" loop muted controls autoplay playsinline>
<source src="https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4" type="video/mp4">
</video>
1. From the **File Library**, right-click on the Folder you wish to delete and select **"Delete Folder"**.
2. Click **"Delete"**.
::: tip
When you delete a Folder, any nested Files and Folders will be moved one level up.
:::
## More Help
Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing
[Community on Discord](https://discord.com/invite/directus)

15
docs/user-guide/index.md Normal file
View File

@@ -0,0 +1,15 @@
---
description: Learn the terms and concepts you need to know about Headless CMS.
tags: []
skill_level:
directus_version:
author_override:
author: Esther Agbaje
---
# Headless CMS Concepts
> {{ $frontmatter.description }}
If you’re new to using a Headless CMS, it can be hard to wrap your head around the terminology at first. Here’s some
helpful definitions of terms you’ll likely see again.

88
docs/user-guide/insights/charts.md Normal file
View File

@@ -0,0 +1,88 @@
---
description: Insights is a Module in Directus that allows rapid, no-code build-out of analytics dashboards.
readTime: 9 min read
---
# Charts
> Insights is a Module in Directus that allows rapid, no-code build-out of analytics dashboards. Regardless of your
> use-case _(be it business intelligence, user progress tracking, web traffic conversions, or whatever!)_ you will be
> able to setup key data metrics in just a few clicks.
<video autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/insights-dashboards-20220216A.mp4" type="video/mp4" />
</video>
## Bar Chart
![Dashboard edit page with a bar chart options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-bar-options-230223A.webp)
The Bar Chart Panel allows you to build vertical and horizontal bar charts from data held in collections.
- **Collection** – Selects the Collection you want to analyze.
- **Horizontal** - If enabled, the bars will be horizontal (originating from the y-axis).
- **X-Axis** - The Field presented on the x-axis.
- **Y-Axis** - The Field presented on the y-axis.
- **Value Decimals** – Changes the number of decimals displayed on both axes.
- **Color** – Sets the default color of your bars.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Conditional Styles** – Changes color of bar if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Line Chart
![Dashboard edit page with a line chart options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-line-options-230223A.webp)
The Line Chart Panel allows you to build line charts from data held in collections, and are often used for time-series
data.
- **Collection** – Selects the Collection you want to analyze.
- **X-Axis** - The Field presented on the x-axis.
- **Y-Axis** - The Field presented on the y-axis.
- **Group Aggregation** – Selects the type of aggregation to perform. If you may only select a Field to be presented on
the x-axis. [Learn more](#more-on-aggregate-functions).
- **Function** – Selects the type of aggregate to perform.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Value Decimals** – Changes the number of decimals displayed on both axes.
- **Color** – Sets the default color of your line.
- **Show Axis Labels** - Selects if and on which axis labels are shown.
- **Show Tooltip Marker** - If enabled, shows data when a data point is hovered over.
- **Curve Type** - Selects the style of the curve - smooth, straight, or stepped.
- **Conditional Styles** – Changes color of line if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Meter
![Dashboard edit page with a meter options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-meter-options-230223A.webp)
The Meter Panel takes a maximum value and allows you to show a completion percentage given a second value.
- **Collection** – Selects the Collection you want to analyze.
- **Field** – Selects the Field to run aggregate function on.
- **Function** – Selects the type of aggregate to perform.
- **Maximum** - Sets the maximum value (100% of the meter).
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Size** - Sets dial to be a full circle or a half circle.
- **Stroke Width** - Sets thickness of the meter dial line.
- **Color** – Sets the default color of your dial.
- **Rounded Stroke** - If enabled, changes the cap style to rounded.
- **Conditional Styles** – Changes color of meter if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Pie or Donut Chart
![Dashboard edit page with a pie or donut options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-pie-donut-options-230223A.webp)
The Pie and Donut Charts allow you to create segmented charts based on your data.
- **Collection** – Selects the Collection you want to analyze.
- **Field** – Selects the Field to run aggregate function on.
- **Function** – Selects the type of aggregate to perform.
- **Donut** - If enabled, a circle is cut out of the center of the chart.
- **Show Labels** - If enabled, the percentage value is shown in each segment.
- **Show Legend** - Selects if and where the legend is shown - none, right, or bottom.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Value Decimals** – Changes the number of decimals displayed in the chart segments.
- **Color** – Sets the default base color of your first segment. Other segments will be variations of this default.
- **Conditional Styles** – Changes color of segment if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.

55
docs/user-guide/insights/dashboards.md Normal file
View File

@@ -0,0 +1,55 @@
---
description: Insights is a Module in Directus that allows rapid, no-code build-out of analytics dashboards.
readTime: 9 min read
---
# Dashboards
> Insights is a Module in Directus that allows rapid, no-code build-out of analytics dashboards. Regardless of your
> use-case _(be it business intelligence, user progress tracking, web traffic conversions, or whatever!)_ you will be
> able to setup key data metrics in just a few clicks.
<video autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/insights-dashboards-20220216A.mp4" type="video/mp4" />
</video>
## How it Works
<video autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/insights-how-it-works-20220216A_1.mp4" type="video/mp4" />
</video>
First, create a Dashboard, then fill the Dashboard with Panels.
1. Click the "Create Dashboard" action button <span mi btn >add</span> in the page header.
2. Fill in the dashboard name, icon and note.
3. Click "Save".
4. Click the edit icon in the page header.
5. Hit the "Create Panel" <span mi btn >add</span> in the page header.
6. Select a Panel type. [Learn More about panel types](#panels-overview).
7. Adjust the Panel Options to customize the analytics metric.
8. Click <span mi btn>check</span> in the drawer header to create the panel.
9. Click <span mi btn>check</span> in the page header to confirm all edits.
## Dashboards Overview
![Dashboard Grid Area](https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/dashboards-overview-20220216A.webp)
Each Directus Dashboard provides a drag-and-drop canvas where you can create and arrange different Panels to easily
build out customized analytics. The Dashboard area automatically expands as you add more and more Panels. In theory, a
Dashboard area can expand infinitely large... but in practice, users will probably only want to build Dashboards as
large as the screen they will be viewing on. You are able to create as many Dashboards as you need. Additionally, the
Dashboard view, edit, and create permissions are [fully configurable](/app/users-roles-permissions) by User Role.
:::tip Auto Refresh
The Auto Refresh menu in the [Sidebar](/app/overview#_4-sidebar) lets you select an interval to refresh dashboard data.
:::
## Create, Edit, and Delete Dashboards
![How to Add, Edit and Delete Dashboards in Directus Insights](https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/create-edit-delete-dashboards-20220216A.webp)
1. Click the <span mi btn >add</span> icon in the page header to create a new Dashboard.
2. Click the item option to edit or delete a Dashboard.

117
docs/app/insights.md → docs/user-guide/insights/panels.md
View File

@@ -3,7 +3,7 @@ description: Insights is a Module in Directus that allows rapid, no-code build-o
readTime: 9 min read
---
# Insights
# Panels
> Insights is a Module in Directus that allows rapid, no-code build-out of analytics dashboards. Regardless of your
> use-case _(be it business intelligence, user progress tracking, web traffic conversions, or whatever!)_ you will be
@@ -13,47 +13,6 @@ readTime: 9 min read
<source src="https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/insights-dashboards-20220216A.mp4" type="video/mp4" />
</video>
## How it Works
<video autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/insights-how-it-works-20220216A_1.mp4" type="video/mp4" />
</video>
First, create a Dashboard, then fill the Dashboard with Panels.
1. Click the "Create Dashboard" action button <span mi btn >add</span> in the page header.
2. Fill in the dashboard name, icon and note.
3. Click "Save".
4. Click the edit icon in the page header.
5. Hit the "Create Panel" <span mi btn >add</span> in the page header.
6. Select a Panel type. [Learn More about panel types](#panels-overview).
7. Adjust the Panel Options to customize the analytics metric.
8. Click <span mi btn>check</span> in the drawer header to create the panel.
9. Click <span mi btn>check</span> in the page header to confirm all edits.
## Dashboards Overview
![Dashboard Grid Area](https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/dashboards-overview-20220216A.webp)
Each Directus Dashboard provides a drag-and-drop canvas where you can create and arrange different Panels to easily
build out customized analytics. The Dashboard area automatically expands as you add more and more Panels. In theory, a
Dashboard area can expand infinitely large... but in practice, users will probably only want to build Dashboards as
large as the screen they will be viewing on. You are able to create as many Dashboards as you need. Additionally, the
Dashboard view, edit, and create permissions are [fully configurable](/app/users-roles-permissions) by User Role.
:::tip Auto Refresh
The Auto Refresh menu in the [Sidebar](/app/overview#_4-sidebar) lets you select an interval to refresh dashboard data.
:::
## Create, Edit, and Delete Dashboards
![How to Add, Edit and Delete Dashboards in Directus Insights](https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/create-edit-delete-dashboards-20220216A.webp)
1. Click the <span mi btn >add</span> icon in the page header to create a new Dashboard.
2. Click the item option to edit or delete a Dashboard.
## Panels Overview
![Directus Dashboard Panels](https://cdn.directus.io/docs/v9/app-guide/insights/insights-20220216A/panels-overview-20220216A.webp)
@@ -256,77 +215,3 @@ Your variable's data type will need to be a valid match to wherever you are usin
or JSON variable in a place that requires Datetime data.
:::
## Bar Chart
![Dashboard edit page with a bar chart options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-bar-options-230223A.webp)
The Bar Chart Panel allows you to build vertical and horizontal bar charts from data held in collections.
- **Collection** – Selects the Collection you want to analyze.
- **Horizontal** - If enabled, the bars will be horizontal (originating from the y-axis).
- **X-Axis** - The Field presented on the x-axis.
- **Y-Axis** - The Field presented on the y-axis.
- **Value Decimals** – Changes the number of decimals displayed on both axes.
- **Color** – Sets the default color of your bars.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Conditional Styles** – Changes color of bar if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Line Chart
![Dashboard edit page with a line chart options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-line-options-230223A.webp)
The Line Chart Panel allows you to build line charts from data held in collections, and are often used for time-series
data.
- **Collection** – Selects the Collection you want to analyze.
- **X-Axis** - The Field presented on the x-axis.
- **Y-Axis** - The Field presented on the y-axis.
- **Group Aggregation** – Selects the type of aggregation to perform. If you may only select a Field to be presented on
the x-axis. [Learn more](#more-on-aggregate-functions).
- **Function** – Selects the type of aggregate to perform.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Value Decimals** – Changes the number of decimals displayed on both axes.
- **Color** – Sets the default color of your line.
- **Show Axis Labels** - Selects if and on which axis labels are shown.
- **Show Tooltip Marker** - If enabled, shows data when a data point is hovered over.
- **Curve Type** - Selects the style of the curve - smooth, straight, or stepped.
- **Conditional Styles** – Changes color of line if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Meter
![Dashboard edit page with a meter options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-meter-options-230223A.webp)
The Meter Panel takes a maximum value and allows you to show a completion percentage given a second value.
- **Collection** – Selects the Collection you want to analyze.
- **Field** – Selects the Field to run aggregate function on.
- **Function** – Selects the type of aggregate to perform.
- **Maximum** - Sets the maximum value (100% of the meter).
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Size** - Sets dial to be a full circle or a half circle.
- **Stroke Width** - Sets thickness of the meter dial line.
- **Color** – Sets the default color of your dial.
- **Rounded Stroke** - If enabled, changes the cap style to rounded.
- **Conditional Styles** – Changes color of meter if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.
## Pie or Donut Chart
![Dashboard edit page with a pie or donut options panel visible.](https://cdn.directus.io/docs/v9/app-guide/insights/20220223/panels-pie-donut-options-230223A.webp)
The Pie and Donut Charts allow you to create segmented charts based on your data.
- **Collection** – Selects the Collection you want to analyze.
- **Field** – Selects the Field to run aggregate function on.
- **Function** – Selects the type of aggregate to perform.
- **Donut** - If enabled, a circle is cut out of the center of the chart.
- **Show Labels** - If enabled, the percentage value is shown in each segment.
- **Show Legend** - Selects if and where the legend is shown - none, right, or bottom.
- **Filter** – Allows filtering of Items considered for analysis based on logical conditions.
- **Value Decimals** – Changes the number of decimals displayed in the chart segments.
- **Color** – Sets the default base color of your first segment. Other segments will be variations of this default.
- **Conditional Styles** – Changes color of segment if its value is `>`, `>=`, `<`, `<=`, `==`, or `!=` to some defined
value.

66
docs/user-guide/overview/data-studio-app.md Normal file
View File

@@ -0,0 +1,66 @@
---
description: An introduction to the Directus studio app and it's components.
readTime: 3 min read
---
# Data Studio App
> The App is a no-code presentation layer for your data, content, and assets. It uses an intuitive left-to-right visual
> hierarchy for general organization and navigation.
The Directus Studio App provides users with a user-friendly and intuitive interface that allows for the seamless
creation and management of collections, definition of relationships, and control over access permissions.
The App also enables users to create flows and dashboards for internal applications.
<img src="https://cdn.directus.io/docs/v9/app-guide/overview/app-overview-20220810A.svg" alt="Directus Application Overview" class="no-shadow" />
## 1. Module Bar
The leftmost section of the App is the module bar, which includes the:
- **Project Logo** — Displays your configured project logo and project color (defaults to the Directus logo and color).
If configured, clicking this component will navigate to the Project URL. During platform activity, an indeterminate
progress indicator will also be shown here.
- **Module Navigation** — Allows navigating between the different modules your user has access to. Customizing the
Module Navigation is done within the [Project Settings](/app/settings), but the default module list includes:
- [Content](/app/content/collections) — The primary way to view and interact with database content
- [User Directory](/app/user-directory) — A dedicated section for the platform's system Users
- [File Library](/app/file-library) — An aggregate of all files uploaded and managed within the platform
- [Insights](/app/insights) — Access to infinitely customizable data dashboards
- [App Guide](/app/overview) — A tailored, in-app portal for the platform's concepts, guides, and reference
- [Settings](/app/settings) — An admin-only section for configuring the project and system settings
- **Notifications** - Opens a drawer of notifications, such as from [mentions](/app/content/items#mentions).
- **Current User Menu** — This component displays the authenticated user's name and avatar.
- Sign Out — Hovering over the User Menu exposes the button to log out of the platform.
## 2. Navigation Bar
The navigation bar is based on the current module, and includes:
- **Project Name** — Shows an icon and tooltip indicating the API's connection strength, and the name of your current
project, which can be configured under [Project Settings](/app/settings).
- **Navigation** — This is a dynamic navigation based on your current module. Some modules also support
[Bookmark Presets](/getting-started/glossary#presets), which are a customizable links to specific data-sets.
## 3. Page
This is where the current page's content is shown, including:
- **Header** — A fixed section at the top of each page, the header includes:
- Page Icon — Clicking this navigates back to the previous page.
- Module Name — Clicking this navigates to the parent module/section.
- Page Title — Displays dynamic title of the current page.
- Action Buttons — Right-aligned contextual buttons for specific page actions.
- **Page Content** — This displays the content of the page you navigated to.
## 4. Sidebar
The sidebar provides additional context and options for the current page, including:
- **Page Components** — Lists any contextual page components available. The "Info" component is available on every page,
explaining the page's general purpose and relevant details. Clicking any sidebar component will accordion it open. If
the App window is large enough, the sidebar will automatically open, and can be closed by clicking the "X" in the
top-right.
- **Notifications Tray** — Fixed to the bottom of the page sidebar, this button opens a tray of recent user
notifications, and provides a link to your Activity Log page.

0
docs/getting-started/glossary.md → docs/user-guide/overview/glossary.md
View File

105
docs/user-guide/overview/quickstart.md Normal file
View File

@@ -0,0 +1,105 @@
---
description:
Get up and running with Directus Cloud in minutes. Learn the basics of building your data model and managing
permissions.
readTime: 7 min read
---
# Quickstart Guide
> This quickstart guide is designed to get you up and running with a Directus Cloud Project in a snap. Along the way,
> you will better understand what Directus is, setup your free Directus Cloud Account, get a _hands-on introduction_ to
> the App and API, and find more resources to deep-dive into.
## 1. Create Cloud Account and Login
First, you'll need to create an Account and log in on [Directus Cloud](https://directus.cloud/login).
Your Directus Cloud Account allows you to create and manage any number of Projects. We've made life easier by giving you
the option to create and log in to your free Cloud Account automatically with GitHub. If you don't have a GitHub account
or prefer not to use this login method, email-and-password login is available as well.
The very first time you log in to your Cloud Account, you will be prompted to create a Team. Teams are totally free to
create. Each Directus Cloud Project exists within the scope of one Team. They allow you to organize Team Members,
Projects and Project Billing as desired.
Once your Team is created, it's time to create your Directus Cloud Project!
## 2. Create and Access Project
To create a Project, follow the steps below:
1. Open the Team Menu in the Dashboard Header and select or create the desired Team.
2. Navigate to **"Projects"** and click **"Create Project"**.
3. Set the Project Name and tier.
4. Scroll to the bottom of the screen and choose the **"Empty Project"** Starting Template.\
Note: The **"Demo Project"** adds in dummy data for in-depth feature demonstrations.
5. Click **"Create Project"**.
_It should take around 90 seconds for the Cloud Project to build out. During this time, a link will be sent to the email
associated with your Cloud Account. The email will contain your Project URL as well as an email and password to login.
If you used GitHub to create your account, this will be your GitHub email. Once the build is complete, it's time log
in!_
7. You can access a Project from within the Cloud Dashboard or type the URL into your browser.
8. Log in with your username and password from the email.
:::tip Check All Inbox Folders
Due to the algorithms used by some email providers, it is possible the email containing your Project login information
will end up in another folder like "Social" or "Promotions".
:::
## 3. Create a Collection
Once logged in, you're greeted with the option to create your first [Collection](/getting-started/glossary#collections).
1. Navigate into the Content Module.
2. Click **"Create Collection"** and a side menu will appear.
3. Fill in a **Name**.\
For the sake of this demo, we'll call ours `articles`, but feel free to make it your own!
4. Leave the other options at default. Click <span mi btn>arrow_forward</span> and the **"Optional System Fields"** menu
will open.\
Keep the values in this menu at the default, toggled off, for now. You can adjust them later.
5. Click <span mi btn>check</span> in the menu header.
:::tip Learn More About Collections
- [The Content Module](/app/content)
- [Create and Manage a Collection](/app/data-model/collections)
- [Build Relationships Between Collections](/app/data-model/relationships)
:::
## 4. Create a Field
With your first Collection created, it's time to start adding some [Fields](/getting-started/glossary#fields).
1. Navigate to **Settings Module > Data Model > `Collection-Name`**.
2. Click the **"Create Field"** button and select the **"Input"** Field type.
3. Fill in a Field name under **Key**. We'll be calling our Field `title`.\
Directus offers powerful Field customization options, but let's stick to the defaults for now.
4. Select **"Save"**.
::: tip Learn More About Fields
- [Create and Manage Fields in the App](/app/data-model)
:::
## 5. Create an Item
Now that we have a Collection with a Field configured, it's time to add an [Item](/getting-started/glossary#).
1. Navigate to the Content Module.
2. Click <span mi btn>add</span> in the page header to open the Item Page.
3. Fill in the Field Value(s) as desired.
4. Click <span mi btn>check</span> in the top-right to save your Item.
:::tip Learn More About Items
- [The Content Module](/app/content)
- [The Item Page](/app/content/items)
:::

0
docs/app/activity-log.md → docs/user-guide/settings/activity-log.md
View File

97
docs/user-guide/settings/presets-bookmarks.md Normal file
View File

@@ -0,0 +1,97 @@
---
description:
Presets store the state of a Collection Page. They can be used to set layout defaults or define bookmarks to specific
datasets.
readTime: 3 min read
---
# Presets
> Presets are items which store the state of a Collection Page. This allows you to set layout defaults or define
> bookmarks to specific datasets.
:::tip Before You Begin
We recommend you read through the [Quickstart Guide](/getting-started/quickstart) to get an overview of the platform
first, then see our guide on the [Collection Page](/app/content/collections) so you're familiar with its features and
functionalities.
:::
:::tip Learn More
To manage Presets and Bookmarks programmatically, see our [API guide on Presets](/reference/system/presets).
:::
Remember, a [Collection Page](/app/content/collections) enables you to customize how its items are presented. That is,
it lets you sort, search, or filter items and even change [Layouts](/app/layouts). In some cases, you may need to apply
the same display adjustments again and again. Presets save these adjustments, like a snapshot. You can create presets
for all project collections, as well as `directus_activity`, `directus_files` and `directus_users`.
Admins can access and manage all presets under **Settings > Presets and Bookmarks**.
## Create a Preset
<video title="Create a Preset" autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/configuration/presets-bookmarks/presets-bookmarks-20220819/create-a-preset-20220819B.mp4" type="video/mp4" />
</video>
There are two types or presets, Defaults and Bookmarks.
A _Default_ determines how a user will initially view a Collection Page. When a user makes adjustments to a given
Collection Page, these are automatically saved as the Default, so the adjustments remain even if the user navigates away
and then returns.
A _Bookmark_ creates another custom display of the Collection Page, which can be accessed any time on the
[Navigation Bar](/app/overview#_2-navigation-bar). Users can also
[create a Bookmark](/app/content/collections#create-a-bookmark) for personal use from within the Content Module.
The method to create a preset shown here is for Admin use only. For Administrators, the process to create either a
Default or a Bookmark is almost exactly the same. The key difference is that if you set a value for **Name**, the preset
becomes a Bookmark. If **Name** is left blank, the preset will be a Default. To create a preset, follow these steps.
1. Navigate to **Settings > Presets & Bookmarks**.
2. Click <span mi btn>add</span> in the header.
3. Configure your preset item's values as desired:
- **Collection** — Sets the collection this preset will apply to. Notice the layout preview below, which populates
with live data from the selected collection.
- **Scope** — Defines which users have access to this preset.
- **Layout** — Selects a Layout for the preset, which is adjusted from the Sidebar.
- **Name** — Sets a name, which determines if the preset is a Default or Bookmark. Note that this field supports
[Translation Strings](/app/translation-strings).
4. Scroll down to the **Layout Preview** section and make any other adjustments or configurations as desired. Each
preset saves all of the information needed to recreate this Layout Preview, just as it is shown.
5. Click <span mi btn>check</span> to confirm.
:::tip Preset Priority
Multiple Defaults can be created for the same Collection Page for the same user. When this happens, the preset priority
is: User, then Role, then Global.
:::
## Edit a Preset
<video title="Edit a Preset" autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/configuration/presets-bookmarks/presets-bookmarks-20220819/edit-a-preset-20220819A.mp4" type="video/mp4" />
</video>
1. Navigate to **Settings > Presets & Bookmarks > [preset]**.
2. Reconfigure your preset as desired.
3. Click <span mi btn>check</span> to confirm.
## Delete a Preset
<video title="Delete a Preset" autoplay playsinline muted loop controls>
<source src="https://cdn.directus.io/docs/v9/configuration/presets-bookmarks/presets-bookmarks-20220819/delete-a-preset-20220819A.mp4" type="video/mp4" />
</video>
1. Navigate to **Settings > Presets & Bookmarks > [preset]**.
2. Click <span mi btn dngr>delete</span> in the page header and a popup will appear. Click **Confirm**.
::: danger Irreversible Change
This action is permanent and cannot be undone. Please proceed with caution.
:::

0
docs/app/settings.md → docs/user-guide/settings/settings.md
View File

0
docs/app/users-roles-permissions/permissions.md → docs/user-guide/user-management/permissions.md
View File

0
docs/app/users-roles-permissions/roles.md → docs/user-guide/user-management/roles.md
View File

0
docs/app/user-directory.md → docs/user-guide/user-management/user-directory.md
View File

0
docs/app/users-roles-permissions.md → docs/user-guide/user-management/users-roles-permissions.md
View File

0
docs/app/users-roles-permissions/users.md → docs/user-guide/user-management/users.md
View File