Commit Graph

135 Commits

Author SHA1 Message Date
Esther Agbaje
92a29c66ff Docs: Update Quickstart guide (#19082)
* docs: remove reference to free

* docs: remove 'free'

* fix: properly format guide
2023-07-06 20:19:43 +02:00
Kevin Lewis
67c008df37 Fixes the many broken docs redirects (#19026)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-06-29 13:49:38 +02:00
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
Esther Agbaje
d8727ba4f1 Split existing docs pages into Developer Docs and User Guide (#18951)
* docs: add getting started

* docs: add data model

* docs: add content module

* docs: add user management

* docs: add file library

* docs: add insights

* docs: add general settings

* docs: update user guide sidebar

* docs: update sidebar

* docs: add data studio app to dev docs sidebar

* docs: update content module

* docs: update directus cloud

* docs: update settings and content module

* docs: removed unused files in app

* chore: update links

* chore: update redirects

* docs: update redirects

* chore: update redirects

* chore: update urls

* docs: add active match

* Remove unused import

---------

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2023-06-26 15:03:33 -04:00
Ananta Krsna dasa
beba554a70 Fix collection name in quickstart.md (#18865)
* Update quickstart.md

Fix collection name.

* Update contributors.yml
2023-06-12 10:32:53 -04:00
Kevin Lewis
14696c1f1e Created new contribution pages for non-code contributions (#18820)
* Community

* Fixed copy in community page

* Sponsrship and advocacy

* Clarified 80/20 rule in support page

* Reworked contribs intro

* Contributing sidebar

* Remove backing directus page

* Translations updates

* Spell check

---------

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-06-06 12:19:47 -04:00
Kevin Lewis
74ae1c7a30 Added some cross links with main website (#18622)
* Added some cross links with main website

* Spellchecker
2023-05-16 14:40:20 +02:00
Drew Cain
5784a11f6f Update introduction.md (#18586)
* Update introduction.md

Fixed a grammatical error.

* Update contributors.yml

* Create nice-waves-deny.md

---------

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-05-12 17:06:17 -04:00
Matthew Rumery
bf10c943c8 Fix broken links in the documentation (#18377)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-02 10:03:32 +02:00
Rijk van Zanten
c723085902 Move docs to monorepo (#18052)
* Move docs to monorepo

* Tweaks
2023-04-04 18:23:58 -04:00
Rijk van Zanten
288e7d62b9 Move docs folder to dedicated repo (#14192)
* Move docs to https://github.com/directus/docs

* Update included docs
2022-06-29 13:47:45 -04:00
Brainslug
573b7709cc updated 404 links (#14152) 2022-06-28 09:34:06 -04:00
Eron Donevan Powell
972b6e25e7 fixed headers (#13967) 2022-06-17 13:32:48 -04:00
Eron Donevan Powell
3fa81b6b9c Docs config refactor (#13945)
* moved config-options.md to self-hosted

* added non-docs files that link to config-options

* moved SSO and fixed links

* moved upgrades-migrations into self-hosted

* moved filter-rules into reference docs and fixed broken links
2022-06-17 11:51:38 -04:00
Eron Donevan Powell
909970ae4b Docs: getting-started > architecture (#13258)
* initializing architecture doc

* first draft complete

* added media and improved copy

* final proofread

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-06-07 16:13:27 -04:00
Eron Donevan Powell
feea827685 Docs: getting-started > Introduction (#13055)
* created self-hosted section, moved installation guides, and re-edited first draft of the cloud quickstart guide

* refactored step 1 into two steps

* added media

* pre-mgmt submission proofread

* pulled down on wrong branch.
Revert "pre-mgmt submission proofread"
This reverts commit dfd678d083.

* first draft, halfway done

* first draft done

* added directus cloud section, first draft

* second draft, applied ben's desired edits

* moved resources out of intro and into separate page

* tiny tweaks

* heavily edited whats directus and tidied up lower sections

* link checked and proofedited with grammarly

* Update docs/getting-started/resources.md

* Update docs/getting-started/introduction.md

* Auto-format indentation

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-06-06 18:04:50 -04:00
Eron Donevan Powell
ae61822159 Docs: getting-started > backing-directus (#13122)
* backing-directus first draft

* more proofedit tweaks

* Rijk's edits added

* proof-read

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-06-06 11:21:32 -05:00
Eron Donevan Powell
4ee582405b updated docs links (#13670) 2022-06-01 14:55:55 -05:00
Eron Donevan Powell
31339558fd Quickstart fix (#13642)
* attempted fix 1

* fix 2

* trial 3

* testing
2022-05-31 13:15:28 -04:00
Eron Donevan Powell
8b39c49da3 Docs: Self-Hosted Section + Updated Quickstart Guide (#13005)
* created self-hosted section, moved installation guides, and re-edited first draft of the cloud quickstart guide

* refactored step 1 into two steps

* added media

* pre-mgmt submission proofread

* pulled down on wrong branch.
Revert "pre-mgmt submission proofread"
This reverts commit dfd678d083.

* proof-edited

* forgot to save before last comit

* fixed italic issue where I started with _ and ended with *

* tiny tweaks

* tiny tweak 2.0

* tiny tweak 4

* tiny tweak 5
2022-05-27 15:34:38 -05:00
Eron Donevan Powell
d46886d5ac Docs: re-edited user-directory + users-roles-permissions (#13424)
* re-edited user-directory and users-roles-permissions

* added Overview
2022-05-24 14:14:46 -04:00
Eron Donevan Powell
bc69297ac9 re-edited support doc (#13285) 2022-05-13 14:28:46 -04:00
Josh Soref
0b01923b0d Spelling (#13072) 2022-05-02 13:16:03 -04:00
Dmytro Cheglakov
325575d061 collections broken link fix (#13073) 2022-05-02 10:20:40 -04:00
Nicolas Ferrari
ad4537a221 Add alwaysdata to one-click installs (#12948) 2022-04-22 09:07:07 -04:00
Eron Donevan Powell
d2a311b20e Docs: Add Cloud Section (#11827)
* .gitignored package-lock.json that was created in the docs subfolder

* added cloud section structure

* set initial article outlines

* drafter accts-teams and shifted cloud docs in navbar

* added overview and projects draft

* added tiers and billing outline and basics

* added image to drafts and polished text. needs one more pass. added css for dngr on icons

* Added photos to overview

* minor tweak on images

* imrpoved copy and expanded CSS for inline icons

* expnaded CSS and, added images and finished copy on  acct-n-team

* more copy touchups

* Add divider between cloud and regular docs

* Fix capitalization of Github -> GitHub

* fixed overview images and tweaked copy

* recructured pages. Added writing tasks on appropriate pages

* added accts, options, and teams pages

* Overview intro (re)written)

* overview initial copy

* Overview first draft complete, links not added, media not added

* accounts initial draft complete, no media

* teams redrafted, projects and options partial refactoring

* projects redrafted

* finalized 5th page as glossay and reformatted

* refactored glossary structure

* glossary terms p1

* glossary copy 80% complete

* more glossary copy

* cloud glossary basic copy probably 100% done

* checked hyperlinks

* initial proofread on overview

* initial accounts proofread

* re-edited billing sections

* re-editec projects section and glossary

* re-edited teams

* small edits

* edited accounts, teams, projects

* re-edited glossary

* added screenshot-based media, still need graphic illustrations

* small, tiny edits

* fixed GitHub capitalization and other small type error

* applied ben's edit suggestions on overview, accounts, and 1/2 of projects

* applied the rest of Ben's edits

* added missing screenshots

* proof-read

* Fixed Team proejcts title

* tweaked copy after my ~10 questions to ben

* reworked 'projects > create a project' sections and 'glossary > data-processing' section

* final copy touchup, link check, still missing Rijk's review

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Eron Powell <eronpowell@Erons-MBP-2.local>
Co-authored-by: Eron Powell <eronpowell@Erons-MBP-2.hitronhub.home>
2022-04-13 14:15:00 -04:00
ian
68066eccb7 Remove UTC conversion from date, time and datetime fields (#10956)
* Remove UTC conversion from date, time and datetime fields

* Fix mysql / maria timestamps when not in UTC timezone

* Add sequential tests with node timezone change

* Increase connection attempt check

* Add error catching in tests flow setup

* Check for server connectivity

* Fix promises

* Fix timestamp inconsistencies

* Revert to previously used parseISO

* Ensure database and directus connection

* Add another timezone to test positive and negative GMT

* Set local server hostname to localhost

* Add tests for SQLite

* Use notNullable primary key

* Revert connection testing sleep duration

* Fix nested transactions on SQLite

* Increase MSSQL request timeout

* Add type override flag for SQLite

* Remove commented code

* Add type override flags for Oracle

* Updated test file path

* Increase test servers launch timeout

* Increase test servers launch timeout

* Update format of tests

* Fix typo

* Increase test timeout for CockroachDB

* Add type overrides when creating fields through collections service

* Remove time field type conversion for Oracle

* Update collections list in test

* Remove check for time field in Oracle

* Add missing continue...

* Remove database override

* Add note for SQLite

* Rename flags and extract shared util

* Abstract remaining DB specific checks

* Revert flags renaming except renaming of test files

* Use date helper to add field flag

* Move field date typecasting upstream

* Use timestamp helper for date-created and date-updated

* Fix tests

* Remove unused vars

* Add tests for date-created

* Increase connection attempt count

* Fix test for mariadb

* Increase allowable difference to account for delays

* Add tests for date-updated

* Fix tests again for mariadb

* Add date helpers post merge

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-04-06 16:15:22 -04:00
Nayan Patel
49d65124f5 Adds one click deploy with koyeb. (#12558) 2022-04-05 11:44:49 -04:00
Azri Kahar
3445114296 Remove outline prop from v-icons (#12092)
* remove unused outline prop from icons

* update docs
2022-03-11 09:48:42 -05:00
Rijk van Zanten
eec21d8d9a Add "items.sort" event (#11954)
* Adds the 'sort_updated' event emit after items are sorted

Signed-off-by: Mihovil Ilakovac <mihovil.ilakovac@gmail.com>

* Updates the event name to 'sort_update'. Docs.

Signed-off-by: Mihovil Ilakovac <mihovil.ilakovac@gmail.com>

* Updates the event name to `sort`

* Add item/to to hook, fix docs

Co-authored-by: Mihovil Ilakovac <mihovil.ilakovac@gmail.com>
2022-03-04 19:58:47 -05:00
Dominic Marcelino
45344284bf Update plesk docs: Create / apply snapshots (#11819)
* Update plesk docs: Create / apply snapshots

Add a script wrapper to support snapshots on plesk servers. 

Not sure if the example script should stay here or be added next to the other wrapper on the cli-page.

* Update docs/getting-started/installation/plesk.md

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-02-23 16:32:41 -05:00
Eron Donevan Powell
1bc7da6967 Docs: update CSS and pics (#11634)
* .gitignored package-lock.json that was created in the docs subfolder

* tweaked color names, except the ones in in vue files

* converted terminal screencaps into markdown

* updated images in 'Content'

* updated user-directory images

* updated media in file-library

* moved picsto cloud in reference>files

* updated images in config > datamodels > relationships

* updated primary colors in app-overview.svg

* updated insights images

* swapped quickstart-guide media and touched up copy

* Update last colors, remove linting from docs temporarily

* Fix theme color

* Update homepage header image

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-02-21 15:32:09 -05:00
rijkvanzanten
247b4f0564 Update supported DBs 2022-02-18 18:59:17 -05:00
Abdón Rodríguez Davila
3de9bc1ada Update rollup-plugin-styles to v4 (#11689)
* Update rollup-plugin-styles to v4

* Update Rollup packages
2022-02-18 11:25:50 -05:00
Néstor Sabater
a00ad5aaa2 fix/removed typo: duplicated word (#11704) 2022-02-18 10:23:11 -05:00
Dominic Marcelino
9a4ed5fcfb Update docs: plesk document_root (#11687)
* Update docs: plesk document_root

The domain’s document root directory must be a subdirectory of the application root directory.

See Plesk documentation: https://docs.plesk.com/en-US/obsidian/administrator-guide/website-management/nodejs-support.76652/

* update image
2022-02-17 10:04:00 -05:00
Yann Coleu
15b9f57ded minor typo in google cloud documentation (#11583)
* minor gcp typo

* fix typo container
2022-02-11 19:14:32 +08:00
ijpatricio
646a4f8bd1 Fixes reference to documentation about environment variables. (#11488) 2022-02-08 07:03:05 +08:00
Ismail D
36ebe275e5 Fix GCP Kubernetes Engine typo (#11485) 2022-02-08 07:01:11 +08:00
keesvanbemmel
cf5cebef33 Added / amended env vars in docs example for Google Cloud Logging (#11336)
* Added missing data field to sessions yaml

* rebased sessions.yaml

* Added complete GCP logging env vars to example

* Revert "Added complete GCP logging env vars to example"

This reverts commit eb9f95556b.

* Added correct env vars for GCP cloud logging
2022-02-03 17:55:08 -05:00
Eron Donevan Powell
8daed9c41b Docs: The Insights Module (#11175)
* Added insights docs draft and images

* updated insights draft doc images, grammar, links and beyond

* adjusted text and formatting in several areas

* minor language tweak

* removed local images. refromatted ::: on tips

* spaced ::: before and after

* Minor editing tweaks to headers and copy

* added link to explain panels in 'how it works'

* Added link on time sseries 'group aggregation' to the 'more on aggregate functions' section.

* Add standardized style for images/videos

* fixed naming on mp4 videos

* Tweak styles a bit

* Remove old nav link

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-01-29 17:41:57 +00:00
Nitwel
1e37429d7e Make docs a lot more fancy. (#10898)
* add images to content, file-library and user-directory pages of docs

* turn buttons from png to inline html and replace gifs with mp4s

* add a ton of icons everywhere

* add icons to presets & bookmarks

* add icons to webhooks

* add icons and clean up quickstart guide

* clean up icons and videos

* Move video assets to CDN

* Use updated video file naming system

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-01-29 12:25:54 -05:00
Josh Dean
7497676794 Documentation Polishing (#11267)
* glossary.md small typo

Documentation

* update docs glossary.md type

Documentation

* docs config-options.md typo

Documentation

* Update relationships.md

Documentation small typo

* Update relationships.md

documentation, small typo

* Update relationships.md

Documentation typo. I believe line 261 is an alias for the junction table.

* Update relationships.md

Docs Typo

* Update relationships.md

Docs Typos

* Update data-model.md

Docs Typo.

* Update sso.md

docs typo

* Update introduction.md

docs typo

* Update query.md

example isn't "on right" when read on mobile.

* Update introduction.md

Docs - confusing phrasing. Hope this helps.

* Update sdk.md

Unfinished sentence removed. Likely a copy paste from a discussion of instance prefixes.

* Update activity.md

Docs extra word
2022-01-25 13:06:10 -05:00
rijkvanzanten
f2552222e4 Tweak note on mysql 2022-01-24 19:51:19 -05:00
keesvanbemmel
b13afc7445 Installation guide for Google Cloud Platform (#10936)
* Added missing data field to sessions yaml

* rebased sessions.yaml

* Initial commit

* Initial complete guide

* Added LOGGER_LEVELS addition

* Removed redundant VPC cost aspect

* Added login details after deployment

* Minor textual changes

* Made requested changes by @azrikahar

* Changed github repo link from keesvanbemmel to gcp-example in community

* Added Run on Google Cloud button to readme.
2022-01-12 10:35:57 -05:00
Adam Miedema
6fd42bdc38 Add link to Cleavr deployment guide (#10761)
Added a link to Cleavr's instructions for deploying Directus to a VPS. Or, if you prefer to have a guide on docs.directus.io, let me know and would be happy to do so.
2021-12-30 15:03:53 -05:00
Azri Kahar
f09862e865 clarify "folder" collections & references in docs (#10408) 2021-12-09 18:17:35 -05:00
Azri Kahar
f071a4a933 add custom panel extensions template & docs (#10386) 2021-12-08 11:13:10 -05:00
Nicola Krumschmidt
90b59d89e0 Extension docs updates (#8611)
* Rename API Endpoints docs to Endpoints to align with Hooks

* Add a Creating Extensions page to the docs

* Update individual extension docs pages

* Apply latest changes to hook docs

* Move available events to a dedicated section in hook docs
2021-12-06 13:08:31 -05:00
Azri Kahar
19cbe896b4 docs updates on file library, content sidebar etc (#10334) 2021-12-06 09:36:00 -05:00