docbrown/docs
Alex cc6249beff
[deploy] Update whitelisted params on Fastly on deployments (#7279)
* Add Fastly whitelisted params

* Create FastlyVCL::WhitelistedParams.update service

* Add specs

* Create rake task to call new service

* Add rake task to setup script

* Add documentatoin

* Move sort inside params_to_array method

* Rename VCL_REGEX to VCL_DELIMITER

* Add PR URL to docs

* Move snippet name to SNIPPET_NAME constant

* Refactor setting content

* Rename params_to_array to params_to_sorted_array

* Change guard and log success on update

- Return early if params are equal
- Log success message to Rails.logger on update
- Log params diff to Datadog

* Return true explicitly

* Move rake task execution from to release-tasks

* Remove unnecessary environment guard in task

* Remove duplicate code param

* Refactor string from build_content

* Remove reliance on sort

* Reorder logging to implicitly return true

* Update docs to reference release-script.sh

* Update docs

* Update whitelisted params

* Fix params_updated? bug and add more specs

* Remove duplicate param...oopsie!
2020-04-16 15:11:57 -04:00
..
.static VS Code Settings Update / Frontend Debug Documentation (#4346) 2019-10-10 13:10:03 -04:00
backend [deploy] Update whitelisted params on Fastly on deployments (#7279) 2020-04-16 15:11:57 -04:00
design Change /settings/misc to /settings/ux (#7107) 2020-04-06 14:50:34 -04:00
frontend Upgrade to webpacker/webpack 4 and Babel 7 (#6664) 2020-03-17 08:20:36 -04:00
getting-started Keeping your forked branch up to date (#6531) 2020-03-09 09:37:46 -04:00
installation Upgrade Ruby to 2.7.1 (#7097) [deploy] 2020-04-06 18:21:50 +02:00
internal Remove mutationobserver-shim (#7041) 2020-04-02 15:53:06 -04:00
maintainers [docs] Add a maintainers document (#5938) 2020-02-18 12:13:55 -05:00
technical-overview Make slight updates to the Technical Docs (#7011) 2020-04-01 19:26:52 -04:00
tests Create Approvals test doc (#6821) 2020-03-24 18:50:02 -04:00
.gitdocs.json Add rel noopener, noreferrer, nofollow to docs header links (#6944) 2020-04-01 10:15:58 +07: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 Add missing } to updateArticle code sample (#6924) 2020-03-29 08:35:05 +02:00
contributing.md Add a note to clarify deploy preview link (#5800) 2020-01-28 15:19:09 -08:00
contributing_api.md API: add users and videos docs (#6611) [deploy] 2020-03-13 09:12:09 +01:00
deploy-script.js Use subdomain env var for Netlify deploys (#6839) 2020-03-25 12:34:48 -04:00
deployment.md Document DataUpdateScripts, Add to Deploy Process, Add Development Check (#6068) [deploy] 2020-02-14 11:45:27 -05: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
readme.md Add troubleshooting section to docs and restore hidden sections (#6231) 2020-02-24 13:37:52 -05:00
self-hosting.md Improve the clarity of the docs and fix Prettier config (#4899) 2019-11-26 08:40:53 -05: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
backend
frontend
internal
design
deployment.md
tests
contributing.md
contributing_api.md
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 article.