mirror of https://github.com/directus/directus.git synced 2026-01-15 02:58:11 -05:00

Files

Bevis Halsey-Perry 0c54f5a9ef Introduce SnippetToggler and New SDK Reference (#19110 )

* items semi complete

* updated items page to use snippet toggler and migrated endpoint docs to use it

* updated files page to use snippet toggler and migrated REST and GraphQL endpoint docs to it

* updated activity page to use snippet toggler and migrated REST and GraphQL endpoint doc to it

* updated collections page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* updated dashboards page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated extensions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated fields page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated flows page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated folders page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated notifications page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated operations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated panels page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated permissions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated presets page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated relations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated revisions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated roles page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Made headlines consistant with the rest of the doc pages

* Updated server page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated settings page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated shares page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated translations page to use snippet togglers and migrated REST endpoint docs to them

* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated utilities page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated webhooks page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated authentication page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* Updated Global Parameters page to use snippet togglers where there are adjacent REST and GraphQL Examples

* Added SDK code snippets to items page and made generic variables consistant

* Added SDK code snippets to files  page and made generic variables consistant

* Few lang changes for files page

* Added SDK code snippets to activity page and made generic variables consistant

* Added SDK code snippets to collections page and made generic variables consistant

* Added SDK code snippets to dashboards page and made generic variables consistant

* removed query word from query parameter objects

* Added SDK code snippets to fields page and made generic variables consistant

* SnippetToggler border

* Used dynamic border color for snippettoggler heading

* Spacing top and bottom of snippet toggler in docs

* Removed extra HRs

* Remove manual TOC in query reference

* Small code styling change in items page

* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them

* dashboards fixed up property names

* Small copy update on extensions page

* Updated keys in delete mult notifications REST

* Updated keys in operations

* Update keys in panel delete many

* Update keys in permissions

* Added quotes around generic example ID strings

* Added code formatting to final example in share public info

* Format files

* Refined sidebar

* Insert newline before ending template tags

* Fixed extra closing tags, causing an error, un users ref

* Text Formatting Users

* Put GQL related notes inside toggler

* Added SDK code snippets to flows page and made generic variables consistant

* Added SDK code snippets to folder page and made generic variables consistant

* fixing whitepsace for flows and folders page

* Consistent newlines in SnippetToggler usages

* Run prettier

* Fix 'alwaysDark' definition

* Home page snippet toggler style fixes

* Fix snippet toggler lang hover color in light mode

* Introduce different code theme for light mode

* Added SDK code snippets to notifications page and made generic variables consistant

* Switch to 'material-theme-lighter'

* Format file

* Fix tip

* Fix tip in sdk ref

* Consistent spacing for custom containers

* Added SDK code snippets to operations page and made generic variables consistant

* Lint & format code blocks

* Lint & format operations

* Added SDK code snippets to panels page and made generic variables consistant

* Added SDK code snippets to permissions page and made generic variables consistant

* Added SDK code snippets to presets page and made generic variables consistant

* Added SDK code snippets to relations page and made generic variables consistant

* Added SDK code snippets to revisions page and made generic variables consistant

* Added SDK code snippets to roles page and made generic variables consistant

* Added SDK code snippets to server page and made generic variables consistant

* Added SDK code snippets to settings page and made generic variables consistant

* app_url -> directus_project_url

* Omitted auth details in delete multiple files

* Added quotes to values in roles

* Upload a file snippets

* Pluralization for upload/import files

* More files functions typos

* Added SDK code snippets to shares page (still missing createShare(s) as endpoint not functioning currently) and made generic variables consistant

* Added SDK code snippets to translations page (missing delete endponts because not working) and made generic variables consistant

* Added SDK code snippets to users page and made generic variables consistant

* Added SDK code snippets to webhooks page and made generic variables consistant

* Added SDK code snippets to utilites page (except cleaning cache, will be tested and added in later commit) and made generic variables consistant

* Added SDK code snippets to auth page (not login, refresh, and logout though due to errors)

* Added SDK code snippets for utilsExport and clearCache

* added github username be7DOTis to contributors

* Omit auth commands in updateComment

* utilsImport

* rename app_url generic value

* changed instances of updated*operation* to update*Operation*

* missed some 'updated' changse

* Added SDK Snippets to Query Parameters page

* Add section on file security

* added create(s)Shares SDK snippet to shares page

* added console.log to create snippets

* Added delete(s)Webhook SDK snippet to webhooks page

* Added SDK snippets to extensions page

* Added create/updateSingleton section to items page

* Links in files security

* Added SDK Snippets to Schema page

* Added GQL Generic examples to snippet togglers and removed snippet toggler from Login Using SSO Providers

* Added create(s)Presets SDK Snippets to presets page

* replaced fields query in generics snippets for a more generic

* replaced fields query in generics snippets for a more generic

* Use storage value only if valid choice

* Sync snippet togglers across page

* Update docs/reference/system/activity.md

* Update docs/reference/system/activity.md

* Update docs/reference/system/extensions.md

* Update docs/reference/system/revisions.md

* Update docs/reference/system/settings.md

* Update docs/reference/system/revisions.md

* Update docs/reference/system/settings.md

* Update docs/reference/system/activity.md

* Update docs/reference/system/roles.md

* Update docs/reference/system/roles.md

* Update docs/reference/system/roles.md

* Update docs/reference/system/roles.md

* Update docs/reference/system/schema.md

* Update docs/reference/system/server.md

* Update docs/reference/system/shares.md

* Replace all directus_project_url placeholders

* Revert "Sync snippet togglers across page"

This reverts commit 8b36f0d778.

* Update docs/reference/system/shares.md

* Update docs/reference/system/webhooks.md

* Clarify singleton section

* Consistent newlines between SnippetToggler templates

* Format files

* Remove console.log(result) statements from snippet

* Add examples for shares & users

Co-authored-by: Brainslug <tim@brainslug.nl>

* Fix hash GraphQL example

* Clarify update singleton section

* Add auth examples

Co-authored-by: Brainslug <tim@brainslug.nl>

* Final run on consistent newlines between SnippetToggler

* Switch to github themes

* The "Last One"

Co-authored-by: Brainslug <tim@brainslug.nl>

* The "Big One"

* Fix dead links

---------

Co-authored-by: Bevis Halsey-Perry <hi@be7.is>
Co-authored-by: Kevin Lewis <kvn@lws.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Brainslug <tim@brainslug.nl>

2023-07-25 17:30:37 -04:00

6.4 KiB

Raw Blame History

description, readTime

description	readTime
Cloud Projects are individual instances of Directus, managed within a Team.	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 it runs on, and all of its data and file assets. All Cloud Projects include all Cloud Exclusives. See Support Options to find out how to get help on your Project.

There are two different Project tiers on Directus Cloud: Standard and Enterprise. A side-by-side comparison of what's included in each tier can be found on the Pricing page.

See the 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. 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 edit update and launch access the Project. To view a Team's Projects:

Open the Team Menu in the Dashboard Header and select the desired Team.
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 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 — United States, East, Europe, Frankfurt or Asia Pacific, Singapore.

To create a Standard Project:

Open the Team Menu in the Dashboard Header and select the desired Team.
Click "Projects".
Click the Team you wish to create a Project under.
Click "Create Project".
Set the Project Name as desired.
Select the Standard tier.
Set the configuration options as desired.
Click "Proceed to Checkout". You will be taken to a checkout page.
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

Enterprise tier offers power and scale to meet any Project's needs and offers 19 Datacenter regions, upgraded support options, and much more.

::: tip Ready to go Enterprise?

Contact Sales

:::

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:

Open the Team Menu in the Dashboard Header and click the desired Team.
Click "Projects" to enter the Projects page.
From here, there are two ways to access a Project:

From the Projects Page

Click launch on the desired Project. Your Project login page will open in a new tab.

From Project Monitor Page

Click a Project to enter its Project Monitor page.
Click "Open Project". Your Project login page will open in a new tab.

Monitor a Project

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:

Open the Team Menu in the Dashboard Header and click the desired Team.
Click "Projects" to enter the Projects page.
Click the Project to enter the Project Monitor page.

Manage a Standard Project

On Standard Projects, it's possible to change the Project Name.

Open the Team Menu in the Dashboard Header and click the desired Team.
Click "Projects" to enter the Projects page.
Click the Project to enter the Project Monitor page.
Click "Edit" to enter the Project Details page.
Make changes as desired.
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.