diff --git a/app/src/modules/docs/components/sections.ts b/app/src/modules/docs/components/sections.ts index 602fe1d2dd..aabe62e35a 100644 --- a/app/src/modules/docs/components/sections.ts +++ b/app/src/modules/docs/components/sections.ts @@ -24,16 +24,16 @@ const sections: Section[] = [ to: '/docs/getting-started/introduction', }, { - name: 'Troubleshooting', - to: '/docs/getting-started/troubleshooting', + name: 'Technical Support', + to: '/docs/getting-started/technical-support', }, { name: 'Contributing', to: '/docs/getting-started/contributing', }, { - name: 'Supporting Directus', - to: '/docs/getting-started/supporting-directus', + name: 'Backing Directus', + to: '/docs/getting-started/backing-directus', }, ], }, diff --git a/docs/getting-started/supporting-directus.md b/docs/getting-started/backing-directus.md similarity index 82% rename from docs/getting-started/supporting-directus.md rename to docs/getting-started/backing-directus.md index 70e008ea50..06da568a5b 100644 --- a/docs/getting-started/supporting-directus.md +++ b/docs/getting-started/backing-directus.md @@ -1,4 +1,4 @@ -# Supporting Directus +# Backing Directus > Directus is both _premium_ and _free_ — two things that don't often go together. It takes significant resources to maintain and advance the platform. If you'd like to help keep Directus active and open-source please consider supporting it through one of the methods below. @@ -14,18 +14,14 @@ Monthly donations via [GitHub Sponsors](#) are the most reliable form of financi * [WoLfulus](https://github.com/WoLfulus) — DevOps * [Nitwel](https://github.com/Nitwel) — Developer +### Sponsored Work + +[Commissioned Features](#) and [Expedited Fixes](#) are great ways to financially support the development of Directus, and improve the codebase for the community. + ### Merch Our merchandise is a great way to support Directus — you get some swag, and we get some financial support and advertising. Simply make an appropriate financial donation through [GitHub Sponsors](#), message us with sizing/shipping details, and we'll get it shipped! -### Commissioned Features - -If you need a specific feature added to Directus faster than the normal development timeline, [reach out to us](#) for a quote. Our parent agency will often help subsidize the cost of developing new features if they pass our [80/20 Rule](#) and can be merged into the core codebase. Other custom/proprietary development will be built bespoke within our robust extension system. - -### Expedited Fixes - -We triage all reported bugs based on priority and how long the fix is estimated to take. If you need a specific issue resolved sooner, [reach out to us](#) for a quote. - ## Other Contributions Below are several ways anyone can help improve our ecosystem. diff --git a/docs/getting-started/troubleshooting.md b/docs/getting-started/technical-support.md similarity index 62% rename from docs/getting-started/troubleshooting.md rename to docs/getting-started/technical-support.md index b08579d8a8..6f93ffefef 100644 --- a/docs/getting-started/troubleshooting.md +++ b/docs/getting-started/technical-support.md @@ -1,6 +1,6 @@ -# Troubleshooting +# Technical Support -> Directus is offered completely free and open-source for anyone wishing to self-host the platform. +> Directus is offered completely free and open-source for anyone wishing to self-host the platform. There are many resources, both free and paid, to help you get up-and-running smoothly. ## Community Support @@ -12,6 +12,14 @@ Our [Discord](https://discord.gg/directus) community is another great way to get Premium support is included with our Enterprise Cloud service. On-Demand Cloud customers and On-Premise users interested in learning more about our monthly retainer agreements should contact us at [support@directus.io](mailto:support@directus.io). +## Commissioned Features + +If you need a specific feature added to Directus faster than the normal development timeline, [reach out to us](#) for a quote. Our parent agency will often help subsidize the cost of developing new features if they pass our [80/20 Rule](#) and can be merged into the core codebase. Other custom/proprietary development will be built bespoke within our robust extension system. + +## Expedited Fixes + +We triage all reported bugs based on priority and how long the fix is estimated to take. If you need a specific issue resolved sooner, [reach out to us](#) for a quote. + ## Frequently Asked Questions ### Does Directus handle deploying or migrating projects? @@ -24,10 +32,18 @@ Additionally, since Directus stores all of your data in pure SQL, you can use al 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 to non-structured doesn't make a lot of sense. We realize many users are interested in this feature, and will continue to explore its possibility. -### Why haven't you added X feature, or fixed Y issue yet? +### 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](#) 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](#) or [commissioning new features](#). You can also [submit a pull request](#) — after all, it is open-source! + +### Can you give an ETA for this feature/fix? + +If it is [sponsored work](#), then yes, delivery dates are part of our statement of work agreements. Otherwise, most likely not. This is open-source software, work is prioritized internally, and all timelines are subject to change. + +### 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](#), [sponsoring expedited fixes](#) or [commissioning new features](#). diff --git a/docs/guides/users-and-roles.md b/docs/guides/users-and-roles.md index 9b03dffdc9..09bf01d454 100644 --- a/docs/guides/users-and-roles.md +++ b/docs/guides/users-and-roles.md @@ -95,6 +95,10 @@ Directus possesses an extremely granular, yet easy to configure, permissions sys Every change made to the permissions of a role is saved automatically and instantly. ::: +:::warning Admin Roles +If a role is set to **Admin Access** then it is granted complete access to the platoform, and therefore the permission configuration field is disabled. +::: + 1. Navigate to **Settings > Roles & Permissions > [Role Name]** 2. Scroll to the **Permissions** section 3. **Click the icon** for the collection (row) and action (column) you want to set @@ -146,10 +150,59 @@ If you delete a role that still has users in it, those users will be given a `NU You must maintain at least one role/user with Admin Access so that you can still properly manage the project. ::: +:::warning Public Role +You can not delete the Public role, as it is part of the core platform. To disable it completely, simply turn off all Public access permissions. +::: + ## Creating a User -* Draft -* Invited -* Active -* Suspended -* Archived +1. Navigate to the **User Library** +2. Click the **Create User** action button in the header +3. Enter an **Email Address** +4. Optional: Complete the **other user form fields** (see [Configuring a User](#)) + +## Inviting a User + +1. Navigate to **Settings > Roles & Permissions > [Role Name]** +2. Scroll to the **Users in Role** field +3. Click the **Invite Users** button +4. Enter **one or more email addresses**, separated by commas, in the modal +5. Click **Invite** + +## Configuring a User + +1. Navigate to the **User Library** +2. Click on the user you wish to manage +3. Complete any of the [User Fields](/concepts/app-overview.md#user-detail) + +::: User Preferences +This section of the User Detail is only visible/editable by the current user, and admins. +::: + +### Status + +* **Draft** — An incomplete user; no App/API access +* **Invited** — Has a pending invite to the project; no App/API access until accepted +* **Active** — The only status that has proper access to the App and API +* **Suspended** — A user that has been temporarily disabled; no App/API access +* **Archived** — A soft-deleted user; no App/API access + +:::warning Admin Only +Only admins can adjust this field's value. +::: + +### Role + +Setting the user's role determines their access, permissions, and App presentation. You can adjust a user's role from the User Detail page, or from the _Users in Role_ field within **Settings > Roles & Permissions > [Role Name]**. + +:::warning Admin Only +Only admins can adjust this field's value. +::: + +### Token + +A user's token is an alternate way to [authenticate into the API](#) using a static string. When NULL, the token is disabled. When enabled, ensure that a secure string is used. + +:::warning Admin Only +Only admins can adjust this field's value. +:::