Commit Graph

25 Commits

Author SHA1 Message Date
Esther Agbaje
3b3372f44a docs: add self-hosting (#19111) 2023-07-10 14:20:08 +02:00
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
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
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
Dmytro Cheglakov
325575d061 collections broken link fix (#13073) 2022-05-02 10:20:40 -04: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
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
Azri Kahar
19cbe896b4 docs updates on file library, content sidebar etc (#10334) 2021-12-06 09:36:00 -05:00
Jay Cammarano
29b0fb9b8b Fixes broken links in docs (#9172)
* first half of broken links fixed

* next chunk of broken links resolved

* next chunk of urls

* last chunk of links

* one more

* filter rules

* homepage links

* removed localhost

* filter rules for query

* updated links

* relationships link

* changed links from references to glossary
2021-10-27 17:22:43 -04:00
Nicola Krumschmidt
8f54c8d40d Recommend npm init directus-project to create a project (#8590)
This slightly nicer syntax was introduced back in "npm@6.1.0".
"node@12.20.0", which is the minimum version we require, ships with "npm@6.14.8".
"npm@6" versions below "6.1.0" were never actually shipped with any node version, so it should be very safe to use this syntax.
2021-10-06 09:56:48 -04:00
Geert Ijewski
02ec28f5f3 fix link (#6339) 2021-06-17 09:19:30 -04:00
rijkvanzanten
fb5c9068bc List updated min requirement 2021-03-04 14:14:31 -05:00
YannickMol
983d667343 Update links in docs (#4091) 2021-02-16 13:34:16 -05:00
Luis Donis
08aa037d7a Fix link to roles management (#3957) 2021-02-07 08:21:50 -05:00
Rijk van Zanten
817ccf3620 Overhaul docs (#3951)
* Add Quickstart Guide

* Update installation

* Remove unused files

* Update support/backing

* Tweaks in concepts

* Setup file structure for API reference 2.0

* Setup page layout for reference

* Add clean-urls plugin

* getting started updates

* Finish authentication rest

* getting started updates

* Render stylus in 2 spaces

* Various

* Various

* Finish activity docs

* Add collections reference

* Add extension reference

* concepts updates

* Fields/tweaks

* Add files doc

* Add revisions

* concepts docs

* More api reference

* Finish rest api reference (finally)

* initial concepts

* More things

* Add assets api ref

* Move sections from file to assets

* Add environment variables

* contributing docs

* Add field transforms page

* Left align table headers

* concept links

* Add API config

* Fix mobile nav

* Add migrating a project

* doc link fixes

Co-authored-by: Ben Haynes <ben@rngr.org>
2021-02-05 18:51:54 -05:00
Rijk van Zanten
5450de0351 Update Docs (#3905)
* Allow formatted value display for numbers

* Move the docs website into monorepo

* Fix build

* Tweak docs build setup

* Fix tips, pull in images

* Add syntax highlighting to docs

* Restructure nav, add divider

* Fix tips formatting

* Add prettier config

* Add editorconfig
2021-02-02 11:55:04 -05:00
rijkvanzanten
41a3ffcd00 Format md 2020-12-01 16:52:51 -05:00
Ben Haynes
09572cc3e2 Initial Docs structure 2020-09-16 10:25:00 -04:00