mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00

Files

Connor 92621429ee Linting and Formatting Upgrade (#18892 )

* add docs to eslint

* update prettier ignore

* fix vitepress linting

* eslint ignore fixes

* prettier run

* update prettier ignore

* fix formatting

* enable linting of markdown files

* revert format command change

* fix irregular whitespace

* update dictionary

* (Changelog) Create four-boxes-shake.md

* Rework ESLint / Prettier setup

- Disable js/ts/vue files for Prettier to ensure linting/formatting is
  only happening via ESLint
- Rework formatting of code blocks in md files
  - Disable formatting of code blocks in md files under '/docs' by Prettier
  - Instead use "eslint-plugin-markdown" to format & __lint__ js*/ts*/vue such code blocks
  - Replace unmaintained "eslint-plugin-md" plugin by official "eslint-plugin-markdown" plugin
  - I'll check whether we can use this to format other code blocks
    (json, html, ...) as well
- Restructure, clean-up and apply some fixes to the ESLint config
  (Note: Not ready for flat config yet since not supported by
  vscode-eslint)
- Enable cache for ESLint / Prettier in scripts
- Clean-up ignore file
  - Explicit folder declaration (.../)
  - Don't ignore all 'extensions' folders in ESLint (only
    '/api/extensions/')
  - Enable formatting in '/.github' folder

* Fix all formatting issues with Prettier

* Update md files under /docs/.typedocs

* Fix lint issues in vue/js files

* ESLint / Prettier config revision v2

Enable Prettier for md code blocks, but only as warnings since it can
get into the way with Vitepress md extensions like '[!code ...]'
comments

* Remove prettier-ignore comments

* Make spellchecker happy

* Remove changeset

* Revert lint setup for code blocks

There are many cases in the docs where linting / formatting of code
blocks doesn't make
sense:
- Code block is only an excerpt - linter fails
- Code block contains special comments (e.g. markdown extensions) which
  needs to remain at the same place - formatting would break it
- ...

* Apply lint issues / formatting from temp lint setup

* Run formatter

* Fix merge failure

* Simplify & modernize ESLint / Prettier setup

No longer run Prettier via ESLint. Nowadays, this is the recommended
setup. There's no real need to run it this way, it's just an additional
layer.

Add VS Code settings to make the work with the new setup easier.

* Remove unused eslint disable directives

* Make editorconfig more useful

* Fix formatting issues reported by editorconfig

* Format files with Prettier

* Enable formatting of source translations file

* Format source translations file

* Remove unnecessary console error

* Remove unnecessary line

* Only ignore md files under .changeset

* Add CI reporter for Prettier

* Fail job on wrongly formatted files

* Fix format

* Test Prettier action on changed/added file

* Use simple CI format check for now & no cache

* Revert "Test Prettier action on changed/added file"

This reverts commit 4f7d8826ad.

* Introduce code blocks check for docs

* Fix code block issues

* Ignore auto-generated packages dir

* Fix comment position

* Also lint `/app/.storybook`

* Reformat modified files

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>

2023-06-29 11:54:01 +02: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.