diff --git a/app/src/modules/docs/routes/markdown.vue b/app/src/modules/docs/routes/markdown.vue index 3b078f5541..b2aefb84da 100644 --- a/app/src/modules/docs/routes/markdown.vue +++ b/app/src/modules/docs/routes/markdown.vue @@ -261,6 +261,11 @@ export default defineComponent({ ul, ol { margin: 4px 0; + + li { + margin: 4px 0; + line-height: 24px; + } } } diff --git a/docs/guides/creating-a-collection.md b/docs/guides/creating-a-collection.md index 586a516cb8..35d1ddf68c 100644 --- a/docs/guides/creating-a-collection.md +++ b/docs/guides/creating-a-collection.md @@ -2,16 +2,16 @@ > TK -## Creating a Collection in Directus +## Creating a Collection 1. Navigate to **Settings > Data Model** 2. Click the **Create Collection** ("+") action button in the header 3. Enter a unique **Collection Name**, keeping in mind that this is entered as a _key_ that determines the database table name, and is then presented in the App using the [Title Formatter](#). -4. Optional: Configure the collection's primary key name and type. +4. Optional: Configure the collection's **Primary Key** name and type. * Auto-Incremented Integer * Generated UUID * Manually Entered String -4. Optional: Enable and rename any desired system fields. +4. Optional: Enable and rename any desired **System Fields**. * Status * Sort * Created On @@ -25,13 +25,38 @@ ::: ::: Database Tables -Keep in mind that a Directus Collection is essentially just a database table. Therefore you can import or create a table directly in the database, and it will automatically appear in Directus. The first time you manage that table, a record will be created within `directus_collections` with default values. +Keep in mind that Directus Collections are just a database tables. Therefore you can import or create a table directly in the database, and it will automatically appear within Directus. The first time you manage that table, a `directus_collections` record will be created with default values. ::: ## Configuring a Collection -## Archive +### Fields & Layout -## Sort +* [Creating a Field](#) +* [Updating a Field](#) +* [Deleting a Field](#) +* [Duplicating a Field](#) +* [Changing Field Order & Layout](#) + +### Collection Setup + +* **Collection Name** — This is the key for the collection. It can not be modified, but you can override it with Translations (see below) +* **Icon** — The icon used throughout the App when referencing this collection +* **Note** — A helpful note that explains the collection's purpose +* **Display Template** — A [Field Template](#) used to create dynamic titles for the collection's items +* **Hidden** — Toggles if the collection should be globally hidden. Keep in mind that Admin roles can always see all collections. +* **Singleton** — Is this collection will only contain a single item (eg: an "About Us" form). When enabled, the [Item Browse](#) will be bypassed, and users are taken directly to the [Item Detail](#) page. +* **Translation** — Allows translating the collection name into different languages. These [Schema Translations](#) are important for multilingual projects. You can also "translate" a collection name into the default language — helpful for renaming technical table names. + +### Archive + +The archive feature allows you to enable the collection with a custom soft-delete option. Soft-delete allows users to remove items from the App, but maintains the actual database record for easy recovery. + +* **Archive Field** — The field that will determine the +* **Archive App Filter** — +* **Archive Value** — +* **Unarchive Value** — + +### Sort ## Deleting a Collection diff --git a/docs/guides/extensions/creating-a-custom-api-hook.md b/docs/guides/extensions/creating-a-custom-api-hook.md index 5218c22485..4630515890 100644 --- a/docs/guides/extensions/creating-a-custom-api-hook.md +++ b/docs/guides/extensions/creating-a-custom-api-hook.md @@ -8,12 +8,12 @@ Custom hooks are dynamically loaded from within your extensions folder. By defau ### Default Standalone Hook Location ``` -/extensions/hooks/.js +/extensions/hooks//index.js ``` ### Default Bundled Hook Location ``` -/extensions/bundles//hooks/.js +/extensions/bundles//hooks//index.js ``` ## 2. Define the Event