Commit Graph

10 Commits

Author SHA1 Message Date
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
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
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
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
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
José Varela
f32f8eb19f add alert about nested alias (#11108) 2022-01-17 13:52:15 -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
Ben Haynes
1b87e4555f Docs structure (#9071)
* WIP

* updates

* docs updates

* structure

* big structure update

* docs module icon change

* in-app docs nav

* more content and structure changes

* Remove redundant

* Fix docs build in app

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-10-25 21:19:23 -04:00