92621429ee
* 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>
2.8 KiB
description
| description |
|---|
| Support Directus by being a leader in our online and in-person communities. |
Community Contributions
What makes Directus so special is our amazing community, which takes all of us to maintain and grow. All members of our community, regardless of role, must abide by our Code of Conduct.
Education
We want everyone to be as successful as possible in understanding what Directus is, the key concepts, how it relates to their problem, and how to successfully implement it.
Documentation
If you spot small errors or inconsistencies with our documentation, please feel free to open a Pull Request and label it
Documentation. Each page in the docs has an edit button at the bottom that will take you directly to an editing
interface in GitHub.
If you want to contribute guides, or create new documentation, please first open an issue on GitHub and wait for response from the Core team - we are selective about what makes it into docs, but will have other ways to contribute content in the future.
Online Community
Our online community meets in two places - Discord and GitHub. GitHub is used for discussing feature requests and bugs, and Discord is used for community discussion and requests for implementation help.
The Directus community is growing quickly, which also means there are more and more people with questions. Helping out your fellow developers by providing answers on Discord is a great way to help the project. Questions are opened in one of our help channels, and all are encouraged to respond.
:::info Feature Requests & Code Contributions
To learn more about how we use GitHub for Feature Requests and Code Contributions, check out our Code Contributions guide.
:::
Moderation
As well as the Core Team, we have a set of community moderators who support us in creating a kind and well-organized community. The role of a moderator is to:
- Remove spam and other content that breaks our server rules.
- Remove server members who consistently break rules, or break certain rules where there is zero-tolerance.
- Move questions to help channels when posted elsewhere.
- Be model community members.
This is an elevated role that is generally given at discretion of the Core Team. If this is of interest to you, please reach out to a member of the team.
In-Person Communities
We have a truly global user base, and run a number of regional User Groups and events to bring together local Directus developers and users.
If you are interested in setting up your own, please reach out to a member of the core team. We can always start with a one-off to gauge local interest.