Commit Graph

231 Commits

Author SHA1 Message Date
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
58f37fa4d3 fixes 404 links in docs (#13995) 2022-06-20 10:19:21 -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
Rijk van Zanten
3b2245918d Allow setting a custom filename in the /assets endpoint for SEO (#13907)
* Allow an optional custom filename in the assets route

* Document optional assets endpoint route

* Update docs/reference/files.md
2022-06-15 12:32:36 -04:00
Azri Kahar
c4ee1c1747 Docs & Specs update for Data Flows (#13358)
* Add flows & operations API reference

* remove webhooks from docs

* remove webhooks from spec

* add flows specs

* add operations specs

* fix path

* actual complete fix

* Revert "remove webhooks from docs"

This reverts commit fae1103d61.

* Revert "remove webhooks from spec"

This reverts commit ec7a836cd3.

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-06-07 16:25:38 -04:00
Eron Donevan Powell
4ee582405b updated docs links (#13670) 2022-06-01 14:55:55 -05:00
Rijk van Zanten
f9a3413586 Update items.md 2022-05-27 11:28:59 -04:00
Louis
447de05051 last_page type was date instead of str (#13577)
* `last_page` type was `date` instead of `str`

* Update docs/reference/system/users.md

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-05-26 12:06:48 -04: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
bf752856d0 how to work with nested data (#13489) 2022-05-23 14:17:51 -04:00
Jesper
b2d8b2319a GraphQL count aggregation for all fields and * (#11871)
* GraphQL count aggregation for all fields

Fixes #11792

* Rename countRows to countAll

* moved function to new apply-query folder

Co-authored-by: jaycammarano <jay.cammarano@gmail.com>
2022-05-18 15:34:12 +00:00
Josh Soref
0b01923b0d Spelling (#13072) 2022-05-02 13:16:03 -04:00
Azri Kahar
7f8eb2d926 fix naming & typo in CLI docs (#13037) 2022-04-28 05:51:23 +00:00
rijkvanzanten
5cce44fa05 Remove deadlink 2022-04-18 19:12:07 -04:00
Lukas Breitstadt
09d9b4b323 Await when token is refreshing & reinstate msRefreshBeforeExpires flag (#12649) 2022-04-12 07:52:33 -04:00
rijkvanzanten
029a66ef31 Add note on SDK requestOptions usage
Fixes #12628
2022-04-11 12:31:34 -04:00
rijkvanzanten
7c36fa42a6 Add missing reference for user object
Fixes #12669
2022-04-11 09:36:52 -04:00
Azri Kahar
d023b36838 Add import file method to SDK (#12575) 2022-04-05 10:39:29 -04:00
Azri Kahar
67c37ae11c Add count function in docs (#12576)
* Add `count` function in docs

* Rename relational to array functions

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-04-05 09:43:51 -04:00
Azri Kahar
d0b0818cca Return 401 status code for expired tokens (#12281)
* Refresh token when it's expired & retry request

* move refresh token interceptor in autoRefresh flag

* add TOKEN_EXPIRED exception

* update interceptor condition & fix autoRefreshJob

* update docs

* revert auth drivers changes

* remove unused imports

* undo sdk auth refresh changes
2022-04-04 09:23:28 -04:00
Jake Cattrall
d24dacd075 Use date (epoch) compare workflow instead of timer to refresh token in SDK (#12399)
* use date compare workflow instead of timer

* convert milliseconds to seconds

* add missing references to auth_expired_at key

* correct calculation and presume getTime returns milliseconds

* resolve issue with static tokens

* prevents token refresh before everything else is initialized

* remove timer based authentication tests

Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
2022-04-01 09:31:11 -04:00
Rijk van Zanten
1c3e94d830 Add new export experience (#12201)
* Use script setup

* Start on export dialog

* Use new system field interface, replace limit with numeric input

* Set placeholder

* Add sort config

* Use folder picker, correct layoutQuery use

* Add local download button

* Allow writing exports to file

* Add notification after export

* Fix sort config, use new export endpoint

* Setup notification hints

* Add information notice

* Fix local limit, cancel button

* Add (basic) docs for export functionality

* Fix json export file format

* Implement xml batch stitching

* Resolve review points
2022-03-17 15:43:45 -04:00
Spencer Jones
469f6400b7 add --dry-run flag to schema apply CLI command (#12006)
Co-authored-by: Spencer Jones <sjones@morningconsult.com>
2022-03-07 17:52:02 +00: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
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
Dominic Marcelino
c148e1d441 CLI docs Tip: Create date based snapshots (#11698)
A small custom script to create multiple snapshots organized by date. Can be used e.g on a server where git is not available for snapshot versionizing.
2022-02-18 10:28:31 -05:00
José Varela
de5b34d87b SDK: split readMany into itself and readByQuery (#11204)
* split readMany into self and readByQuery

* add tests

* run tests only on `test` folder

* fix docs

* fix in `cli`
2022-02-16 09:52:42 -05:00
Stephan Schmitz
64dfc04a86 Fix snapshot options documentation error (#11540)
Closes #11537
2022-02-09 18:30:10 +08:00
Stephan Schmitz
f7507dc906 Document --yes option for creating schema snapshots (#11366) 2022-01-31 14:30:28 -05:00
Stephan Schmitz
fab37abb60 Document --yes option to skip manual confirmation when applying a schema snapshot (#11356)
There's an undocumented `--yes` option, which is a rather valuable information and should be documented. For example, when you run the migration step in a CI/CD workflow, you don't want the manual prompt.
2022-01-31 11:10:04 -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
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
Brainslug
595eb696ea Remove reference to readByQuery (#11188)
Updated order of examples and aligned titles to match
Added missing updateOne example
2022-01-20 15:24:40 -05:00
José Varela
f32f8eb19f add alert about nested alias (#11108) 2022-01-17 13:52:15 -05:00
Azri Kahar
74bb4a7c9a Add Unsupported Media Type Exception (#11096)
* add unsuported media type exception

* throw error when not multipart/form-data

* use unsupportedMediaType when checking import file

* add `UNSUPPORTED_MEDIA_TYPE` to Error Codes docs
2022-01-17 10:09:26 -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
Azri Kahar
ed70219ecb fix Read By Query example code (#10943) 2022-01-10 04:15:26 +00:00
José Varela
fd885b14ea Docs(SDK): use top level await upload (#10827) 2022-01-03 15:04:07 +00:00
Azri Kahar
e9445df387 update docs on descriptor in project settings (#10813) 2022-01-03 09:56:50 -05:00
Azri Kahar
f4720f6ed2 minor fix for closing tag in file upload example (#10816) 2022-01-03 06:42:41 +00:00
José Varela
865a69a359 Add example of upload file on SDK (#10787) 2021-12-31 12:06:04 +00:00
Wryn (yage) Wagner
b9636e3243 [#10500] update_users_me to graphql; added documentation for users/me update for both REST and graphql api (#10622)
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-12-30 20:11:48 -05:00
Azri Kahar
d0134247c2 update cli docs (#10543) 2021-12-16 09:20:43 -05:00
Jay Cammarano
00a838f020 Docs for testing the API (#10275)
* mock-knex

* test on the migrations run started.

* test passing for run.up()

* reorganize /tests/ to allow integration tests

* e2e setup changes

* e2e jest.config moved

* e2e paths fixed, integration config

* add nonadmin role and user seed+migration

* auth/login w/ documentation (docs will be moved)

* update user seed

* add postgres10 to the ci?

* argon2 saves the day

* items tests passing with postgres10 support

* removed comments

* move generateHash out of directus_users

Co-authored-by: Jay Cammarano <jaycammarano@gmail.com>
2021-12-10 14:58:51 -05:00
Azri Kahar
f09862e865 clarify "folder" collections & references in docs (#10408) 2021-12-09 18:17:35 -05:00
Dorian Zedler
94e53212b4 Implement AUTH_DISABLE_DEFAULT config option (#9322)
* Implement AUTH_DISABLE_DEFAULT config option

* Disable default auth rute if set to disabled

* Add disableDefault to API docs

* Update app/src/routes/login/login.vue

Co-authored-by: Aiden Foxx <aiden.foxx.mail@gmail.com>

* Remove watch block

* Remove useless variable

* Don't import watch

Co-authored-by: Aiden Foxx <aiden.foxx.mail@gmail.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-12-03 14:13:50 -05:00
Rijk van Zanten
d2e228f30b Add missing docs for collection hierarchy and auth-refresh mode (#10278)
* Add docs on collection hierarchy

Fixes #10265

* Add missing docs on "mode" flag for auth refresh

Fixes #10007

* Fix wrong quotes in gql
2021-12-03 11:25:57 -05:00
Łukasz Szcześniak
e17048e653 Remove runMigrations from database install (#9911) (#10003)
* Remove `runMigrations` from `database install` (#9911)

* Fix typo (#9911)

* Remove unnecessary import (#9911)
2021-12-02 16:05:54 -05:00
Joe Innes
4d4c7de74d Add a tip explaining HTTP Only cookies issue (#9574)
* Add a tip explaining HTTP Only cookies issue

Watching the Discord, I see this issue coming up fairly frequently, when someone is developing a front end app locally, and their app suddenly stops working with the message

> Error: "refresh_token" is required in either the JSON payload or Cookie

This tip explains the cause of the issue, and two different workarounds.

* use relative link

Co-authored-by: Azri Kahar <azrikahar@outlook.com>
2021-12-01 17:21:01 -05:00