38 Commits

Author SHA1 Message Date
Connor
b67c4cd2e2 Contributor Docs Improvements Round 1 (#18545)
* Move Debug Docs from Wiki to Docs

* Add Copyright License Agreement to Docs

* Start Reformat0 of Codebase Overview

* Add Package Documentation to Codebase Overview

* Add Link to Blackbox Folder

* Add Changesets to Pull Request Process

* Add Component Library Tips

* Fix Spelling

* Fix dictionary

* Create thick-glasses-bake.md

---------

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-05-12 09:29:00 -04:00
ian
922cb83dce Reword eg to fix spellchecker (#18567) 2023-05-11 17:57:02 -04:00
Rijk van Zanten
5cf2c0d724 Add feature request workflow to contributing guidelines (#18528)
* Point to docs hosted C&C

* Point to hosted contributing guidelines

* Remove outdated information

This is incorrect, so does more harm than good imo

* Update contributing guidelines to add feature requests flow

* Lil nicer to read

* Add missing words to dict

* Update docs/contributing/code-of-conduct.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/introduction.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/pull-request-process.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/feature-request-process.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/feature-request-process.md

Co-authored-by: Kevin Lewis <kvn@lws.io>

* Update docs/contributing/pull-request-process.md

Co-authored-by: Kevin Lewis <kvn@lws.io>

* Fix license/version for new packages (#18536)

* Standardize TSConfig use (#18538)

* Use tsconfig.prod.json in packages

* Use prod tsconfig in api

* Install node types in storage

* Use vitest run instead of --watch=false (#18540)

* Remove local file

* Revert "Use vitest run instead of --watch=false (#18540)" (#18542)

This reverts commit 97f0af669e.

* Setup boilerplate for data (#18541)

* Setup boilerplate for data

* Update readme

* Fix directory link

* Final tweaks from Ben

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Kevin Lewis <kvn@lws.io>
2023-05-10 15:22:57 -04:00
Matthew Rumery
8728c9ed13 Enhance local development setup instructions (#18133)
* docs: add local development setup instructions

* docs: move and simplify docs, and add reference in contributing

* docs: remove m1 reference to non-office docker image

* Update readme.md

* Remove note about volta since we've removed it from the package.json

* Adjust notes

* Quick update of the commands

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-04-11 17:09:29 -04: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
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
4ee582405b updated docs links (#13670) 2022-06-01 14:55:55 -05:00
sxsws
63ed54e986 removing remaining links to example.env (#13656) 2022-06-01 10:46:23 -04:00
Jay Cammarano
154b919906 Update Running Locally docs to have correct paths in commands (#11038)
* removed /tests/ from the path since it says to be in tests

* Updated to remove the directory line instead of the tests path

* removed leading /

Co-authored-by: Jay Cammarano <jaycammarano@gmail.com>
2022-01-13 17:32:41 -05:00
Oreille
7e10d2017e End-to-end tests refactor (#10968)
* Refactor e2e tests

* Only install root dependencies for lint step

* Fix dumbest error ever

* Pass process.env too to spawned subprocess

* Suppress npm package installation prompt

* Improve error handling

* Add new compose file for tests

* Avoid port conflict with remoted

* Update docker-compose.yml

* Add test docs

* Use current branch workflow files and simplify skips

* Fix workflow file

* Fix workflow file

* Try adding `.yml` extension to allow reference in `uses`

* Place workflow file in folders to allow reference in `uses`

* Requires more work than expected, reverting

* Update docs to use correct compose file

* Remove comment / unused code

* Run tests from main

Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Jay Cammarano <jay.cammarano@gmail.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-01-13 16:32:45 -05:00
Azri Kahar
19cbe896b4 docs updates on file library, content sidebar etc (#10334) 2021-12-06 09:36:00 -05:00
Azri Kahar
82e62bc113 Minor docs fixes (#9553) 2021-11-06 16:04:22 -04:00
Jay Cammarano
28c59c2dc4 fixes many dead links (#9325) 2021-11-01 21:11:12 +00:00
Ben Haynes
fa816107cc add content and fix broken links (#9321) 2021-11-01 16:52:07 -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
José Varela
224f6cb0bf docs: improve running locally (#9142) 2021-10-26 10:16:55 -04:00
Paul Boudewijn
fb93ee0c86 Update introduction.md (#9063) 2021-10-22 10:24:24 -04:00
Paul Boudewijn
12524fe3a8 Update running-locally.md (#9068) 2021-10-22 10:24:00 -04:00
Azri Kahar
8f7a3dc9cd update vue 2 to vue 3 in codebase overview (#7648) 2021-08-27 11:41:40 -04:00
Rijk van Zanten
eebb891286 Add note on npm run dev restart (#7079)
Fixes #7068
2021-07-29 18:07:53 +02:00
Pascal Jufer
11ef04ff23 Use --workspace instead of cd in "Running locally" guide (#6920) 2021-07-22 09:19:19 -04:00
masterwendu
8f171a430f Improvement/add volta js tool manager (#6919)
* Add volta pins

* add volta install hint
2021-07-22 09:17:12 -04:00
rijkvanzanten
ce50209ff6 Attempt to fix Release CD 2021-07-14 17:25:33 -04:00
Sean Goff
b67b9d824a Build improvements (#6759)
* test

* ci improvements

* fix image names

* improve docs

* Update .github/workflows/release.yml

Co-authored-by: Pascal Jufer <paescuj@users.noreply.github.com>

* Update docker/pack.js

Co-authored-by: Pascal Jufer <paescuj@users.noreply.github.com>

* improvements proposed by @paescuj

* improve Dockerfile comment

* fix .PHONY

* rm tarballs before building final image

Co-authored-by: Pascal Jufer <paescuj@users.noreply.github.com>
2021-07-14 16:40:38 -04:00
Ben Haynes
fc629ed585 Update troubleshooting step 2021-05-17 17:25:52 -04:00
rijkvanzanten
010eabad27 Format remaining md files 2021-05-04 18:52:08 -04:00
Pascal Jufer
26ca4a7717 Docs: Remove dead link, add reference to whole introduction guide (#5383)
instead
2021-04-30 07:36:10 -04:00
Pascal Jufer
ba3e5eb16a Clarify SQLite setup when running Directus locally (#5271) 2021-04-27 10:01:16 -04:00
rijkvanzanten
22535bf566 Resolve TKs/@TODOs in docs
Fixes #3287
2021-04-21 15:57:26 -04:00
Nicola Krumschmidt
b2ff80cb74 Add the build step to the running locally docs (#5055) 2021-04-14 10:45:12 -04:00
Nitwel
6c30f2ec99 Simplify dev env setup (#4845)
* simplify dev env setup

* Recommend bootstrap instead of updating init for prod

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-04-08 16:07:58 -04:00
rijkvanzanten
fb5c9068bc List updated min requirement 2021-03-04 14:14:31 -05:00
Pyll Gomez
20e2905f74 Updated nodejs Link (#4228)
Updated nodejs Link to current version
2021-02-22 15:33:22 -05:00
Rijk van Zanten
07983fd7a6 Update running-locally.md 2021-02-22 13:57:05 -05:00
Ben Haynes
239c021f12 Updates to API Reference 2021-02-08 17:31:07 -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