docbrown/docs
Alex 347a4bbc75
[deploy] Add contexts and permissions to liquid tags (#8917)
* Make liquid tags adhere to context and permission

* Undo updates to all liquid tags and update error

* ACTUALLY update errors this time

* Typo

* Refactor error handling and add support for Comment

* Fix specs

* Code cleanup

* Prettify error message

* Add comment clarifying error

* parsed --> parse

* Use a policy for validating roles

* Fix pretty error message

* Return early if valid source

* Get rid of duplicate current_user

* Add comment to Pundit.authorize

* LiquidTagPolicy specs

* Update liquid tag docs

* Update docs

* Use parse_context argument for clarity

* Remove duplicate guard clause for VALID_ROLES

* Update docs
2020-06-30 14:53:18 -04:00
..
.static Fixed a typo and broken image in the frontent tests docs. (#8109) 2020-05-28 10:08:16 -04:00
backend Documentation: Vault Docs (#8936) 2020-06-29 09:33:52 -05:00
contributing Update maintainers documentation and contribution guides (#8939) 2020-06-30 09:11:59 +02:00
design Update example code (#8397) 2020-06-11 13:16:03 +02:00
frontend [deploy] Add contexts and permissions to liquid tags (#8917) 2020-06-30 14:53:18 -04:00
getting-started Configure eslint to use Preact linter rules (#8828) 2020-06-22 14:44:55 -04:00
installation Fix rbenv install failing for windows docs (#8854) 2020-06-29 15:27:58 -04:00
internal [deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
maintainers Update maintainers documentation and contribution guides (#8939) 2020-06-30 09:11:59 +02:00
technical-overview pages:sync rake task for easier local coding of HTML Page (#8190) 2020-06-02 11:23:39 +02:00
tests Update maintainers documentation and contribution guides (#8939) 2020-06-30 09:11:59 +02:00
.gitdocs.json Adapt dev env to use remote box (#7742) 2020-05-13 10:21:00 -04:00
.nvmrc Use Node lts/erbium (v12) for Netlify builds (#5925) 2020-02-06 12:03:11 -05:00
.ruby-version Change /settings/misc to /settings/ux (#7107) 2020-04-06 14:50:34 -04:00
api_template.hbs Use server side comments for templates (#4123) 2019-09-27 10:10:30 -04:00
api_v0.yml [deploy] Rename classified listings (#7910) 2020-05-27 13:35:09 +00:00
faqs.md Add troubleshooting section to docs and restore hidden sections (#6231) 2020-02-24 13:37:52 -05:00
Gemfile Upgrade Rubocop to 0.81 (#7219) 2020-04-11 10:10:04 +02:00
licensing.md Improve the clarity of the docs and fix Prettier config (#4899) 2019-11-26 08:40:53 -05:00
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
netlify.toml Move netlify.toml to docs folder to prep for multiple TOML files (#7960) 2020-05-19 15:02:17 -04:00
readme.md Update maintainers documentation and contribution guides (#8939) 2020-06-30 09:11:59 +02:00
self-hosting.md Update self hosting docs with info on Forem (#8863) 2020-06-23 15:14:44 -04:00
troubleshooting.md Disable CORS logging by default in development (#6592) 2020-03-11 15:30:18 -04:00

items
technical-overview
installation
getting-started
contributing
backend
frontend
internal
design
tests
faqs.md
troubleshooting.md
licensing.md
self-hosting.md
maintainers

Welcome to DEV's developer documentation

On this site you'll find instructions to setup a local instance of DEV, documentation on the architecture of DEV, how to contribute, and many other useful documents.

This documentation site is the product of a number of volunteer contributors working alongside the DEV Core Team, special thanks to all those who have contributed to the documentation.

Running the documentation locally

Like DEV, this site is open source and the code is hosted on GitHub. If you find any incorrect information, or a even a typo, we'd love to see a pull request. Follow these steps to get the documentation site running locally.

DEV's documentation is built with GitDocs NodeJS library.

The first step to running the documentations locally is to install the GitDocs package globally.

With npm:

npm install gitdocs -g

Alternatively, you can use Yarn:

yarn global add gitdocs

Once installed, you should run gitdocs serve from the root of the dev.to project or from the /docs directory.

gitdocs serve

This will start a server where you can browse the documentation: http://localhost:8000/

If you add new pages or rename existing pages, you'll need to restart the server for those changes to take effect.

Contributing to the docs

If you're looking for more information on contributing, check out the Contributing guide.