Update links in docs (#4091)

This commit is contained in:
YannickMol
2021-02-16 19:34:16 +01:00
committed by GitHub
parent be8fdd03f9
commit 983d667343
4 changed files with 107 additions and 60 deletions

View File

@@ -1,8 +1,11 @@
# The Directus Application
> The Directus App is the presentation layer for your data, content, and assets. It uses a left-to-right visual hierarchy for organization and navigation. Below we cover the App's global elements and individual pages.
> The Directus App is the presentation layer for your data, content, and assets. It uses a left-to-right visual
> hierarchy for organization and navigation. Below we cover the App's global elements and individual pages.
The Directus App is decoupled from, and powered by, the Directus API. It provides a way for both technical admins and non-technical users to view and manage content of the connected database. It is written in [Vue.js](https://vuejs.org), is completely modular, and is highly customizable.
The Directus App is decoupled from, and powered by, the Directus API. It provides a way for both technical admins and
non-technical users to view and manage content of the connected database. It is written in [Vue.js](https://vuejs.org),
is completely modular, and is highly customizable.
## App Section Hierarchy
@@ -13,7 +16,9 @@ The Directus App is decoupled from, and powered by, the Directus API. It provide
- **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](/guides/roles-and-permissions/#customizing-the-module-navigation) is done within the Role's configuration, but the default module list includes:
- **Module Navigation** — Allows navigating between the different modules your user has access to. Customizing the
Module Navigation is done within the [Role's configuration](/guides/roles/#configuring-a-role), but the default module
list includes:
- [Collections](#collections)
- [User Directory](#user-directory)
- [File Library](#file-library)
@@ -21,12 +26,14 @@ The Directus App is decoupled from, and powered by, the Directus API. It provide
- [Settings](#settings) (Admin Roles Only)
- [Any Custom Modules](/concepts/modules/) (Only if Configured)
- **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.
- Sign Out — Hovering over the User Menu exposes the button to log out of the platform.
### 2. Navigation Bar
- **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](/guides/projects/#adjusting-project-settings).
- **Navigation** — This is a dynamic navigation based on your current module. Some modules also support [Bookmark Presets](/guides/presets/#creating-a-preset), which are a customizable links to specific data-sets.
- **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](/guides/projects/#adjusting-project-settings).
- **Navigation** — This is a dynamic navigation based on your current module. Some modules also support
[Bookmark Presets](/guides/presets/#creating-a-preset), which are a customizable links to specific data-sets.
### 3. Page
@@ -58,16 +65,18 @@ the same as its navigation listing.
### Collection Detail
This is the main gateway to your content items, providing a highly configurable Layout for browsing and visualizing the items within a collection. The header of this page includes key action buttons for creating, deleting, and batch editing items.
This is the main gateway to your content items, providing a highly configurable Layout for browsing and visualizing the
items within a collection. The header of this page includes key action buttons for creating, deleting, and batch editing
items.
- [Adjusting a Collection Layout](/guides/collections/#adjusting-a-collection-layout)
- [Creating an Item](/guides/items/#creating-an-item)
- [Updating an Item](/guides/items/#updating-an-item)
- [Deleting an Item](/guides/items/#deleting-an-item)
- [Archiving an Item](/guides/items/#archiving-an-item)
- [Reordering Items](/guides/items/#reordering-items)
- [Ordering Items](/guides/items/#ordering-items)
- [Exporting Items](/guides/items/#exporting-items)
- [Browsing Items](/guides/items/#browsing-items)
- Browsing Items
- [Searching](/guides/items/#searching-items)
- [Filtering](/guides/items/#filtering-items)
- [Bookmarking](/guides/items/#bookmarking-item-presets)
@@ -75,8 +84,8 @@ This is the main gateway to your content items, providing a highly configurable
### Item Detail
Most Collection Detail Layouts support navigating to individual item detail pages where you a presented with a
[customizable form](/guides/fields#adjusting-fields-layout) for viewing/editing the item's content. Like other detail
pages, there are many available features, including:
[customizable form](/guides/fields#adjusting-field-arrangement) for viewing/editing the item's content. Like other
detail pages, there are many available features, including:
- [Adjusting Field Arrangement](/guides/fields/#adjusting-field-arrangement)
- [Updating an Item](/guides/items/#updating-an-item)
@@ -87,14 +96,16 @@ pages, there are many available features, including:
## User Directory
This module includes a comprehensive listing of all system users within your project. This page has the same features and
configuration as [Collection Detail](#collection-detail).
This module includes a comprehensive listing of all system users within your project. This page has the same features
and configuration as [Collection Detail](#collection-detail).
### User Detail
Similar to other [Item Detail](#item-detail) pages, this page provides a custom form for viewing system users. This is also used for editing the "Profile Page" of the current user, which is accessible from the [User Menu](#_1-module-bar). There are a number of [User Fields](/concepts/users/#user-fields) included out-of-the-box that can then be extended by following the normal [Creating a Field](/guides/fields/#creating-a-field) guide.
Similar to other [Item Detail](#item-detail) pages, this page provides a custom form for viewing system users. This is
also used for editing the "Profile Page" of the current user, which is accessible from the [User Menu](#_1-module-bar).
There are a number of [User Fields](/concepts/users/#user-fields) included out-of-the-box that can then be extended by
following the normal [Creating a Field](/guides/fields/#creating-a-field) guide.
- [Setting up your User Profile](/guides/users/#setting-up-your-user-profile)
- [Creating a User](/guides/users/#creating-a-user)
- [Inviting a User](/guides/users/#inviting-a-user)
- [Configuring a User](/guides/users/#configuring-a-user)
@@ -108,10 +119,12 @@ configuration as [Collection Detail](#collection-detail).
### File Detail
Similar to other [Item Detail](#item-detail) pages, this page provides a custom form for viewing assets and embeds. There are a number of [File Fields](/concepts/files/#file-fields) included out-of-the-box that can then be extended by following the normal [Creating a Field](/guides/fields/#creating-a-field) guide.
Similar to other [Item Detail](#item-detail) pages, this page provides a custom form for viewing assets and embeds.
There are a number of [File Fields](/concepts/files/#file-fields) included out-of-the-box that can then be extended by
following the normal [Creating a Field](/guides/fields/#creating-a-field) guide.
- [Uploading a File](/guides/files/#uploading-a-file)
- [Accessing an Original File](/guides/files/#accessing-an-original-file)
- [Accessing an Original File](/guides/files/#downloading-an-original-file)
- [Creating a Thumbnail Preset](/guides/files/#creating-a-thumbnail-preset)
- [Requesting a Thumbnail](/guides/files/#requesting-a-thumbnail)
@@ -137,7 +150,8 @@ editing/fixing via [GitHub](https://github.com/directus/directus).
::: tip Public Docs
The latest version of the Directus Docs are also available publicly. This online version includes additional sections, such as how to install the platform. [https://docs.directus.io](https://docs.directus.io)
The latest version of the Directus Docs are also available publicly. This online version includes additional sections,
such as how to install the platform. [https://docs.directus.io](https://docs.directus.io)
:::
@@ -150,13 +164,13 @@ being located within the notifications tray of the page sidebar. This page has t
### Activity Detail
Unlike other item detail pages, activity items are **readonly** (for proper accountability) and open in a side drawer to display the [Activity Fields](/concepts/activity/#activity-fields).
Unlike other item detail pages, activity items are **readonly** (for proper accountability) and open in a side drawer to
display the [Activity Fields](/concepts/activity/#activity-fields).
## Settings
This module is only available to users within [Admin roles](/concepts/roles/#administrators-role).
This is where your project is configured, and the first place to go after installation. It includes the following
sections:
This module is only available to users within [Admin roles](/concepts/roles/#administrators-role). This is where your
project is configured, and the first place to go after installation. It includes the following sections:
- [Project Settings](/guides/projects/#adjusting-project-settings)
- [Data Model](/concepts/databases/#database-mirroring)

View File

@@ -1,7 +1,7 @@
# Directus Docs
> These Docs will help you get up-and-running quickly, guide you through advanced features, and explain the core concepts
> that make Directus so unique.
> These Docs will help you get up-and-running quickly, guide you through advanced features, and explain the core
> concepts that make Directus so unique.
::: tip Version 9
@@ -13,9 +13,13 @@ Node.js. If you are looking for the previous **[Directus 8](https://github.com/d
## What is Directus?
**Directus is an Open Data Platform for managing the content of any SQL database. It provides a powerful API layer for developers and an intuitive App for non-technical users.** Written entirely in JavaScript (primarily [Node.js](https://nodejs.dev) and [Vue.js](https://vuejs.org)), Directus is completely open-source, modular, and extensible, allowing it to be fully tailored to your exact project needs.
**Directus is an Open Data Platform for managing the content of any SQL database. It provides a powerful API layer for
developers and an intuitive App for non-technical users.** Written entirely in JavaScript (primarily
[Node.js](https://nodejs.dev) and [Vue.js](https://vuejs.org)), Directus is completely open-source, modular, and
extensible, allowing it to be fully tailored to your exact project needs.
Our platform can be used as a headless CMS for managing digital experiences, a database client for democratizing data, or as a standalone back-office web app for CRM, inventory, business intelligence, project management, etc.
Our platform can be used as a headless CMS for managing digital experiences, a database client for democratizing data,
or as a standalone back-office web app for CRM, inventory, business intelligence, project management, etc.
::: tip What's in a name?
@@ -26,13 +30,18 @@ lines_. The broadest goal of our platform is to present data in a simple, orderl
## What makes it unique?
**Directus dynamically generates custom API endpoints based on your SQL database's schema in real-time — something we call "Database Mirroring".** Whether you install fresh or on top of an existing database, you always maintain end-to-end control over your actual database, including: tables, columns, datatypes, default values, indexes, relationships, etc.
**Directus dynamically generates custom API endpoints based on your SQL database's schema in real-time — something we
call "Database Mirroring".** Whether you install fresh or on top of an existing database, you always maintain end-to-end
control over your actual database, including: tables, columns, datatypes, default values, indexes, relationships, etc.
Perhaps one of the biggest advantages of _Database Mirroring_ is that you have direct access to your pure and unaltered data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.
Perhaps one of the biggest advantages of _Database Mirroring_ is that you have direct access to your pure and unaltered
data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with
proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.
Directus is a simple solution for complex problems, with a data-first approach guided by the following core principles:
- **Pure** — There is no predefined model or proprietary rules for your schema, and all system settings are stored separately.
- **Pure** — There is no predefined model or proprietary rules for your schema, and all system settings are stored
separately.
- **Open** — Our entire codebase is public and transparent, allowing for end-to-end audits. Nothing is obfuscated or
black-boxed.
- **Portable** — Data is stored in your bespoke database and can be migrated/exported/backed-up at any time. Absolutely
@@ -48,7 +57,8 @@ Directus is a simple solution for complex problems, with a data-first approach g
### Open-Source Core
Our completely free and open-source (GPLv3) Open Data Platform. Directus includes our dynamic API engine (Node.js), the intuitive Admin App (Vue.js), this documentation (Markdown), and all dependencies.
Our completely free and open-source (GPLv3) Open Data Platform. Directus includes our dynamic API engine (Node.js), the
intuitive Admin App (Vue.js), this documentation (Markdown), and all dependencies.
- **[GitHub Repository](https://github.com/directus/directus)**
- **[npm Package](https://www.npmjs.com/package/directus)**
@@ -57,10 +67,11 @@ Our completely free and open-source (GPLv3) Open Data Platform. Directus include
### Documentation
[Our documentation](https://docs.directus.io) describes the most recent version of our platform. They are written in
publicly managed markdown files so the community can help keep them clean and up-to-date. The docs are divided into the following sections:
publicly managed markdown files so the community can help keep them clean and up-to-date. The docs are divided into the
following sections:
- [Getting Started](/getting-started/introduction/) — Novice oriented, for a platform intro and installation.
- [Concepts](/concepts/platform-overview/) — Learning oriented, for understanding the platform.
- [Concepts](/concepts/activity/) — Learning oriented, for understanding the platform.
- [Guides](/guides/projects/) — Problem oriented, follow along with steps while working.
- [Reference](/reference/command-line-interface/) — Information oriented, look up info and specs while working.
- [API Reference](/reference/api/introduction/) — Information oriented, look up API resources while working.
@@ -68,17 +79,21 @@ publicly managed markdown files so the community can help keep them clean and up
::: tip Versioned Docs
Specific version of the Docs ship with each install of Directus 9. They can be found within the [Documentation module](/concepts/app-overview.html#documentation) of the App.
Specific version of the Docs ship with each install of Directus 9. They can be found within the
[Documentation module](/concepts/application#documentation) of the App.
:::
### On-Demand Cloud
[Our self-service platform](https://directus.cloud) for quick and affordable instances of Directus on a multitenant infrastructure. Each project includes automatic updates, automatic backups, .
[Our self-service platform](https://directus.cloud) for quick and affordable instances of Directus on a multitenant
infrastructure. Each project includes automatic updates, automatic backups, .
### Enterprise Cloud
Our premium managed solution. Powered by dedicated hardware in your selected region, this service offers high-availability, custom limits, SSO, API white-labeling, uptime SLAs, and more. [Contact our sales team](https://directus.io/contact/) to discuss pricing and options.
Our premium managed solution. Powered by dedicated hardware in your selected region, this service offers
high-availability, custom limits, SSO, API white-labeling, uptime SLAs, and more.
[Contact our sales team](https://directus.io/contact/) to discuss pricing and options.
### Cloud Documentation
@@ -86,11 +101,15 @@ Our premium managed solution. Powered by dedicated hardware in your selected reg
### Private Demos
Our On-Demand Cloud platform includes ability to [create private demo instances](https://directus.cloud/docs#creating-a-private-demo). Each demo runs the latest version of Directus, lasts for several hours, and is completely free, with no credit card required.
Our On-Demand Cloud platform includes ability to
[create private demo instances](https://directus.cloud/docs#creating-a-private-demo). Each demo runs the latest version
of Directus, lasts for several hours, and is completely free, with no credit card required.
### System Status
The [Status Page](https://status.directus.cloud) provides up-to-date information on our various systems, including current and historical incident details and our 30-day uptime percentage. From this site you can access the global status or your Cloud project's dedicated status page.
The [Status Page](https://status.directus.cloud) provides up-to-date information on our various systems, including
current and historical incident details and our 30-day uptime percentage. From this site you can access the global
status or your Cloud project's dedicated status page.
### Website
@@ -102,12 +121,15 @@ For the latest product info and sneak-peeks, be sure to follow us on [Twitter](h
### Community
Join our growing community of 4,000+ developers on [Discord](https://directus.chat) and Slack (legacy). From community support to seeing where the platform is heading next, it's a great way to get involved.
Join our growing community of 4,000+ developers on [Discord](https://directus.chat) and Slack (legacy). From community
support to seeing where the platform is heading next, it's a great way to get involved.
### App Locales
We use [Crowdin](https://locales.directus.io/) to manage our numerous App translations. If you're looking to add or improve Directus in your language, you can [learn more here](#).
We use [Crowdin](https://locales.directus.io/) to manage our numerous App translations. If you're looking to add or
improve Directus in your language, you can [learn more here](/contributing/translations/).
### Marketplace
Coming in 2021, the [Directus Marketplace](https://directus.market/) will offer a unified portal to extensions created by our Core Team and community contributors.
Coming in 2021, the [Directus Marketplace](https://directus.market/) will offer a unified portal to extensions created
by our Core Team and community contributors.

View File

@@ -56,7 +56,8 @@ With the Collection created, it's time to start adding some Fields. Click the **
![Directus Add a Field](../assets/getting-started/quickstart/add-field.png)
We'll be calling our Field `title`. While Directus offers a range of powerful field customization options, we'll be sticking to the defaults for now. These defaults use the "String" datatype and "Text Input" interface
We'll be calling our Field `title`. While Directus offers a range of powerful field customization options, we'll be
sticking to the defaults for now. These defaults use the "String" datatype and "Text Input" interface
::: tip More Info on Fields
@@ -73,22 +74,28 @@ Collections Module (top left), open your created Collection, and click the "+" b
Once you're happy with your creation, click the checkmark in the top-right to save your item to the database.
::: tip More Info on Items
To learn more about the different types of Items, and all available options, see [Items](/guides/items).
:::
## 6. Set Role/Public Permissions
By default, all content entered into Directus is considered private. This means that no data will be returned by the
API, unless requested by an authenticated user that has the correct permissions. In order to have the API return our
items, we'll have to setup some permissions. Navigate to **Settings Module > Roles & Permissions**.
Directus ships with a special **"Public"** role that controls what data is returned to non-authenticated users. Select the
public role, find your collection, and click the icon under the "eye" icon (read/view permission) to allow the public role to read the
items in your collection.
Directus ships with a special **"Public"** role that controls what data is returned to non-authenticated users. Select
the public role, find your collection, and click the icon under the "eye" icon (read/view permission) to allow the
public role to read the items in your collection.
![Directus Permissions](../assets/getting-started/quickstart/permissions.png)
::: tip More Info on Permissions
::: tip More Info on Roles & Permissions
Permissions are extremely powerful and can get pretty in-depth. To learn all about the nuances in setting up permissions, see
[Roles & Permissions](/guides/roles).
Roles & Permissions are extremely powerful and can get pretty in-depth. To learn all about the nuances in setting up
roles & permissions, see [Roles](/guides/roles) & [Permissions](/guides/permissions).
:::
@@ -96,12 +103,13 @@ Permissions are extremely powerful and can get pretty in-depth. To learn all abo
Now that your project has some content in it, it's time to start using this content externally. Data can be accessed in
a number of ways, including the REST API, GraphQL, the CLI, or even straight from the database. In this case, we'll use
[the `/items/` REST API endpoint](/reference/api/items) to retrieve the item we just created.
[the `/items/` REST API endpoint](/reference/api/rest/items) to retrieve the item we just created.
Using your browser, or an API tool like [Postman](http://postman.com) or [Paw](https://paw.cloud), open
[http://localhost:8055/items/articles](http://localhost:8055/items/articles).
And there it is! The Article Item you just created is being served in beautiful JSON, ready to be used anywhere and everywhere!
And there it is! The Article Item you just created is being served in beautiful JSON, ready to be used anywhere and
everywhere!
```json
{

View File

@@ -1,6 +1,7 @@
# Help & Support
# Help & Support
> Directus is offered completely free and open-source for anyone wishing to self-host the platform. If you have questions along the way, there are many resources, both free and paid, to help you get up-and-running smoothly.
> Directus is offered completely free and open-source for anyone wishing to self-host the platform. If you have
> questions along the way, there are many resources, both free and paid, to help you get up-and-running smoothly.
## Community Support
@@ -13,8 +14,8 @@ Our [Discord Community](https://directus.chat) is another great way to get assis
## Premium Support
Premium support is included with our Enterprise Cloud service. On-Demand Cloud customers and Self-Hosted users interested
in learning more about our monthly retainer agreements should contact us at
Premium support is included with our Enterprise Cloud service. On-Demand Cloud customers and Self-Hosted users
interested in learning more about our monthly retainer agreements should contact us at
[support@directus.io](mailto:support@directus.io).
## Sponsored Work
@@ -23,8 +24,8 @@ in learning more about our monthly retainer agreements should contact us at
If you need a specific feature added to Directus faster than the normal development timeline,
[reach out to us](https://directus.io/contact/) for a quote. Our parent agency will often help subsidize the cost of
developing new features if they pass our [80/20 Rule](/contributing/introduction) and can be merged into the core
codebase. Other custom/proprietary development will be built bespoke within our robust extension system.
developing new features if they pass our [80/20 Rule](/contributing/introduction/#feature-requests) and can be merged
into the core codebase. Other custom/proprietary development will be built bespoke within our robust extension system.
### Expedited Fixes
@@ -36,16 +37,18 @@ resolved sooner, [reach out to us](https://directus.io/contact/) for a quote.
### Does Directus support Mongo/NoSQL?
Not currently. Directus has been built specifically for wrapping _relational_ databases. While we could force Mongo to
use tables, columns, and rows via Mongoose object modeling, that approach of "faking" a relational structure in a non-structured environment like Mongo doesn't make a lot of sense. We do realize many users are interested in this feature, and will continue to explore its possibility.
use tables, columns, and rows via Mongoose object modeling, that approach of "faking" a relational structure in a
non-structured environment like Mongo doesn't make a lot of sense. We do realize many users are interested in this
feature, and will continue to explore its possibility.
### Why haven't you added this feature, or fixed that issue yet?
Directus is primarily a free and open-source project, maintained by a small core team and community contributors who
donate their time and resources.
Our platform is feature-rich, however we strictly adhere to our [80/20 Rule](/contributing/introduction) to avoid a
messy/bloated codebase. Directus is also quite stable, however new issues still arise, some of which may be triaged with
a lower prioritization.
Our platform is feature-rich, however we strictly adhere to our
[80/20 Rule](/contributing/introduction/#feature-requests) to avoid a messy/bloated codebase. Directus is also quite
stable, however new issues still arise, some of which may be triaged with a lower prioritization.
If you require more expeditious updates, you can contact us regarding [sponsoring expedited fixes](#expedited-fixes) or
[commissioning new features](#commissioned-features). You can also
@@ -59,5 +62,5 @@ not. This is open-source software, work is prioritized internally, and all timel
### But this is an emergency, my very important project requires it now!
We understand, and are here to help. If you need something prioritized, you can reach out to us to discuss
[premium support](#premium-support), [sponsoring expedited fixes](#expedited-features) or
[premium support](#premium-support), [sponsoring expedited fixes](#expedited-fixes) or
[commissioning new features](#commissioned-features).