docbrown/docs
Francisco Quintero 3b939f6b9f
[deploy] Add Reddit Liquid Tag (#8111)
* Implement Reddit liquid tag

* Set reddit content in locals

* Change Reddit liquid tag content layout

I decided a UI similar to the Stack Exchange tag would be better.

Now the Reddit tag looks a bit similar.

* Add tests for RedditTag

* Add reddit liquid tag example to docs

Also emphasize notice about compilation of article when using any
liquid tag

* Parse markdown text reddit content for RedditTag

* Display date RedditTag post was published

* Remove file location comments

* Change order of conditional for Reddit liquid tag

Sometimes the attribute `post_hint` might be null and neither condition
would apply.

* Add example to use Reddit liquid tag

* Change reddit svg icon for Reddit liquid tag

* handle and verify status of Reddit links

Here we make sure the passed link is a valid one in terms of URI composition (e.g. protocol)
but also that the URL is one that points to existing content in Reddit.

If the URL isn't returning anything but a successful response code (200) then
we treat it as an invalid one.

* Do not use VCR for RedditTag specs

The generated cassette for this tag was really huge (6000+ lines).

Using mocks (as in the MediumTag spec) still does the job and without
that huge VCR file.

* Remove index line from schema.db

* Improve RedditJsonFromUrlService

- Change User-Agent in requests to one read from app configuration
- Remove Reddit URL check by making a GET request
- Add regexp to validate URL looks like a Reddit URL

* Move RedditJsonFromUrlService methods to RedditTag

Also changed the way the request was being mocked. Previously, it was by
mocking the service class now I'm mocking HTTParty directly and returning
the JSON structure Reddit uses.
2020-06-01 18:52:07 -04:00
..
.static Fixed a typo and broken image in the frontent tests docs. (#8109) 2020-05-28 10:08:16 -04:00
backend [deploy] Rename classified listings (#7910) 2020-05-27 13:35:09 +00:00
design Change /settings/misc to /settings/ux (#7107) 2020-04-06 14:50:34 -04:00
frontend [deploy] Add Reddit Liquid Tag (#8111) 2020-06-01 18:52:07 -04:00
getting-started [deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
installation Bugfix for #7663 and refactor of container setup (#7747) 2020-05-28 12:11:51 -05:00
internal [deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
maintainers [docs] Add a maintainers document (#5938) 2020-02-18 12:13:55 -05:00
technical-overview [deploy] Rename classified listings (#7910) 2020-05-27 13:35:09 +00:00
tests Fixed a typo and broken image in the frontent tests docs. (#8109) 2020-05-28 10:08:16 -04: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
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
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
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 Add troubleshooting section to docs and restore hidden sections (#6231) 2020-02-24 13:37:52 -05:00
self-hosting.md [deploy] Home Page Feed redesign + top comments (#7579) 2020-05-12 07:57:57 -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.