Fixes for docs links

This commit is contained in:
Ben Haynes
2021-10-29 12:32:02 -04:00
parent f3c47ebf5d
commit 6ec467e1dc
31 changed files with 134 additions and 125 deletions

View File

@@ -79,6 +79,48 @@ module.exports = {
type: 'page',
path: '/getting-started/installation',
title: 'Installation',
children: [
{
type: 'page',
path: '/getting-started/installation/aws',
title: 'AWS',
},
{
type: 'page',
path: '/getting-started/installation/cli',
title: 'CLI',
},
{
type: 'page',
path: '/getting-started/installation/digitalocean-app-platform',
title: 'DigitalOcean',
},
{
type: 'page',
path: '/getting-started/installation/docker',
title: 'Docker',
},
{
type: 'page',
path: '/getting-started/installation/iis',
title: 'IIS',
},
{
type: 'page',
path: '/getting-started/installation/manual',
title: 'Manual',
},
{
type: 'page',
path: '/getting-started/installation/plesk',
title: 'Plesk',
},
{
type: 'page',
path: '/getting-started/installation/ubuntu',
title: 'Ubuntu',
},
],
},
{
type: 'page',
@@ -145,58 +187,11 @@ module.exports = {
{
title: 'Configuration',
children: [
{
type: 'page',
path: '/configuration/overview',
title: 'Overview',
},
{
type: 'page',
path: '/configuration/installation',
title: 'Installation',
children: [
{
type: 'page',
path: '/configuration/installation/aws',
title: 'AWS',
},
{
type: 'page',
path: '/configuration/installation/cli',
title: 'CLI',
},
{
type: 'page',
path: '/configuration/installation/digitalocean-app-platform',
title: 'DigitalOcean',
},
{
type: 'page',
path: '/configuration/installation/docker',
title: 'Docker',
},
{
type: 'page',
path: '/configuration/installation/iis',
title: 'IIS',
},
{
type: 'page',
path: '/configuration/installation/manual',
title: 'Manual',
},
{
type: 'page',
path: '/configuration/installation/plesk',
title: 'Plesk',
},
{
type: 'page',
path: '/configuration/installation/ubuntu',
title: 'Ubuntu',
},
],
},
// {
// type: 'page',
// path: '/configuration/overview',
// title: 'Overview',
// },
{
type: 'page',
path: '/configuration/config-options',
@@ -441,8 +436,8 @@ module.exports = {
},
{
type: 'page',
path: '/extensions/panes',
title: 'Panes',
path: '/extensions/panels',
title: 'Panels',
},
{
type: 'page',

View File

@@ -407,7 +407,7 @@
<li><a href="/configuration/config-options/">Environment Variables</a></li>
<li><a href="/configuration/relationships/">Data Relationships</a></li>
<li><a href="/configuration/config-options/#authentication">Single Sign-On (SSO)</a></li>
<li><a href="/configuration/installation/docker/">Installing with Docker</a></li>
<li><a href="/getting-started/installation/docker/">Installing with Docker</a></li>
</ul>
</div>

View File

@@ -22,7 +22,7 @@ If the Collection is configured as a "Singleton" in the data model settings, the
## Manually Sorting Items
1. Navigate to the [Collections Module](/concepts/application/#collections)
1. Navigate to the [Content Module](/app/overview/#_1-module-bar)
2. Navigate to the collection of the items you want to sort
3. Choose a layout that supports manual sorting (eg: the default "table" mode)
4. Enable manual sorting. (eg: for the table layout, click on the Sort column's header)
@@ -39,7 +39,7 @@ This feature is only available if a Sort column has been configured in the Colle
## Ordering Items
1. Navigate to the [Collections Module](/concepts/application/#collections)
1. Navigate to the [Content Module](/app/overview/#_1-module-bar)
2. Navigate to a collection of items
3. Choose a layout that supports manual ordering (eg: the default "table" mode)
4. Set the Order Field and Order Direction

View File

@@ -13,9 +13,8 @@ The leftmost section of the App is the module bar, which includes the:
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
[Role's configuration](/configuration/users-roles-permissions/#configuring-a-role), but the default module list
includes:
Module Navigation is done within the [Project Settings](/configuration/project-settings/#module-bar), 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

View File

@@ -19,9 +19,10 @@ profile page.
## Editing a User
You can access your profile page from the User Directory or by clicking the [User Menu](#) in the Module Bar. The
profile page has the same features and functionality as the [Item Page](/app/content/item). Administrators can customize
the fields on this page, but the following are available by default.
You can access your profile page from the User Directory or by clicking the User Menu in the
[Module Bar](/app/overview/#_1-module-bar). The profile page has the same features and functionality as the
[Item Page](/app/content/item). Administrators can customize the fields on this page, but the following are available by
default.
- **First Name** — The given name
- **Last Name** — The family/surname

View File

@@ -174,9 +174,11 @@ This pane controls the technical details of the field's database column.
- **Key** — (Required) The database column name and field's API key. The key must be unique within its parent
Collection. As of now, all keys are sanitized: lowercased, alphanumeric, and with spaces removed. Keys can not be
changed once created, however you can use [Field Name Translations](/dead) to override how it's displayed in the App.
- **Type** — (Required) How the data is saved to the database; See [Directus Data Type Superset](/concepts/types). This
dropdown maybe be limited or even disabled based on your chosen Field category.
changed once created, however you can use [Field Name Translations](/configuration/data-model/#field) to override how
it's displayed in the App.
- **Type** — (Required) How the data is saved to the database; See
[Directus Data Type Superset](/getting-started/glossary/#data-type-superset). This dropdown maybe be limited or even
disabled based on your chosen Field category.
- **Length** — (Only for certain types) For String types this determines the number of characters that can be stored in
the database. For Float and Decimal types, this control becomes **Precision & Scale**.
- **On Create** — (Only for certain types) For some data types, this option allows you to control what value is saved
@@ -272,8 +274,7 @@ The conditions are matched in order. The **last** condition that matches is the
::: tip System Fields
While all out-of-the-box system fields are locked from editing or deleting, you are able to create new fields within the
system collections. To get started, enable System Collections within the sidebar filter of
[Settings > Data Model](/concepts/databases/).
system collections. To get started, expand System Collections from the bottom of **Settings > Data Model**.
:::

View File

@@ -1,3 +0,0 @@
# Installation
> TK

View File

@@ -35,7 +35,7 @@ Each preset saves all of the information needed to recreate a view of the collec
It's important to be aware of the difference between a collection's _defaults_ and its _bookmarks_, both of which are
configured by presets. A _default_ is how a user will initially view the collection detail without any further
customization, while a _bookmark_ is a named dataset that can be recalled at any point via the
[collection navigation](/guides/roles/#customizing-the-collection-navigation).
[navigation bar](/app/overview/#_2-navigation-bar).
:::

View File

@@ -13,12 +13,13 @@ few basics that will help you better visualize them in your mind's eye.
### Primary and Foreign Keys
Every [Item](/getting-started/glossary/#items) in a relational database has a unique "key" that identifies it within its
[Collection](/app/content-collections/). Because it's required, the key is the first [field](/concepts/fields/) created
within a collection, typically storing an "auto-increment" number, an automatically generated unique hash, or a manually
entered value. They are often abbreviated to "PK" (Primary Key), "ID" (Identifier), "UID" (Unique Identifier), or "UUID"
(Universally Unique Identifier), depending on the type of value they store. After it's created, the value of an item's
PK should _never_ change.
Every [Item](/getting-started/glossary/#items) in a relational database has a unique
[Primary Key](/getting-started/glossary/#primary-key-pk) (or "PK") that identifies it within its
[Collection](/getting-started/glossary/#collections). Because it's required, the key is the first
[field](/getting-started/glossary/#fields) created within a collection, typically storing an "auto-increment" number, an
automatically generated unique hash, or a manually entered value. They are often abbreviated to "PK" (Primary Key), "ID"
(Identifier), "UID" (Unique Identifier), or "UUID" (Universally Unique Identifier), depending on the type of value they
store. After it's created, the value of an item's PK should _never_ change.
To link items together relationally, you simply save a reference to an item's PK in a different field. That _reference_
is called a Foreign Key (FK). If the primary key is a _person_, the foreign key is like their _business card_. It

View File

@@ -27,7 +27,7 @@ their account.
1. Navigate to the **User Library**
2. **Click on the user** you wish to manage
3. **Complete the form** of [User Fields](/concepts/application/#user-detail)
3. **Complete the form** of [User Fields](/app/user-directory/#editing-a-user)
The User Detail is only editable by the current user and admins, and the following fields are only available to admins:
@@ -213,8 +213,9 @@ Workflows are a way to add structured stages to the flow of content authoring. T
permissions for a Collection, but can be further enhanced via email notifications, custom interfaces, and automation.
Directus supports endlessly configurable workflows, so we will only cover one simple example below.
1. To create a structured workflow for **Articles**, the first step is [Creating a Field](/reference/system/fields/) to
track the article "status" — we'll call it **Status**, but it can be named anything.
1. To create a structured workflow for **Articles**, the first step is
[Creating a Field](/configuration/data-model/#creating-a-field) to track the article "status" — we'll call it
**Status**, but it can be named anything.
2. Next, create different Roles for each stage of the workflow, such as `author` and `manager`.
3. Finally, configure the Role permissions based on the possible values of that Status field, such as `draft`, `review`,
`approved`, and `published`, so that they are properly restricted to create content and update the status.

View File

@@ -0,0 +1,3 @@
# App Translations
> TK

View File

@@ -1,7 +1,7 @@
# Custom Displays <small></small>
> Displays are small inline components that allow you to create new ways of viewing field values throughout the App.
> [Learn more about Displays](/concepts/displays/).
> [Learn more about Displays](/getting-started/glossary/#displays).
## 1. Setup the Boilerplate

View File

@@ -1,7 +1,7 @@
# Custom Interfaces <small></small>
> Custom Interfaces allow you to create new ways of viewing or interacting with field data on the Item Detail page.
> [Learn more about Interfaces](/concepts/interfaces/).
> [Learn more about Interfaces](/getting-started/glossary/#interfaces).
## 1. Setup the Boilerplate

View File

@@ -1,22 +1,28 @@
# Extensions
> In addition to being highly customizable, Directus has also been built with many modular extension points throughout
> the App, API and CLI.
> In addition to being highly customizable, Directus has been architected to be completely modular and extensible. This
> ensures you will never hit a hard feature ceiling within the platform.
## App Extensions
Directus has been architected as completely modular and extensible, with four keystone App component types.
Out-of-the-box components are configurable, or altogether new components can be created as extensions.
Allow creating custom experiences within the Directus App.
- [Modules](/extensions/modules/)
- [Layouts](/extensions/layouts/)
- [Interfaces](/extensions/interfaces/)
- [Displays](/extensions/displays/)
- [Modules](/extensions/modules/) — Created with Vue.js
- [Layouts](/extensions/layouts/) — Created with Vue.js
- [Interfaces](/extensions/interfaces/) — Created with Vue.js
- [Displays](/extensions/displays/) — Created with Vue.js
- [Panels](/extensions/panels/) — Created with Vue.js
- [Themes](/extensions/themes/) — Created with custom CSS
- [Translations](/extensions/app-translations/) — Managed in Crowdin
## API Extensions
- [Endpoints](/extensions/api-endpoints)
- [Hooks](/extensions/api-hooks)
Allow extending and customizing the data pipeline and platform logic.
- [API Endpoints](/extensions/api-endpoints/) — Created with JavaScript / Node.js
- [Hooks](/extensions/hooks/) — Created with JavaScript / Node.js
- [Email Templates](/extensions/email-templates/) — Created with Liquid.js
- [Migrations](/extensions/migrations/) — Created with JavaScript / Node.js
<!-- ## CLI Extensions

View File

@@ -1,4 +1,4 @@
# Styles
# Themes & Styling
> **Form Follows Function** is the guiding design principle of Directus. The minimal UI allows the platform to be easily
> tailored to your brand. [Learn more about the App](/concepts/application/).

View File

@@ -108,7 +108,7 @@ migrations to promote data between them.
The platform has been built to be modular and extensible. This helps keep the core codebase simple and clean (see the
[80/20 Rule](/contributing/introduction/#feature-requests)), while allowing the flexibility needed to satisfy all
use-cases... no matter how complex. There are many different types of supported extensions, each offering a way to
deeply customize, override, or extend the core platform. [Learn more about Extension Types](#).
deeply customize, override, or extend the core platform. [Learn more about Extensions](/extensions/introduction/).
## Fields
@@ -157,9 +157,9 @@ Items are referenced (both individually and relationally) by their unique [prima
#### Relevant Guides
- [Creating an Item](/guides/items/#creating-an-item)
- [Creating an Item](/app/content-collections/#creating-an-item)
- [Archiving an Item](/app/content-items/#archiving-an-item)
- [Reordering Items](/guides/items/#reordering-items)
- [Manually Sorting Items](/app/content-collections/#manually-sorting-items)
- [Deleting an Item](/app/content-items/#deleting-an-item)
## Junction Collections
@@ -227,7 +227,8 @@ two main ways to achieve multitenancy:
## Panels
Panels are modular units of data visualization that exist within the Insights module. Each panel exists within a
[Dashboard](#dashboards) and can be positioned and resized as needed. [Panels are a Modular Extension Type](#).
[Dashboard](#dashboards) and can be positioned and resized as needed.
[Panels are a Modular Extension Type](/extensions/panels/).
## Permissions
@@ -257,13 +258,13 @@ often called `id`.
A Project is a complete instance of the platform. Each project represents a **Database**, but also encapsulates a config
file, asset storage, and any custom extensions. Projects are the highest level of organization in Directus.
- [Creating a Project](/dead)
- [Configuring a Project](/dead)
- [Creating a Project](/getting-started/installation/)
- [Configuring a Project](/configuration/config-options/)
- [Adjusting Project Settings](/configuration/project-settings/)
- [Upgrading a Project](/dead)
- [Backing-up a Project](/dead)
- [Migrating a Project](/dead)
- [Deleting a Project](/dead)
- [Upgrading a Project](/configuration/upgrades-migrations/)
- [Backing-up a Project](/configuration/upgrades-migrations/#backing-up-a-project)
- [Migrating a Project](/configuration/upgrades-migrations/#migrating-a-project)
- [Deleting a Project](/configuration/upgrades-migrations/#deleting-a-project)
## Relationships

View File

@@ -6,9 +6,9 @@
While our CLI is the recommended method for self-hosting, you can use whichever of these self-hosted options best suits
your needs. These methods offer a high level of customization and are ideal for intermediate developers.
- [Command Line Interface (CLI)](/reference/cli/)
- [Docker](/configuration/installation/docker/)
- [Manually](/configuration/installation/manual/)
- [Command Line Interface (CLI)](/getting-started/installation/cli/)
- [Docker](/getting-started/installation/docker/)
- [Manually](/getting-started/installation/manual/)
::: tip Development Environment
@@ -22,11 +22,11 @@ The following guides will walk you through the self-hosted installation process
These options are only recommended for developers familiar with these services and comfortable with more advanced setup.
While Directus is always completely free, you will likely need to pay for these services.
- [Generic Ubuntu](/configuration/installation/ubuntu/)
- [Internet Information Services (IIS)](/configuration/installation/iis)
- [Amazon AWS](/configuration/installation/aws)
- [DigitalOcean App Platform](/configuration/installation/digitalocean-app-platform)
- [Shared Hosting with Plesk](/configuration/installation/plesk)
- [Generic Ubuntu](/getting-started/installation/ubuntu/)
- [Internet Information Services (IIS)](/getting-started/installation/iis)
- [Amazon AWS](/getting-started/installation/aws)
- [DigitalOcean App Platform](/getting-started/installation/digitalocean-app-platform)
- [Shared Hosting with Plesk](/getting-started/installation/plesk)
## One-Click Installs

View File

@@ -18,7 +18,7 @@ Will run Directus in an autoscaling environment with a load balancer. Makes sure
replace individual instances in case of unexpected crashes.
We recommend setting up a repo in GitHub (or another Git provider) and configuring it using
[our manual installation flow](/configuration/installation/manual). This allows you to later hook up the repo to your
[our manual installation flow](/getting-started/installation/manual). This allows you to later hook up the repo to your
Elastic Beanstalk instance through CodeDeploy.
See

View File

@@ -85,4 +85,5 @@ By default, the `create-directus-project` tool will set the file permissions of
## Configure / Update / Upgrade your Project
See the [Project Guide](/guides/projects/#upgrading-updating-a-project) to learn how to maintain your project further.
See the [Updates & Migrations](/configuration/upgrades-migrations/) to learn how to maintain your project moving
forward.

View File

@@ -2,7 +2,8 @@
## 1. Setup a repo on GitHub
See the doc on [installing Directus manually](/configuration/installation/manual/) to learn how to configure this repo.
See the doc on [installing Directus manually](/getting-started/installation/manual/) to learn how to configure this
repo.
## 2. Sign up for a DigitalOcean account
@@ -21,7 +22,7 @@ Make sure to select the database you created in step 2 during the configuration
While Directus itself doesn't have to be built from source in order to use it on App Platform, we do recommend adding
`npx directus bootstrap` as the "build" step for DigitalOcean. This will automatically provision the database if it's
empty, and migrate it to the latest version in case of upgrades. See
[Command Line Interface](/configuration/installation/cli/) for more information.
[Command Line Interface](/getting-started/installation/cli/) for more information.
## 6. Configure the environment variables

View File

@@ -9,7 +9,7 @@ If you're experiencing issues or think you have found a problem in Directus, be
[Reporting a Bug](/contributing/introduction/#bug-reporting):
1. Ensure your server/database meet the
[minimum requirements](/configuration/installation/cli/#_1-confirm-minimum-requirements)
[minimum requirements](/getting-started/installation/cli/#_1-confirm-minimum-requirements)
2. Ensure youre on the [latest version of Directus](https://github.com/directus/directus/releases/latest)
3. Stop (`CTRL+C`) and restart the server (`npx directus start`)
4. Run the database migration script: `directus database migrate:latest` (backup your database first)

View File

@@ -7,8 +7,9 @@ pageClass: page-reference
<div class="two-up">
<div class="left">
> All data within the platform is private by default. The [public role](#) can be configured to expose data without
> authentication, or you can pass an access token to the API to access private data.
> All data within the platform is private by default. The
> [public role](/configuration/users-roles-permissions/#configuring-public-permissions) can be configured to expose data
> without authentication, or you can pass an access token to the API to access private data.
</div>

View File

@@ -29,8 +29,8 @@ migrate it to the latest version (if it already exists and has missing migration
This is very useful to use in environments where you're doing standalone automatic deployments, like a multi-container
Kubernetes configuration, or a similar approach on
[DigitalOcean App Platform](/configuration/installation/digitalocean-app-platform/) or
[AWS Elastic Beanstalk](/configuration/installation/aws)
[DigitalOcean App Platform](/getting-started/installation/digitalocean-app-platform/) or
[AWS Elastic Beanstalk](/getting-started/installation/aws)
::: tip First User

View File

@@ -87,8 +87,8 @@ exist, it is dynamically generated and immediately returned.
### Preset Transformations
- **`key`** — This **key** of the [Storage Asset Preset](/guides/files#creating-thumbnail-presets), a shortcut for the
below parameters
- **`key`** — This **key** of the [Storage Asset Preset](/configuration/project-settings/#files-thumbnails), a shortcut
for the below parameters
### Custom Transformations

View File

@@ -57,10 +57,11 @@ How often a user is allowed to try to login. After which times the user will be
What regex passwords must pass in order to be valid.
`storage_asset_transform` **string**\
If the transform endpoints are allowed to be used on [the assets endpoint](/reference/assets/). One of `all`, `none` or `presets`.
If the transform endpoints are allowed to be used on [the assets endpoint](/reference/files/#requesting-a-thumbnail). One
of `all`, `none` or `presets`.
`storage_asset_presets` **array**\
What preset keys exist in [the assets endpoint](/reference/assets/).
What preset keys exist in [the assets endpoint](/reference/files/#requesting-a-thumbnail).
</div>
</div>