Commit Graph

23 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
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
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
4ee582405b updated docs links (#13670) 2022-06-01 14:55:55 -05:00
Eron Donevan Powell
bc69297ac9 re-edited support doc (#13285) 2022-05-13 14:28:46 -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
Ben Haynes
6ec467e1dc Fixes for docs links 2021-10-29 12:32:02 -04: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
Rijk van Zanten
5f7dce54e2 Use stricter Vue eslint setting (#6833) 2021-07-15 13:49:59 -04:00
Rijk van Zanten
352f6056ae Update support.md 2021-06-26 12:01:59 -04:00
Pascal Jufer
1dd6da2aa9 Fix OpenAPI specs (#6179)
* Unique operationIds for users/me methods

* Fix specs for /users/invite/accept and rename files

* Add missing parameters definition for /utils/sort

* Add .yaml to lint-staged and format cmd

* Format .yaml files

* Fix small linting issue

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-06-14 10:38:43 -04:00
Ben Haynes
749ca7effb Add Troubleshooting 2021-05-17 17:24:33 -04:00
YannickMol
983d667343 Update links in docs (#4091) 2021-02-16 13:34:16 -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
Philleep Florence
7a7026a3ca 1128.03 - Fix Broken Links . Update Installation and Contribution Guides 2021-01-15 16:11:53 -05:00
rijkvanzanten
f8977a885d Update docs once more 2020-12-01 18:01:00 -05:00
rijkvanzanten
41a3ffcd00 Format md 2020-12-01 16:52:51 -05:00
rijkvanzanten
3a6e209f97 Update docs 2020-12-01 15:51:52 -05:00
Ben Haynes
17af0101f1 Nest sponsored work 2020-10-08 11:26:01 -04:00
Ben Haynes
1535db7646 Docs updates 2020-10-06 16:19:36 -04:00